Queries

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

Perform multiple queries on a Snowflake server.

Examples

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

id: snowflake_queries
namespace: company.team

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

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.

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

• 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

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

parameters

• Type: object
• Dynamic: ✔️
• Required: ❌

Parameters

A map of parameters to bind to the SQL queries. The keys should match the parameter placeholders in the SQL string, e.g., .

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

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

transaction

• Type:
  • boolean
  • string
• Dynamic: ✔️
• Required: ❌

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.

Outputs

outputs

• Type: array
• SubType: AbstractJdbcBaseQuery-Output
• Required: ❌

Definitions

io.kestra.plugin.jdbc.AbstractJdbcBaseQuery-Output

Properties

row

• Type: object
• Dynamic: ❓
• Required: ❓

Map containing the first row of fetched data.

Only populated if fetchOne parameter is set to true.

rows

• Type: array
• SubType: object
• Dynamic: ❓
• Required: ❓

List of map containing rows of fetched data.

Only populated if fetch parameter is set to true.

size

• Type: integer
• Dynamic: ❓
• Required: ❓

The number of rows fetched.

Only populated if store or fetch parameter is set to true.

uri

• Type: string
• Dynamic: ❓
• Required: ❓
• Format: uri

The URI of the result file on Kestra's internal storage (.ion file / Amazon Ion formatted text file).

Only populated if store is set to true.