​
Overview

ClickHouse is an open-source column-oriented DBMS for online analytical processing that allows users to generate analytical reports using SQL queries in real-time.

​
Authentication

This provider requires authentication.

  • username: Clickhouse username (required: True, sensitive: False)
  • password: Clickhouse password (required: True, sensitive: True)
  • host: Clickhouse hostname (required: True, sensitive: False)
  • port: Clickhouse port (required: True, sensitive: False)
  • database: Clickhouse database name (required: False, sensitive: False)
  • protocol: Protocol (‘clickhouses’ for SSL, ‘clickhouse’ for no SSL, ‘http’ or ‘https’) (required: True, sensitive: False)
  • verify: Enable SSL verification (required: False, sensitive: False)

Certain scopes may be required to perform specific actions or queries via the provider. Below is a summary of relevant scopes and their use cases:

  • connect_to_server: The user can connect to the server (mandatory)

​
In workflows

This provider can be used in workflows.

As “step” to query data, example:

steps:
    - name: Query clickhouse
      provider: clickhouse
      config: "{{ provider.my_provider_name }}"
      with:
        query: {value}  
        single_row: {value}

As “action” to make changes or update data, example:

actions:
    - name: Query clickhouse
      provider: clickhouse
      config: "{{ provider.my_provider_name }}"
      with:
        query: {value}  
        single_row: {value}

Check the following workflow examples:

​
Connecting with the ClickHouse provider

  1. Obtain the required authentication parameters.
  2. Add ClickHouse provider to your keep account and configure with the above authentication parameters.