DpgListFlowMetaDataCommand Object


Description:

Command to retrieve metadata stored within the database of flow files available.

Can be used with Command Sequencer: No

Parents: Sequencer, StcSystem

DpgListFlowMetaDataCommand Writable Attributes

Attribute Description
Common Writable Attributes ProgressCancelled
ColumnList

A list of database columns to return. If empty, selects all columns.

Type: string

Default: "" (empty string)

Count

Maximum returned row count.

Type: u32

Default: 0xffffffff

Filter

An SQL WHERE specification for filtering the list of flow files.

Type: string

Default: "" (empty string)

Offset

Offset in the list of returned results to start from.

Type: u32

Default: 0

UpdateDatabase

Force the updating of the database with any new flows which may have been added manually.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Force the update.

FALSE

Only update when significant changes are detected.

DpgListFlowMetaDataCommand Read-Only Attributes

Read-Only Attribute Description
Common Read-Only Attributes ElapsedTime, EndTime, ProgressCurrentStep, ProgressCurrentStepName, ProgressCurrentValue, ProgressDisplayCounter, ProgressMaxValue, ProgressStepsCount, StartTime, State, Status
Output

Output rows.

Type: string

Default: "" (empty string)

OutputColumnList

Output column names.

Type: string

Default: "" (empty string)