Trigger

Wait for query on a Microsoft SQL Server database.

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

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.sqlserver.Trigger
    interval: "PT5M"
    url: jdbc:sqlserver://localhost:41433;trustServerCertificate=true
    username: sql_server_user
    password: sql_server_password
    sql: "SELECT * FROM my_table"
    fetchType: FETCH

Dynamic YES

Default NONE

Possible Values

STOREFETCHFETCH_ONENONE

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.

Dynamic YES

The JDBC URL to connect to the database.

SubType

Dynamic NO

List of conditions in order to limit the flow trigger.

Dynamic NO

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.

Dynamic NO

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.

Dynamic YES

Default 10000

Dynamic NO

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.

Dynamic YES

Parameters

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

Dynamic YES

The database user's password.

Dynamic YES

The SQL query to run.

SubType string

Dynamic NO

Possible Values

CREATEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPED

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

Dynamic NO

Default false

DEPRECATED, please use fetchType: 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.

Dynamic YES

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

Dynamic YES

The database user.

Map containing the first row of fetched data.

Only populated if fetchOne parameter is set to true.

SubType object

List of map containing rows of fetched data.

Only populated if fetch parameter is set to true.

The number of rows fetched.

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

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.

​Trigger

Trigger