Trigger

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

Wait for query on a Microsoft SQL Server database.

Examples

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

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

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.

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

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.

Outputs

row

• Type: object
• Required: ❌

Map containing the first row of fetched data.

Only populated if fetchOne parameter is set to true.

rows

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

List of map containing rows of fetched data.

Only populated if fetch parameter is set to true.

size

• Type: integer
• Required: ❌

The number of rows fetched.

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

uri

• Type: string
• 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.