Query

Query a ClickHouse database.

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

Examples

Query a Clickhouse database.

yaml
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: "{{ secret('CLICKHOUSE_USERNAME') }}"
    password: "{{ secret('CLICKHOUSE_PASSWORD') }}"
    sql: select * from clickhouse_types
    fetchType: STORE

Ingest data to and query data from ClickHouse

yaml
  id: query_clickhouse
  namespace: company.team

  tasks:
    - id: create_database
      type: io.kestra.plugin.jdbc.clickhouse.Query
      sql: CREATE DATABASE IF NOT EXISTS helloworld

    - id: create_table
      type: io.kestra.plugin.jdbc.clickhouse.Query
      sql: |
        CREATE TABLE IF NOT EXISTS helloworld.my_first_table
        (
            user_id String,
            message String,
            timestamp DateTime,
            metric Float32
        )
        ENGINE = MergeTree()
        PRIMARY KEY (user_id, timestamp)

    - id: insert_data
      type: io.kestra.plugin.jdbc.clickhouse.Query
      sql: |
        INSERT INTO helloworld.my_first_table (user_id, message, timestamp,
        metric) VALUES
            (101, 'Hello, ClickHouse!',                                 now(),       -1.0    ),
            (102, 'Insert a lot of rows per batch',                     yesterday(), 1.41421 ),
            (102, 'Sort your data based on your commonly-used queries', today(),     2.718   ),
            (101, 'Granules are the smallest chunks of data read',      now() + 5,   3.14159 )

    - id: query_and_store_as_json
      type: io.kestra.plugin.jdbc.clickhouse.Query
      sql: SELECT user_id, message FROM helloworld.my_first_table
      fetchType: STORE

  pluginDefaults:
    - type: io.kestra.plugin.jdbc.clickhouse.Query
      values:
        url: jdbc:clickhouse://host.docker.internal:8123/
        username: default

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