You need to enable JavaScript to run this app.
ByteHouse Cloud Data Warehouse Version

ByteHouse Cloud Data Warehouse Version

Copy page
Download PDF
Use drivers
Overview
Copy page
Download PDF
Overview

ByteHouse Cloud Data Warehouse Edition provides a wide range of connection driver tools to help you quickly access ByteHouse and carry out data development using different programming languages and frameworks. This article provides an introduction to the core features of the driver, the logic for selecting it, and important notes for its use.

Overview

You can connect ByteHouse and your application through a connection driver, supporting data query, data insertion, management, and other operations. Dimensions to consider when selecting a driver:

  • Development language: Give priority to aligning with your technology stack, for example, select JDBC drivers for Java;
  • Protocol compatibility: Must be consistent with the connection protocol of the ByteHouse service (TCP 19000, HTTP 8123, MySQL-compatible port 3306);
  • Functional requirements: Consider whether support is needed for ByteHouse custom Settings, long connections (KeepAlive), and other features.

Driver classification

The following presents each driver's core information, grouped by development language, to help you select the connection driver you need.

Language

Driver name

Supported protocols

Recommended version

Default timeout period configuration

Is KeepAlive supported

Does ByteHouse support custom settings

Java

ByteHouse JDBC Driver

TCP(19000)

It is recommended to use the latest version

ping_timeout:10s
query_timeout:0s
send_timeout: Currently not activated
receive_timeout: Currently inactive
connect_timeout:0s

Support project (supported by default)

Support project

ClickHouse JDBC Driver

HTTP(8123)

It is recommended to use version 0.4.6.

socket_timeout:30000ms
connect_timeout:5s

Supported, requires JDK11

Support project

MySQL JDBC Driver

TCP(3306)

It is recommended to use version 8.3.0

connectTimeout:0
socketTimeout:0

Supported; requires JDK 11

Not supported

Golang

ClickHouse Go Driver

TCP(19000)
HTTP(8123)

It is recommended to use V2 versions or any version earlier than V2.30.0.

TCP:
dial_timeout:30s
read_timeout:300s
HTTP:
dial_timeout:30s
read_timeout:300s

TCP (19000): Supported (supported by default)
HTTP (8123): Supported (supported by default)

Support project

MySQL Go Driver

TCP(3306)

It is recommended to use version 1.8.1

timeout:0s
readTimeout:0s
writeTimeout:0s

Support (supported by default)

Not supported

Python

ClickHouse Python Driver

TCP(19000)

It is recommended to use version 0.2.9.

connect_timeout:10s
send_receive_timeout:300s

Support project

Support project

PyMySQL

TCP(3306)

It is recommended to use version 1.1.2

connect_timeout:10s
read_timeout:none
write_timeout:none

Support project

Not supported

ClickHouse SQLAlchemy Connector

TCP(19000)

Suggestion to use

  • SQLAlchemy 2.0.38 Version
  • Clickhouse Connect 0.3.2 Version
  • Bytehouse Connect 0.3.2
  • Python 3.10

None

Support project

Support project

MySQL SQLAlchemy Conncetor

None

Suggestion to use

  • SQLAlchemy Version 2.0.41
  • Python 3.12.6

None

Not supported

Not supported

C#

ClickHouse C# Driver

HTTP(8123)

It is recommended to use version 7.13.0.

Timeout:120s

Not supported

Support project

Rust

ClickHouse Rust (HTTP) Driver

HTTP(8123)

It is recommended to use version 0.13.1

send_timeout:None
end_timeout:None

Support project

Support project

PHP

ClickHouse PHP Driver

HTTP(8123)

It is recommended to use version 1.6.0.

setConnectTimeOut:5s
setTimeout:20s
setTimeout: specifies the max_execution_time parameter of ClickHouse

Not supported

Support project

Other driver tools

In addition to the language-specific drivers mentioned above, ByteHouse also supports connectors for the following tools/frameworks, which are suitable for specific scenarios:

  • ClickHouse NodeJSHTTP protocol driver for the Node.js environment that supports server-side JavaScript development scenarios.
  • Flink Connector DriverFor data synchronization between the Flink real-time computing engine and ByteHouse, to satisfy streaming data processing requirements;
  • Spark Connector DriverFor data interaction between the Spark batch processing engine and ByteHouse, adapted for offline big data analysis scenarios.
Last updated: 2026.03.31 16:21:56