DatabaseQuery

Written by

Updated at August 18, 2026

Note

Currently, there are two UIs that support Workflows: Yandex Cloud and Yandex AI Studio. In this case, the following applies:

Workflows created in the Yandex Cloud UI are automatically available in the AI Studio UI.
Workflows created in the AI Studio UI are not available in the Yandex Cloud UI.

Starting September 3, 2026, Workflows will no longer be supported in the Yandex Cloud UI. To create and manage workflows, use the AI Studio UI.

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 supported	Description
`connection`	DatabaseConnection	None	None	None	Database connection parameters
`dsn`	`string`	None	None	None	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	None	Yes	SQL query text
`mode`	`string`	None	`EXEC`	None	SQL query execution method. The possible values are: `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 supported	Description
`type`	`string`	Yes	None	None	Database type. The possible values are `MYSQL`, `POSTGRES`, `YDB`, and `CLICKHOUSE`.
`host`	`string`	Yes	None	None	Database host.
`port`	`number`	Yes	None	None	Database port.
`database`	`string`	Yes	None	None	Database name.
`ssl`	`bool`		`false`	None	If `true`, the database connection is over SSL. Additionally, consider the following: 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	None	None	Yes	Authentication by username and password.
`iam`	`bool`	None	None	None	Authentication by IAM token of the service account specified in the workflow settings.

Field name	Type	Required	Default value	Templating supported	Description
`username`	`string`	Yes	None	Yes	Username.
`password`	`string`	Yes	None	Yes	Password.