Skip to main content



This component is deprecated and will be removed in the next major version release. Please consider moving onto alternative components.

Runs an arbitrary SQL query against a database and (optionally) returns the result as an array of objects, one for each row returned.

Introduced in version 3.65.0.

# Common config fields, showing default values
label: ""
driver: ""
data_source_name: ""
query: ""
args_mapping: ""
result_codec: none

If the query fails to execute then the message will remain unchanged and the error can be caught using error handling methods outlined here.


For basic inserts or select queries use use either the sql_insert or the sql_select processor. For more complex queries use the sql_raw processor.



A database driver to use.

Type: string
Options: mysql, postgres, clickhouse, mssql, sqlite, oracle, snowflake.


Data source name.

Type: string


The query to execute. The style of placeholder to use depends on the driver, some drivers require question marks (?) whereas others expect incrementing dollar signs ($1, $2, and so on). The style to use is outlined in this table:

DriverPlaceholder Style
clickhouseDollar sign
mysqlQuestion mark
postgresDollar sign
mssqlQuestion mark
sqliteQuestion mark
snowflakeQuestion mark

Type: string

# Examples

query: INSERT INTO footable (foo, bar, baz) VALUES (?, ?, ?);


Whether to enable interpolation functions in the query. Great care should be made to ensure your queries are defended against injection attacks.

Type: bool
Default: false


An optional Bloblang mapping which should evaluate to an array of values matching in size to the number of placeholder arguments in the field query.

Type: string

# Examples

args_mapping: root = [, this.doc.woofs[0] ]

args_mapping: root = [ meta("") ]


Result codec.

Type: string
Default: "none"