DatabaseQuery

Written by

Updated at October 30, 2025

SQL queries against MySQL®, PostgreSQL, ClickHouse®, and YDB databases.

The connection and dsn fields are mutually exclusive: you can use only one of them.

Field name	Type	Required	Default value	Templating is supported	Description
`connection`	DatabaseConnection	No	No	No	Database connection parameters
`dsn`	`string`	No	No	No	Database connection string (DNS). Supported schemas: `postgres://`, `postgresql://`, `clickhouse://`, `grpc://`, `grpcs://`, `ydb://`, and the MySQL® DSN format (`user:pass@tcp(host:port)/db?...`).
`query`	`string`	Yes	No	Yes	SQL query text
`mode`	`string`	No	`EXEC`	No	SQL query execution method. Values to choose from: `EXEC`: Execute the SQL query and return the service fields only, e.g., `RowsAffected` and `LastInsertId`. `QUERY`: Execute the SQL query and return the result.

DatabaseConnection

The simple and iam fields are mutually exclusive: you can use only one of them. The iam field is only supported for YDB databases.

For a MySQL® database, parseTime=true and charset=utf8mb4 are set automatically.

Field name	Type	Required	Default value	Templating is supported	Description
`type`	`string`	Yes	No	No	Database type. Possible values: `MYSQL`, `POSTGRES`, `YDB`, and `CLICKHOUSE`.
`host`	`string`	Yes	No	No	Database host.
`port`	`number`	Yes	No	No	Database port.
`database`	`string`	Yes	No	No	Database name.
`ssl`	`bool`	No	`false`	No	If `true`, the database connection is over SSL. Additionally, For a PostgreSQL database, set `sslmode=require` if `ssl=true`. Otherwise, `sslmode=disable`. For a ClickHouse® database, set `secure=true` if `ssl=true`.
`simple`	DatabaseConnectionSimpleAuth	No	No	Yes	Authentication by username and password.
`iam`	`bool`	No	No	No	Authentication by IAM token of the service account specified in the workflow settings.

Field name	Type	Required	Default value	Templating is supported	Description
`username`	`string`	Yes	No	Yes	Username.
`password`	`string`	Yes	No	Yes	User password.