Queries

type: "io.kestra.plugin.jdbc.duckdb.Queries"

Perform multiple queries to a DuckDb Database.

Examples

Execute multiple queries that reads a csv, and outputs a select and a count.

id: queries_duckdb
namespace: company.team

tasks:
  - id: http_download
    type: io.kestra.plugin.core.http.Download
    uri: "https://huggingface.co/datasets/kestra/datasets/raw/main/csv/orders.csv"

  - id: queries
    type: io.kestra.plugin.jdbc.duckdb.Queries
    url: 'jdbc:duckdb:'
    timeZoneId: Europe/Paris
    sql: |-
      CREATE TABLE new_tbl AS SELECT * FROM read_csv_auto('{{ workingDir }}/in.csv', header=True);
      SELECT count(customer_name) FROM new_tbl;
      SELECT customer_name FROM new_tbl;
    inputFiles:
      in.csv: "{{ outputs.http_download.uri }}"

Execute queries that reads from an existing database file using a URL.

id: query_duckdb
namespace: company.team

tasks:
  - id: query1
    type: io.kestra.plugin.jdbc.duckdb.Query
    url: jdbc:duckdb:/{{ vars.dbfile }}
    sql: SELECT * FROM table1_name; SELECT * FROM table2_name;
    fetchType: STORE

  - id: query2
    type: io.kestra.plugin.jdbc.duckdb.Query
    url: jdbc:duckdb:/temp/folder/duck.db
    sql: SELECT * FROM table1_name; SELECT * FROM table2_name;
    fetchType: STORE

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: ✔️
• Default: jdbc:duckdb:

The JDBC URL to connect to the database.

The default value, jdbc:duckdb:, will use a local in-memory database. Set this property when connecting to a persisted database instance, for example jdbc:duckdb:md:my_database?motherduck_token=<my_token> to connect to MotherDuck.

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.

inputFiles

• Type: object
• SubType: string
• Dynamic: ✔️
• Required: ❌

Input files to be loaded from DuckDb.

Describe a files map that will be written and usable by DuckDb. You can reach files using a workingDir variable, example: SELECT * FROM read_csv_auto('{{ workingDir }}/myfile.csv');

outputFiles

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

Output file list that will be uploaded to internal storage.

List of keys that will generate temporary files. On the SQL query, you can just use a variable named outputFiles.key for the corresponding file. If you add a file with ["first"], you can use the special vars COPY tbl TO '{{ outputFiles.first }}' (HEADER, DELIMITER ','); and use this file in others tasks using {{ outputs.taskId.outputFiles.first }}.

parameters

• Type: object
• Dynamic: ✔️
• Required: ❌

Parameters

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

password

• Type: string
• Dynamic: ✔️
• Required: ❌

The database user's password.

sql

• Type: string
• Dynamic: ✔️
• Required: ❌

The SQL query to run.

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.

transaction

• Type:
  • boolean
  • string
• Dynamic: ✔️
• Required: ❌

username

• Type: string
• Dynamic: ✔️
• Required: ❌

The database user.

Outputs

outputFiles

• Type: object
• SubType: string
• Required: ❌

The output files' URI in Kestra's internal storage.

outputs

• Type: array
• SubType: AbstractJdbcBaseQuery-Output
• Required: ❌

Definitions

io.kestra.plugin.jdbc.AbstractJdbcBaseQuery-Output

Properties

row

• Type: object
• Dynamic: ❓
• Required: ❓

Map containing the first row of fetched data.

Only populated if fetchOne parameter is set to true.

rows

• Type: array
• SubType: object
• Dynamic: ❓
• Required: ❓

List of map containing rows of fetched data.

Only populated if fetch parameter is set to true.

size

• Type: integer
• Dynamic: ❓
• Required: ❓

The number of rows fetched.

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

uri

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