Query

yaml

type: "io.kestra.plugin.jdbc.snowflake.Query"

Query a Snowflake server.

Examples

Execute a query and fetch results in a task, and update another table with fetched results in a different task.

yaml

id: snowflake_query
namespace: company.team

tasks:
  - id: select
    type: io.kestra.plugin.jdbc.snowflake.Query
    url: jdbc:snowflake://<account_identifier>.snowflakecomputing.com
    username: snowflake_user
    password: snowflake_password
    sql: select * from demo_db.public.customers
    fetchType: FETCH

  - id: generate_update
    type: io.kestra.plugin.jdbc.snowflake.Query
    url: jdbc:snowflake://<account_identifier>.snowflakecomputing.com
    username: snowflake_user
    password: snowflake_password
    sql: "INSERT INTO demo_db.public.customers_new (year_month, store_code, update_date) values {% for row in outputs.update.rows %} ({{ row.year_month }}, {{ row.store_code }}, TO_DATE('{{ row.date }}', 'MONTH DD, YYYY') ) {% if not loop.last %}, {% endif %}; {% endfor %}"

Properties

`fetchType`

Type: string
Dynamic: ❌
Required: ✔️
Default: NONE
Possible Values:
- STORE
- FETCH
- FETCH_ONE
- NONE

The way you want to store data.

FETCH_ONE - output the first row. FETCH - output all rows as output variable. STORE - store all rows to a file. NONE - do nothing.

`url`

Type: string
Dynamic: ✔️
Required: ✔️

The JDBC URL to connect to the database.

`autoCommit`

Type: boolean
Dynamic: ❌
Required: ❌
Default: true

Whether autocommit is enabled.

Sets this connection's auto-commit mode to the given state. If a connection is in auto-commit mode, then all its SQL statements will be executed and committed as individual transactions. Otherwise, its SQL statements are grouped into transactions that are terminated by a call to either the method commit or the method rollback. By default, new connections are in auto-commit mode except when you are using store property in which case the auto-commit will be disabled.

`database`

Type: string
Dynamic: ✔️
Required: ❌

Specifies the default database to use once connected.

The specified database should be an existing database for which the specified default role has privileges. If you need to use a different database after connecting, execute the USE DATABASE command.

`fetch`

⚠ Deprecated

Type: boolean
Dynamic: ❌
Required: ❌
Default: false

DEPRECATED, please use fetchType: FETCH instead. Whether to fetch the data from the query result to the task output. This parameter is evaluated after fetchOne and store.

`fetchOne`

⚠ Deprecated

Type: boolean
Dynamic: ❌
Required: ❌
Default: false

DEPRECATED, please use fetchType: FETCH_ONE instead. Whether to fetch only one data row from the query result to the task output. This parameter is evaluated before store and fetch.

`fetchSize`

Type: integer
Dynamic: ❌
Required: ❌
Default: 10000

Number of rows that should be fetched.

Gives the JDBC driver a hint as to the number of rows that should be fetched from the database when more rows are needed for this ResultSet object. If the fetch size specified is zero, the JDBC driver ignores the value and is free to make its own best guess as to what the fetch size should be. Ignored if autoCommit is false.

`password`

Type: string
Dynamic: ✔️
Required: ❌

The database user's password.

`privateKey`

Type: string
Dynamic: ✔️
Required: ❌

Specifies the private key for key pair authentication and key rotation.

It needs to be an un-encoded private key in plaintext.

`privateKeyFile`

Type: string
Dynamic: ✔️
Required: ❌

Specifies the private key file for key pair authentication and key rotation.

It needs to be the path on the host where the private key file is located.

`privateKeyFilePassword`

Type: string
Dynamic: ✔️
Required: ❌

Specifies the private key file password for key pair authentication and key rotation.

`role`

Type: string
Dynamic: ✔️
Required: ❌

Specifies the default access control role to use in the Snowflake session initiated by the driver.

The specified role should be an existing role that has already been assigned to the specified user for the driver. If the specified role has not already been assigned to the user, the role is not used when the session is initiated by the driver. If you need to use a different role after connecting, execute the USE ROLE command.

`schema`

Type: string
Dynamic: ✔️
Required: ❌

Specifies the default schema to use for the specified database once connected.

The specified schema should be an existing schema for which the specified default role has privileges. If you need to use a different schema after connecting, execute the USE SCHEMA command.

`sql`

Type: string
Dynamic: ✔️
Required: ❌

The SQL query to run.

`store`

⚠ Deprecated

Type: boolean
Dynamic: ❌
Required: ❌
Default: false

DEPRECATED, please use fetchType: FETCH_STORE instead. Whether to fetch data row(s) from the query result to a file in internal storage. File will be saved as Amazon Ion (text format). See Amazon Ion documentation This parameter is evaluated after fetchOne but before fetch.

`timeZoneId`

Type: string
Dynamic: ❌
Required: ❌

The time zone id to use for date/time manipulation. Default value is the worker's default time zone id.

`username`

Type: string
Dynamic: ✔️
Required: ❌

The database user.

`warehouse`

Type: string
Dynamic: ✔️
Required: ❌

Specifies the virtual warehouse to use once connected.

The specified warehouse should be an existing warehouse for which the specified default role has privileges. If you need to use a different warehouse after connecting, execute the USE WAREHOUSE command to set a different warehouse for the session.