Query a Clickhouse database.
type: "io.kestra.plugin.jdbc.clickhouse.Query"Query a Clickhouse database.
id: clickhouse_query
namespace: company.team
tasks:
- id: query
type: io.kestra.plugin.jdbc.clickhouse.Query
url: jdbc:clickhouse://127.0.0.1:56982/
username: ch_user
password: ch_password
sql: select * from clickhouse_types
fetchType: STORE
YESThe JDBC URL to connect to the database.
YEStrueNOfalseDEPRECATED, 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.
NOfalseDEPRECATED, 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.
YES10000YESNONESTOREFETCHFETCH_ONENONEThe 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.
YESParameters
A map of parameters to bind to the SQL queries. The keys should match the parameter placeholders in the SQL string, e.g., : parameterName.
YESThe database user's password.
YESThe SQL query to run.
NOfalseDEPRECATED, 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.
YESThe time zone id to use for date/time manipulation. Default value is the worker's default time zone id.
YESThe database user.
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.
uriThe 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.