ShardingSphere 默认情况下不提供对 com.clickhouse.jdbc.ClickHouseDriver 的 driverClassName 的支持。
ShardingSphere 对 ClickHouse JDBC Driver 的支持位于可选模块中。
要在 ShardingSphere 的配置文件为数据节点使用类似 jdbc:ch://localhost:8123/demo_ds_0 的 jdbcUrl，
可能的 Maven 依赖关系如下，
<dependencies>
<dependency>
<groupId>org.apache.shardingsphere</groupId>
<artifactId>shardingsphere-jdbc</artifactId>
<version>${shardingsphere.version}</version>
</dependency>
<dependency>
<groupId>org.apache.shardingsphere</groupId>
<artifactId>shardingsphere-parser-sql-clickhouse</artifactId>
<version>${shardingsphere.version}</version>
</dependency>
<dependency>
<groupId>com.clickhouse</groupId>
<artifactId>clickhouse-jdbc</artifactId>
<classifier>http</classifier>
<version>0.6.3</version>
</dependency>
</dependencies>
编写 Docker Compose 文件来启动 ClickHouse。
services:
clickhouse-server:
image: clickhouse/clickhouse-server:24.11.1.2557
ports:
- "8123:8123"
通过第三方工具在 ClickHouse 内创建业务库与业务表。 以 DBeaver Community 为例，若使用 Ubuntu 22.04.4，可通过 Snapcraft 快速安装，
sudo apt update && sudo apt upgrade -y
sudo snap install dbeaver-ce
snap run dbeaver-ce
在 DBeaver Community 内，使用 jdbc:ch://localhost:8123/default 的 jdbcUrl，default 的username 连接至 ClickHouse，
password 留空。
执行如下 SQL，
-- noinspection SqlNoDataSourceInspectionForFile
CREATE DATABASE demo_ds_0;
CREATE DATABASE demo_ds_1;
CREATE DATABASE demo_ds_2;
分别使用 jdbc:ch://localhost:8123/demo_ds_0 ，
jdbc:ch://localhost:8123/demo_ds_1 和 jdbc:ch://localhost:8123/demo_ds_2 的 jdbcUrl 连接至 ClickHouse 来执行如下 SQL，
-- noinspection SqlNoDataSourceInspectionForFile
create table IF NOT EXISTS t_order (
order_id Int64 NOT NULL,
order_type Int32,
user_id Int32 NOT NULL,
address_id Int64 NOT NULL,
status VARCHAR(50)
) engine = MergeTree
primary key (order_id)
order by (order_id);
TRUNCATE TABLE t_order;
在业务项目引入前提条件涉及的依赖后，在业务项目的 classpath 上编写 ShardingSphere 数据源的配置文件demo.yaml，
dataSources:
ds_0:
dataSourceClassName: com.zaxxer.hikari.HikariDataSource
driverClassName: com.clickhouse.jdbc.ClickHouseDriver
jdbcUrl: jdbc:ch://localhost:8123/demo_ds_0
username: default
password:
ds_1:
dataSourceClassName: com.zaxxer.hikari.HikariDataSource
driverClassName: com.clickhouse.jdbc.ClickHouseDriver
jdbcUrl: jdbc:ch://localhost:8123/demo_ds_1
username: default
password:
ds_2:
dataSourceClassName: com.zaxxer.hikari.HikariDataSource
driverClassName: com.clickhouse.jdbc.ClickHouseDriver
jdbcUrl: jdbc:ch://localhost:8123/demo_ds_2
username: default
password:
rules:
- !SHARDING
tables:
t_order:
actualDataNodes:
keyGenerateStrategy:
column: order_id
keyGeneratorName: snowflake
defaultDatabaseStrategy:
standard:
shardingColumn: user_id
shardingAlgorithmName: inline
shardingAlgorithms:
inline:
type: INLINE
props:
algorithm-expression: ds_${user_id % 2}
keyGenerators:
snowflake:
type: SNOWFLAKE
创建 ShardingSphere 的数据源以享受集成，
import com.zaxxer.hikari.HikariConfig;
import com.zaxxer.hikari.HikariDataSource;
import java.sql.Connection;
import java.sql.SQLException;
import java.sql.Statement;
public class ExampleUtils {
void test() throws SQLException {
HikariConfig config = new HikariConfig();
config.setJdbcUrl("jdbc:shardingsphere:classpath:demo.yaml");
config.setDriverClassName("org.apache.shardingsphere.driver.ShardingSphereDriver");
try (HikariDataSource dataSource = new HikariDataSource(config);
Connection connection = dataSource.getConnection();
Statement statement = connection.createStatement()) {
statement.execute("INSERT INTO t_order (user_id, order_type, address_id, status) VALUES (1, 1, 1, 'INSERT_TEST')");
statement.executeQuery("SELECT * FROM t_order");
statement.execute("alter table t_order delete where order_id=1");
}
}
}
ShardingSphere JDBC DataSource 尚不支持执行 ClickHouse 的 create table，truncate table 和 drop table 语句。
用户应考虑为 ShardingSphere 提交包含单元测试的 PR。
ClickHouse 自身的，对应分布式序列功能的列类型是 UUID，UUID 在 ClickHouse JDBC Driver 中接收为 java.util.UUID，
参考 https://github.com/ClickHouse/ClickHouse/issues/56228 。
而 ShardingSphere 的 SNOWFLAKE 的分布式序列 SPI 实现对应的列类型是 UInt64，
在 ShardingSphere JDBC Driver 中接收为 java.lang.Long。
当为 ShardingSphere 配置连接至 ClickHouse 时， 若同时配置了 ShardingSphere 使用 SNOWFLAKE 的分布式序列 SPI 实现，
ShardingSphere 的分布式序列功能使用的 ClickHouse 真实数据库中的列类型不应该被设置为 UUID。
由于 com.clickhouse:clickhouse-jdbc:0.6.3:http Maven 模块的 com.clickhouse.jdbc.ClickHouseConnection#prepareStatement(String, int)
故意在 autoGeneratedKeys 为 java.sql.Statement.RETURN_GENERATED_KEYS 时抛出异常，
以阻止 ShardingSphere 正常代理 com.clickhouse.jdbc.internal.ClickHouseConnectionImpl，
因此如果用户需要从 JDBC 业务代码获取 ShardingSphere 生成的分布式序列，需要将 autoGeneratedKeys 置为 java.sql.Statement.NO_GENERATED_KEYS。
一个可能的示例如下，
import com.zaxxer.hikari.HikariConfig;
import com.zaxxer.hikari.HikariDataSource;
import java.sql.*;
public class ExampleTest {
long test() throws SQLException {
HikariConfig config = new HikariConfig();
config.setJdbcUrl("jdbc:shardingsphere:classpath:demo.yaml");
config.setDriverClassName("org.apache.shardingsphere.driver.ShardingSphereDriver");
try (HikariDataSource dataSource = new HikariDataSource(config);
Connection connection = dataSource.getConnection();
PreparedStatement preparedStatement = connection.prepareStatement(
"INSERT INTO t_order (user_id, order_type, address_id, status) VALUES (1, 1, 1, 'INSERT_TEST')",
Statement.NO_GENERATED_KEYS
)) {
preparedStatement.executeUpdate();
try (ResultSet resultSet = preparedStatement.getGeneratedKeys()) {
if (resultSet.next()) {
return resultSet.getLong(1);
}
throw new RuntimeException();
}
}
}
}
ClickHouse 不支持 ShardingSphere 集成级别的本地事务，XA 事务或 Seata 的 AT 模式事务， 更多讨论位于 https://github.com/ClickHouse/clickhouse-docs/issues/2300 。
这与 https://clickhouse.com/docs/en/guides/developer/transactional 为 ClickHouse 提供的 Transactions, Commit, and Rollback 功能无关，
仅与 com.clickhouse.jdbc.ConnectionImpl 未实现 java.sql.Connection#rollback() 有关。
参考 https://github.com/ClickHouse/clickhouse-java/issues/2023 。
嵌入式 ClickHouse chDB 尚未发布 Java 客户端，
ShardingSphere 不针对 SNAPSHOT 版本的 https://github.com/chdb-io/chdb-java 做集成测试。
参考 https://github.com/chdb-io/chdb/issues/243 。