Skip to main content

Query

Query runs a SQL statement through a Connection resource and returns the rows it selects.

Choosing a Schema and Tables first is what lets the SQL editor and the mappers know what is available. The statement itself is written on the Query tab, and its parameters are supplied through the Input mapping.

The activity has four tabs: Configuration, Query, Input, and Output.

Configuration

FieldRequiredDescription
NameOptionalName of the component.
DescriptionOptionalDescription of the component.
ConnectionOptionalThe database connection resource to run through.
Batch SizeOptionalNumber of rows in each batch.
SchemaOptionalSchema to query within.
TablesOptionalTables to query.

Schema and Tables are populated from the selected Connection.

Query

FieldRequiredDescription
SQL QueryOptionalThe SQL statement to run.

The statement must be written in the dialect of the engine set as Type on the Connection resource.

Input

FieldRequiredDescription
InputsOptionalValues supplied to the statement.

Map parameters here rather than building them into the SQL string.

Output

FieldRequiredDescription
OutputOptionalThe rows returned by the query.

The shape of the output follows the columns the statement selects, so the mapper reflects the statement rather than a fixed schema.