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.
fromThe 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.
If db is not specified in either the from field or the clickhouse_db parameter, it will default to the default database.
nameThe dataset name. This will be used as the table name within Spice.
The dataset name cannot be a reserved keyword or any of the following keywords that are reserved by ClickHouse:
PREWHERESETTINGSFORMATparamsThe 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). |
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. Additionally, learn how to use referenced secrets in component parameters by visiting the using referenced secrets guide.