Query a DuckDb Database.
type: "io.kestra.plugin.jdbc.duckdb.Query"Execute a query that reads a csv, and outputs another csv.
id: query_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: query
type: io.kestra.plugin.jdbc.duckdb.Query
url: 'jdbc:duckdb:'
timeZoneId: Europe/Paris
sql: |-
CREATE TABLE new_tbl AS SELECT * FROM read_csv_auto('{{ workingDir }}/in.csv', header=True);
COPY (SELECT order_id, customer_name FROM new_tbl) TO '{{ outputFiles.out }}' (HEADER, DELIMITER ',');
inputFiles:
in.csv: "{{ outputs.http_download.uri }}"
outputFiles:
- out
Execute a query 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 table_name;
fetchType: STORE
- id: query2
type: io.kestra.plugin.jdbc.duckdb.Query
url: jdbc:duckdb:/temp/folder/duck.db
sql: SELECT * FROM table_name;
fetchType: STORE
Execute a query that reads from an existing database file using the databaseFile variable.
id: query_duckdb
namespace: company.team
tasks:
- id: query1
type: io.kestra.plugin.jdbc.duckdb.Query
url: jdbc:duckdb:
databaseFile: {{ vars.dbfile }}
sql: SELECT * FROM table_name;
fetchType: STORE
- id: query2
type: io.kestra.plugin.jdbc.duckdb.Query
url: jdbc:duckdb:
databaseFile: /temp/folder/duck.db
sql: SELECT * FROM table_name;
fetchType: STORE
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.
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.
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.
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.
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');
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
A map of parameters to bind to the SQL queries. The keys should match the parameter placeholders in the SQL string, e.g.,: parameterName.
The database user's password.
The SQL query to run.
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.
The time zone id to use for date/time manipulation. Default value is the worker's default time zone id.
The database user.
The output files' URI in Kestra's internal storage.
Map containing the first row of fetched data.
Only populated if fetchOne parameter is set to true.
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.
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.