Runs a query against a registered database table provider and feeds each resulting row to the next pipeline step. The providerId attribute selects which registered database table provider builds and runs the query; each configured Column maps a value from the query results onto a field of the row passed downstream. Results are passed to the next step one row at a time by default, or all together as a single list when passAsList is set.

Implements: PipelineStep

---

Properties

---

Methods

getFormPath()

Returns: String

Path to the Velocity template used by the pipeline management UI to edit this step's configuration.

getDescription()

Returns: String

Human-readable summary of this step, shown to administrators managing the pipeline.

getProviderId()

Returns: String

Identifier of the registered database table provider used to build and run the query for this step.

getPassAsList()

Returns: Boolean

If true, when looking up rows, the entire list of rows is passed to the next step in a single execution. Otherwise the default is to call the next step for each row.

getNext()

Returns: PipelineStep

The single next step that result rows are passed to.

getNextStep()

Returns: PipelineStep

The single next step that result rows are passed to. Equivalent to getNext.

getColumns()

Returns: List<Column>

Columns that map values from each query result onto fields of the row passed to the next step.

addCol(Column c)

Returns: DatabaseSourceStep

Adds a column mapping to this step's configured columns, creating the column list if it does not already exist, and returns this instance for chaining.