PLUGINSPLUGIN-JDBC-SNOWFLAKETRIGGERSIO.KESTRA.PLUGIN.JDBC.SNOWFLAKE.TRIGGER

Trigger

Table of Contents

Contribute

Trigger

yaml

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

Wait for query on a Snowflake database.

Examples

Wait for a sql query to return results and iterate through rows

yaml

id: jdbc-trigger
namespace: io.kestra.tests

tasks:
  - id: each
    type: io.kestra.core.tasks.flows.EachSequential
    tasks:
      - id: return
        type: io.kestra.core.tasks.debugs.Return
        format: "{{json(taskrun.value)}}"
    value: "{{ trigger.rows }}"

triggers:
  - id: watch
    type: io.kestra.plugin.jdbc.snowflake.Trigger
    interval: "PT5M"
    sql: "SELECT * FROM my_table"

Properties

`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, or specifies an empty string.

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

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

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: PT1S
Format: duration

Interval between polling

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

`password`

Type: string
Dynamic: ✔️
Required: ❌

The database user's password

`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

Whether to fetch data row 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 default 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 can be executed to set a different warehouse for the session.