title: 'ClickHouse Data Connector'
sidebar_label: 'ClickHouse Data Connector'
description: 'ClickHouse Data Connector Documentation'
ClickHouse is a fast, open-source columnar database management system designed for online analytical processing (OLAP) and real-time analytics. This connector enables federated SQL queries from a ClickHouse server.
Configuration
from
The from field for the ClickHouse connector takes the form of from:db.dataset where db.dataset is the path to the Dataset within ClickHouse. In the example above it would be my.dataset.
The clickhouse_db parameter is required when not using clickhouse_connection_string. When using a connection string without a database path, it defaults to the default database.
:::info
Unquoted identifiers are normalized to lowercase. To reference a table or database with mixed-case characters, wrap each case-sensitive part in double quotes: clickhouse:my_db."MixedCaseTable". See Identifier Case Sensitivity (opens in a new tab).
:::
name
The dataset name. This will be used as the table name within Spice.
The dataset name cannot be a reserved keyword (opens in a new tab) or any of the following keywords that are reserved by ClickHouse:
params
The ClickHouse data connector can be configured by providing the following params:
| Parameter Name | Definition |
|---|
clickhouse_connection_string | The connection string to use to connect to the ClickHouse server. This can be used instead of providing individual connection parameters. |
clickhouse_host | The hostname of the ClickHouse server. |
clickhouse_tcp_port | The port of the ClickHouse server. |
clickhouse_db | The name of the database to connect to. |
clickhouse_user | The username to connect with. |
clickhouse_pass | The password to connect with. |
clickhouse_secure | Optional. Specifies the SSL/TLS behavior for the connection, supported values: true: (default) This mode requires an SSL connection. If a secure connection cannot be established, server will not connect.false: This mode will not attempt to use an SSL connection, even if the server supports it. |
connection_timeout | Optional. Specifies the connection timeout in milliseconds. Default is 10000 (10 seconds). |
Types
The table below shows the ClickHouse data types supported, along with the type mapping to Apache Arrow types in Spice.
| ClickHouse Type | Arrow Type |
|---|
Bool | Boolean |
Int8 | Int8 |
Int16 | Int16 |
Int32 | Int32 |
Int64 | Int64 |
UInt8 | UInt8 |
UInt16 | UInt16 |
UInt32 | UInt32 |
UInt64 | |
Examples
Connecting to localhost
Specifying a connection timeout
Using a connection string
Secrets
Spice integrates with multiple secret stores to help manage sensitive data securely. For detailed information on supported secret stores, refer to the secret stores documentation (opens in a new tab). Additionally, learn how to use referenced secrets in component parameters by visiting the using referenced secrets guide (opens in a new tab).
Cookbook
