ClickHouse is an open-source column-oriented database for real-time analytics using SQL. It's known for extremely fast query performance on large datasets.
Installation
Required packages: clickhouse-connect>=0.6.8
echo "clickhouse-connect>=0.6.8" >> ./docker/requirements-local.txtDrivers
clickhouse-connect (Recommended)Recommended
clickhouse-sqlalchemy (Legacy)
PyPI Package:
clickhouse-connect>=0.6.8clickhousedb://{username}:{password}@{host}:{port}/{database}Official ClickHouse Python driver with native protocol support.
Connection Examples
Altinity Cloud
clickhousedb://demo:demo@github.demo.trial.altinity.cloud/default?secure=trueLocal (no auth, no SSL)
clickhousedb://localhost/defaultSupported Features
JOINsSubqueriesDynamic SchemaCatalog SupportDynamic CatalogSSH TunnelingQuery CancellationFile UploadUser ImpersonationCost EstimationSQL Validation
Feature Score: 61/201
Time Grains
Common Time Grains:
SECONDMINUTEHOURDAYWEEKMONTHQUARTERYEAR
Extended Time Grains:
FIVE_SECONDSTHIRTY_SECONDSFIVE_MINUTESTEN_MINUTESFIFTEEN_MINUTESTHIRTY_MINUTESHALF_HOURSIX_HOURSWEEK_STARTING_SUNDAYWEEK_STARTING_MONDAYWEEK_ENDING_SATURDAYWEEK_ENDING_SUNDAYQUARTER_YEAR
Compatible Databases
The following databases are compatible with the ClickHouse driver:
ClickHouse CloudClickHouse Cloud is the official fully-managed cloud service for ClickHouse. It provides automatic scaling, built-in backups, and enterprise security features.
clickhousedb://{username}:{password}@{host}:8443/{database}?secure=trueParameters:
| Parameter | Description |
|---|---|
| username | ClickHouse Cloud username |
| password | ClickHouse Cloud password |
| host | Your ClickHouse Cloud hostname |
| database | Database name (default) |
Altinity.CloudAltinity.Cloud is a managed ClickHouse service providing Kubernetes-native deployments with enterprise support.
clickhousedb://{username}:{password}@{host}/{database}?secure=trueHelp improve this documentation by editing the engine spec: