PluginsSnowflakeTriggers

Trigger​Trigger

yaml
type: "io.kestra.plugin.jdbc.snowflake.Trigger"

Wait for a query on a Snowflake database.

Examples

Wait for a SQL query to return results, and then iterate through rows.

yaml
id: jdbc_trigger
namespace: company.team

tasks:
  - id: each
    type: io.kestra.plugin.core.flow.ForEach
    values: "{{ trigger.rows }}"
    tasks:
      - id: return
        type: io.kestra.plugin.core.debug.Return
        format: "{{ json(taskrun.value) }}"

triggers:
  - id: watch
    type: io.kestra.plugin.jdbc.snowflake.Trigger
    interval: "PT5M"
    url: jdbc:snowflake://<account_identifier>.snowflakecomputing.com
    username: snowflake_user
    password: snowflake_password
    sql: "SELECT * FROM demo_db.public.customers"
    warehouse: COMPUTE_WH
    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.

conditions

  • Type: array
  • SubType: Condition
  • Dynamic: ❌
  • Required: ❌

List of conditions in order to limit the flow trigger.

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.

interval

  • Type: string
  • Dynamic: ❌
  • Required: ❌
  • Default: 60
  • Format: duration

Interval between polling.

The interval between 2 different polls of schedule, this can avoid to overload the remote system with too many calls. For most of the triggers that depend on external systems, a minimal interval must be at least PT30S. See ISO_8601 Durations for more information of available interval values.

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.

stopAfter

  • Type: array
  • SubType: string
  • Dynamic: ❌
  • Required: ❌

List of execution states after which a trigger should be stopped (a.k.a. disabled).

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.

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

row

  • Type: object
  • Required: ❌

rows

  • Type: array
  • SubType: object
  • Required: ❌

size

  • Type: integer
  • Required: ❌

uri

  • Type: string
  • Required: ❌
  • Format: uri