Skip to main content

sql_select

Runs an SQL select query against a database and returns the result as an array of objects, one for each row returned, containing a key for each column queried and its value.

# Common config fields, showing default values
label: ""
sql_select:
  driver: "" # No default (required)
  dsn: clickhouse://username:password@host1:9000,host2:9000/database?dial_timeout=200ms&max_execution_time=60 # No default (required)
  table: foo # No default (required)
  columns: [] # No default (required)
  where: meow = ? and woof = ? # No default (optional)
  args_mapping: root = [ this.cat.meow, this.doc.woofs[0] ] # No default (optional)

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

Examples​

Here we query a database for columns of footable that share a user_id with the message user.id. A branch processor is used in order to insert the resulting array into the original message at the path foo_rows:

pipeline:
  processors:
    - branch:
        processors:
          - sql_select:
              driver: postgres
              dsn: postgres://foouser:foopass@localhost:5432/testdb?sslmode=disable
              table: footable
              columns: [ '*' ]
              where: user_id = ?
              args_mapping: '[ this.user.id ]'
        result_map: 'root.foo_rows = this'

Fields​

driver​

A database driver to use.

Type: string
Options: mysql, postgres, clickhouse, mssql, sqlite, oracle, snowflake, trino, gocosmos, spanner, duckdb.

dsn​

A Data Source Name to identify the target database.

Drivers​

The following is a list of supported drivers, their placeholder style, and their respective DSN formats:

DriverData Source Name Format
clickhouseclickhouse://[username[:password]@][netloc][:port]/dbname[?param1=value1&...&paramN=valueN]
mysql[username[:password]@][protocol[(address)]]/dbname[?param1=value1&...&paramN=valueN]
postgrespostgres://[user[:password]@][netloc][:port][/dbname][?param1=value1&...]
mssqlsqlserver://[user[:password]@][netloc][:port][?database=dbname&param1=value1&...]
sqlitefile:/path/to/filename.db[?param&=value1&...]
oracleoracle://[username[:password]@][netloc][:port]/service_name?server=server2&server=server3
snowflakeusername[:password]@account_identifier/dbname/schemaname[?param1=value&...&paramN=valueN]
spannerprojects/[project]/instances/[instance]/databases/dbname
trinohttp[s]://user[:pass]@host[:port][?parameters]
gocosmosAccountEndpoint=<cosmosdb-endpoint>;AccountKey=<cosmosdb-account-key>[;TimeoutMs=<timeout-in-ms>][;Version=<cosmosdb-api-version>][;DefaultDb/Db=<db-name>][;AutoId=<true/false>][;InsecureSkipVerify=<true/false>]
duckdb/path/to/filename.duckdb[?config_option=value&...] or :memory: for ephemeral in-process storage.

Please note that the postgres driver enforces SSL by default, you can override this with the parameter sslmode=disable if required.

The mssql driver supports using Kerberos authentication instead of the default ntlm (on Unix) or winsspi (on Windows). To do this, add the parameter authenticator=krb5 to the DSN. For a list of supported Kerberos configuration options, please refer to the documentation. An example DSN with Kerberos enabled and username/password authentication: sqlserver://user@EXAMPLE.COM:pass@host:1433?database=db&authenticator=krb5

The snowflake driver supports multiple DSN formats. Please consult the docs for more details. For key pair authentication, the DSN has the following format: <snowflake_user>@<snowflake_account>/<db_name>/<schema_name>?warehouse=<warehouse>&role=<role>&authenticator=snowflake_jwt&privateKey=<base64_url_encoded_private_key>, where the value for the privateKey parameter can be constructed from an unencrypted RSA private key file rsa_key.p8 using openssl enc -d -base64 -in rsa_key.p8 | basenc --base64url -w0 (you can use gbasenc insted of basenc on OSX if you install coreutils via Homebrew). If you have a password-encrypted private key, you can decrypt it using openssl pkcs8 -in rsa_key_encrypted.p8 -out rsa_key.p8. Also, make sure fields such as the username are URL-encoded.

The gocosmos driver is still experimental, but it has support for hierarchical partition keys as well as cross-partition queries. Please refer to the SQL notes for details.

The duckdb driver requires cgo to link the DuckDB static library. It is only available in builds with the x_bento_extra build tag or the CGO-enabled Docker image (-cgo tag postfix).

Type: string

# Examples

dsn: clickhouse://username:password@host1:9000,host2:9000/database?dial_timeout=200ms&max_execution_time=60

dsn: foouser:foopassword@tcp(localhost:3306)/foodb

dsn: postgres://foouser:foopass@localhost:5432/foodb?sslmode=disable

dsn: oracle://foouser:foopass@localhost:1521/service_name

dsn: db_file.duckdb?threads=4&access_mode=READ_ONLY

dsn: ':memory:'

table​

The table to query.

Type: string

# Examples

table: foo

columns​

A list of columns to query.

Type: array

# Examples

columns:
  - '*'

columns:
  - foo
  - bar
  - baz

where​

An optional where clause to add. Placeholder arguments are populated with the args_mapping field. Placeholders should always be question marks, and will automatically be converted to dollar syntax when the postgres or clickhouse drivers are used.

Type: string

# Examples

where: meow = ? and woof = ?

where: user_id = ?

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 where.

Type: string

# Examples

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

args_mapping: root = [ metadata("user.id").string() ]

prefix​

An optional prefix to prepend to the query (before SELECT).

Type: string

suffix​

An optional suffix to append to the select query.

