ClickHouse Driver v0.1.1¶
Driver Version v0.1.1 Release Date 2026-09-02 Tested With ClickHouse 26.8
This driver provides access to ClickHouse , an open source data warehouse and analytical database. It is developed by ClickHouse, Inc. The source code can be found at adbc_clickhouse ; the ADBC Driver Foundry distributes precompiled binaries of the upstream sources for Linux, macOS, and Windows.
ClickHouse is a trademark of ClickHouse, Inc. https://clickhouse.com
Installation¶
The ClickHouse driver can be installed with dbc :
dbc install clickhouse
Connecting¶
To use the driver, provide the URI of a ClickHouse database as the uri option.
from adbc_driver_manager import dbapi
conn = dbapi.connect(
driver="clickhouse",
db_kwargs={
"uri": "http://localhost:8123/",
}
)
Note: The example above is for Python using the adbc-driver-manager package but the process will be similar for other driver managers.
Feature & Type Support¶
| Feature | ClickHouse | |
|---|---|---|
| Bind Parameters | ❌ | |
| Bulk Ingestion | Create | ❌ |
| Append | ❌ | |
| Create/Append | ❌ | |
| Replace | ❌ | |
| Temporary Table | ❌ | |
| Target Catalog | ❌ | |
| Target Schema | ❌ | |
| Non-nullable fields are marked NOT NULL | ❌ | |
| Catalog (GetObjects) | depth=catalogs | ❌ |
| depth=db_schemas | ❌ | |
| depth=tables | ❌ | |
| depth=columns (all) | ❌ | |
| Get Parameter Schema | ❌ | |
| Get Table Schema | ❌ | |
| Prepared Statements | ❌ | |
| Transactions | ❌ | |
Types¶
Database to Arrow¶
| Database Type | ClickHouse |
|---|---|
|
Boolean |
bool |
|
Date32 |
date32[day] [1] |
|
DateTime64 (no time zone) |
timestamp[us] (with time zone) [2] |
|
DateTime64 (with time zone) |
timestamp[us] (with time zone) |
|
DateTime64(0) |
timestamp[s] (with time zone) [3] |
|
DateTime64(0, UTC) |
timestamp[s] (with time zone) [3] |
|
DateTime64(1) |
timestamp[ms] (with time zone) [3] |
|
DateTime64(1, UTC) |
timestamp[ms] (with time zone) [3] |
|
DateTime64(2) |
timestamp[ms] (with time zone) [3] |
|
DateTime64(2, UTC) |
timestamp[ms] (with time zone) [3] |
|
DateTime64(3) |
timestamp[ms] (with time zone) [3] |
|
DateTime64(3, UTC) |
timestamp[ms] (with time zone) [3] |
|
DateTime64(4) |
timestamp[us] (with time zone) [3] |
|
DateTime64(4, UTC) |
timestamp[us] (with time zone) [3] |
|
DateTime64(5) |
timestamp[us] (with time zone) [3] |
|
DateTime64(5, UTC) |
timestamp[us] (with time zone) [3] |
|
DateTime64(6) |
timestamp[us] (with time zone) [3] |
|
DateTime64(6, UTC) |
timestamp[us] (with time zone) [3] |
|
DateTime64(7) |
timestamp[ns] (with time zone) [4] |
|
DateTime64(7, UTC) |
timestamp[ns] (with time zone) [4] |
|
DateTime64(8) |
timestamp[ns] (with time zone) [4] |
|
DateTime64(8, UTC) |
timestamp[ns] (with time zone) [4] |
|
DateTime64(9) |
timestamp[ns] (with time zone) [5] |
|
DateTime64(9, UTC) |
timestamp[ns] (with time zone) [5] |
|
Decimal |
decimal128 |
|
Float32 |
float |
|
Float64 |
double |
|
Int16 |
int16 |
|
Int32 |
int32 |
|
Int64 |
int64 |
|
String |
string |
|
Time |
❌ [6] |
Arrow to Database¶
| Arrow Type | ClickHouse Type |
|---|---|
| Ingest | |
|
binary |
❌ |
|
binary_view |
❌ |
|
bool |
❌ |
|
date32[day] |
❌ |
|
decimal128 |
❌ |
|
double |
❌ |
|
fixed_size_binary |
❌ |
|
float |
❌ |
|
int16 |
❌ |
|
int32 |
❌ |
|
int64 |
❌ |
|
large_binary |
❌ |
|
large_string |
❌ |
|
string |
❌ |
|
string_view |
❌ |
|
time32[ms] |
❌ |
|
time32[s] |
❌ |
|
time64[ns] |
❌ |
|
time64[us] |
❌ |
|
timestamp[ms] |
❌ |
|
timestamp[ms] (with time zone) |
❌ |
|
timestamp[ns] |
❌ |
|
timestamp[ns] (with time zone) |
❌ |
|
timestamp[s] |
❌ |
|
timestamp[s] (with time zone) |
❌ |
|
timestamp[us] |
❌ |
|
timestamp[us] (with time zone) |
❌ |
Compatibility¶
This driver was tested on:
ClickHouse
26.8.2.7