Query

Query a Microsoft SQL Server database.

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

Examples

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

yaml
id: sqlserver_query
namespace: company.team

tasks:
  - id: select
    type: io.kestra.plugin.jdbc.sqlserver.Query
    url: jdbc:sqlserver://localhost:41433;trustServerCertificate=true
    username: "{{ secret('SQL_USERNAME') }}"
    password: "{{ secret('SQL_PASSWORD') }}"
    sql: select * from source
    fetchType: FETCH

  - id: generate_update
    type: io.kestra.plugin.jdbc.sqlserver.Query
    url: jdbc:sqlserver://localhost:41433;trustServerCertificate=true
    username: "{{ secret('SQL_USERNAME') }}"
    password: "{{ secret('SQL_PASSWORD') }}"
    sql: "{% for row in outputs.update.rows %} INSERT INTO destination (year_month, store_code, update_date) values ({{row.year_month}}, {{row.store_code}}, '{{row.date}}'); {% endfor %}"

Properties

url *string

The JDBC URL to connect to the database.

fetchSize integerstring

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.

fetchType string

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.

parameters object

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.

password string

The database user's password.

sql string

The SQL query to run.

timeZoneId string

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

username string

The database user.

Outputs

row object

Map containing the first row of fetched data.

Only populated if fetchOne parameter is set to true.

rows array

SubType object

List of map containing rows of fetched data.

Only populated if fetch parameter is set to true.

size integer

The number of rows fetched.

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

uri string

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.

​Query

Query