Skip to content
ClickHouse Docs
ClickHouse DocsClickHouse Docs

ADBC driver

The ClickHouse ADBC driver provides a standards-compliant Arrow Database Connectivity (ADBC) interface for connecting ADBC-compatible applications to ClickHouse.

The driver communicates with the ClickHouse server using the HTTP protocol, which is the primary protocol supported across all ClickHouse deployments. This allows the driver to operate consistently in diverse environments, including local installations, cloud-managed services, and environments where only HTTP-based access is available.

The source code of the driver is available in the adbc_clickhouse GitHub Repository.

Installation

You can install the latest version of the driver with dbc:

dbc install clickhouse

Alternatively, you can download it manually from github.com/adbc-drivers/clickhouse/releases.

Database options

The database options below are used to establish a connection with the ClickHouse ADBC driver.

  • uri: Specifies the full HTTP(S) endpoint of the ClickHouse server. This includes the protocol, host, and port.
  • username: The username used for authentication with the ClickHouse server.
  • password: The password associated with the specified username.
Navigation