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
# All config fields, showing default values
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
A database driver to use.
Data source name.
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 (
$2, and so on). The style to use is outlined in this table:
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.
An optional Bloblang mapping which should evaluate to an array of values matching in size to the number of placeholder arguments in the field
args_mapping: root = [ this.cat.meow, this.doc.woofs ]
args_mapping: root = [ meta("user.id") ]