Docs Connect Components Processors sql sql Type: ProcessorCacheOutput Available in: Self-Managed Deprecated 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 Advanced # Common config fields, showing default values label: "" sql: driver: "" # No default (required) data_source_name: "" # No default (required) query: INSERT INTO footable (foo, bar, baz) VALUES (?, ?, ?); # No default (required) args_mapping: root = [ this.cat.meow, this.doc.woofs[0] ] # No default (optional) result_codec: none # All config fields, showing default values label: "" sql: driver: "" # No default (required) data_source_name: "" # No default (required) query: INSERT INTO footable (foo, bar, baz) VALUES (?, ?, ?); # No default (required) unsafe_dynamic_query: false args_mapping: root = [ this.cat.meow, this.doc.woofs[0] ] # No default (optional) 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. Alternatives For basic inserts or select queries use either the sql_insert or the sql_select processor. For more complex queries use the sql_raw processor. Fields driver A database driver to use. Type: string Options: mysql , postgres , clickhouse , mssql , sqlite , oracle , snowflake , trino , gocosmos . data_source_name Data source name. Type: string query 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) or colons (:1, :2 and so on). The style to use is outlined in this table: | Driver | Placeholder Style | |---|---| | clickhouse | Dollar sign | | mysql | Question mark | | postgres | Dollar sign | | mssql | Question mark | | sqlite | Question mark | | oracle | Colon | | snowflake | Question mark | | trino | Question mark | | gocosmos | Colon | Type: string # Examples query: INSERT INTO footable (foo, bar, baz) VALUES (?, ?, ?); unsafe_dynamic_query 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 args_mapping 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.cat.meow, this.doc.woofs[0] ] args_mapping: root = [ meta("user.id") ] result_codec Result codec. Type: string Default: "none" Back to top × Simple online edits For simple changes, such as fixing a typo, you can edit the content directly on GitHub. Edit on GitHub Or, open an issue to let us know about something that you want us to change. Open an issue Contribution guide For extensive content updates, or if you prefer to work locally, read our contribution guide . Was this helpful? thumb_up thumb_down group Ask in the community mail Share your feedback group_add Make a contribution split sql_insert