Type: string

init_files​

An optional list of file paths containing SQL statements to execute immediately upon the first connection to the target database. This is a useful way to initialise tables before processing data. Glob patterns are supported, including super globs (double star).

Care should be taken to ensure that the statements are idempotent, and therefore would not cause issues when run multiple times after service restarts. If both init_statement and init_files are specified the init_statement is executed after the init_files.

If a statement fails for any reason a warning log will be emitted but the operation of this component will not be stopped.

Type: array

# Examples

init_files:
  - ./init/*.sql

init_files:
  - ./foo.sql
  - ./bar.sql

init_statement​

An optional SQL statement to execute immediately upon the first connection to the target database. This is a useful way to initialise tables before processing data. Care should be taken to ensure that the statement is idempotent, and therefore would not cause issues when run multiple times after service restarts.

If both init_statement and init_files are specified the init_statement is executed after the init_files.

If the statement fails for any reason a warning log will be emitted but the operation of this component will not be stopped.

Type: string

# Examples

init_statement: |2
  CREATE TABLE IF NOT EXISTS some_table (
    foo varchar(50) not null,
    bar integer,
    baz varchar(50),
    primary key (foo)
  ) WITHOUT ROWID;

init_verify_conn​

Whether to verify the database connection on startup by performing a simple ping, by default this is disabled.

Type: bool
Default: false
Requires version 1.2.0 or newer

conn_max_idle_time​

An optional maximum amount of time a connection may be idle. Expired connections may be closed lazily before reuse. If value <= 0, connections are not closed due to a connections idle time.

Type: string

conn_max_life_time​

An optional maximum amount of time a connection may be reused. Expired connections may be closed lazily before reuse. If value <= 0, connections are not closed due to a connections age.

Type: string

conn_max_idle​

An optional maximum number of connections in the idle connection pool. If conn_max_open is greater than 0 but less than the new conn_max_idle, then the new conn_max_idle will be reduced to match the conn_max_open limit. If value <= 0, no idle connections are retained. The default max idle connections is currently 2. This may change in a future release.

Type: int
Default: 2

conn_max_open​

An optional maximum number of open connections to the database. If conn_max_idle is greater than 0 and the new conn_max_open is less than conn_max_idle, then conn_max_idle will be reduced to match the new conn_max_open limit. If value <= 0, then there is no limit on the number of open connections. The default is 0 (unlimited).

Type: int

secret_name​

An optional field that can be used to get the Username + Password from AWS Secrets Manager. This will overwrite the Username + Password in the DSN with the values from the Secret only if the driver is set to postgres.

Type: string
Requires version 1.3.0 or newer

iam_enabled​

An optional field used to generate an IAM authentication token to connect to an Amazon Relational Database (RDS) DB instance. This will overwrite the Password in the DSN with the generated token only if the drivers are mysql or postgres.

Type: bool
Default: false
Requires version 1.8.0 or newer

azure​

Optional Fields that can be set to use Azure based authentication for Azure Postgres SQL

Type: object
Requires version 1.10.0 or newer

azure.entra_enabled​

An optional field used to generate an entra token to connect to 'Azure Database for PostgreSQL flexible server', This will create a new connection string with the host, user and database from the DSN field - you may need to URL encode the dsn! The Default Azure Credential Chain is used from the Azure SDK.

Type: bool
Default: false
Requires version 1.10.0 or newer

azure.token_request_options​

Sorry! This field is missing documentation.

Type: object

azure.token_request_options.claims​

Set additional claims for the token.

Type: string
Default: ""
Requires version 1.10.0 or newer

azure.token_request_options.enable_cae​

Indicates whether to enable Continuous Access Evaluation (CAE) for the requested token

Type: bool
Default: false
Requires version 1.10.0 or newer

azure.token_request_options.scopes​

Scopes contains the list of permission scopes required for the token.

Type: array
Default: ["https://ossrdbms-aad.database.windows.net/.default"]
Requires version 1.10.0 or newer

azure.token_request_options.tenant_id​

tenant_id identifies the tenant from which to request the token. azure credentials authenticate in their configured default tenants when this field isn't set.

Type: string
Default: ""
Requires version 1.10.0 or newer

region​

The AWS region to target.

Type: string
Default: ""

endpoint​

Allows you to specify a custom endpoint for the AWS API.

Type: string
Default: ""

credentials​

Optional manual configuration of AWS credentials to use. More information can be found in this document.

Type: object

credentials.profile​

A profile from ~/.aws/credentials to use.

Type: string
Default: ""

credentials.id​

The ID of credentials to use.

Type: string
Default: ""

credentials.secret​

The secret for the credentials being used.

Secret

This field contains sensitive information that usually shouldn't be added to a config directly, read our secrets page for more info.

Type: string
Default: ""

credentials.token​

The token for the credentials being used, required when using short term credentials.

Type: string
Default: ""

credentials.from_ec2_role​

Use the credentials of a host EC2 machine configured to assume an IAM role associated with the instance.

Type: bool
Default: false

credentials.role​

A role ARN to assume.

Type: string
Default: ""

credentials.role_external_id​

An external ID to provide when assuming a role.

Type: string
Default: ""

credentials.expiry_window​

Allow the credentials to trigger refreshing prior to the credentials actually expiring. This is beneficial so race conditions with expiring credentials do not cause requests to fail. For example '10s' would refresh credentials ten seconds before expiration. Setting to a duration of 0 disables the expiry window.

Type: string
Default: ""