- The hostname for the ClickHouse database server
- The username/password for the ClickHouse database server
Add the following to a
.env file in your Cube project:
CUBEJS_DB_TYPE=clickhouse CUBEJS_DB_HOST=my.clickhouse.host CUBEJS_DB_NAME=my_clickhouse_database CUBEJS_DB_USER=clickhouse_user CUBEJS_DB_PASS=**********
|Environment Variable||Description||Possible Values||Required||Supports multiple data sources?|
|The host URL for a database||A valid database host URL||✅||✅|
|The port for the database connection||A valid port number||❌||✅|
|The name of the database to connect to||A valid database name||✅||✅|
|The username used to connect to the database||A valid database username||✅||✅|
|The password used to connect to the database||A valid database password||✅||✅|
|Whether the ClickHouse user has read-only access or not||❌||✅|
|The number of concurrent connections each queue has to the database. Default is ||A valid number||❌||❌|
|The maximum number of concurrent database connections to pool. Default is ||A valid number||❌||✅|
Measures of type
not be used in pre-aggregations when using ClickHouse as a source database.
To learn more about pre-aggregation build strategies, head here.
|Feature||Works with read-only mode?||Is default?|
By default, ClickHouse uses batching to build pre-aggregations.
No extra configuration is required to configure batching for ClickHouse.
ClickHouse does not support export buckets.
To enable SSL-encrypted connections between Cube and ClickHouse, set the
CUBEJS_DB_SSL environment variable to
true. For more information on how to
configure custom certificates, please check out Enable SSL Connections to the
You can connect to a ClickHouse database when your user's permissions are
restricted to read-only, by setting
Did you find this page useful?