JDBCドライバー

​

環境要件

• OpenJDK バージョン 8 以上

​

Setup

{/* https://mvnrepository.com/artifact/com.clickhouse/clickhouse-jdbc */}
<dependency>
    <groupId>com.clickhouse</groupId>
    <artifactId>clickhouse-jdbc</artifactId>
    <version>0.9.8</version>
    <classifier>all</classifier>
</dependency>

// https://mvnrepository.com/artifact/com.clickhouse/clickhouse-jdbc
implementation("com.clickhouse:clickhouse-jdbc:0.9.8:all")

// https://mvnrepository.com/artifact/com.clickhouse/clickhouse-jdbc
implementation 'com.clickhouse:clickhouse-jdbc:0.9.8:all'

• Maven Central から入手し、クラスパスに追加します
  • バージョン 0.9.4 以降、https://mvnrepository.com/artifact/com.clickhouse/clickhouse-jdbc-all のアーティファクトが利用できます
  • シェーディング済みの依存関係をすべて含む jar を取得するには、修飾子 all を使用します。
• または公式リポジトリのこちらから

​

設定

• jdbc:clickhouse:http://localhost:8123
• jdbc:clickhouse:https://localhost:8443?ssl=true

• URL には 1 つのエンドポイントのみ指定できます
• デフォルトの ‘HTTP’ 以外を使用する場合は、プロトコルを指定する必要があります
• ポートは、デフォルトの ‘8123’ 以外を使用する場合に指定する必要があります
• ドライバーはポート番号からプロトコルを推測しないため、明示的に指定する必要があります
• プロトコルが指定されている場合、ssl パラメータは不要です。

​

接続プロパティ

Properties config = new Properties();
config.setProperty("user", "default");
config.setProperty("password", getPassword());

// set server setting
config.put(ClientConfigProperties.serverSetting("allow_experimental_time_time64_type"), "1");

Connection conn = Driver.connect("jdbc:ch:http://localhost:8123/", config);

Properties properties = new Properties();
properties.setProperty("user", "default");
properties.setProperty("password", getPassword());
properties.setProperty("client_name", "my-app-01"); // when http protocol is used it will be `http_user_agent` in the query log but not `client_name`.

Connection conn = Driver.connect("jdbc:ch:http://localhost:8123/", properties);

jdbc:ch:http://localhost:8123/?user=default&password=password&client_name=my-app-01 
// credentials shoud be passed in `Properties`. Here it is just for example.

​

クライアント識別

Properties properties = new Properties();
properties.setProperty(ClientConfigProperties.CLIENT_NAME.getKey(), "my-app-01");
Connection conn = Driver.connect("jdbc:ch:http://localhost:8123/", properties);

conn.setClientInfo(com.clickhouse.jdbc.ClientInfoProperties.APPLICATION_NAME.getKey(), "my-app-01");

my-app-01/1.0 jdbc-v2/0.9.7 clickhouse-java-v2/0.9.6 (Linux; jvm:17.0.17) Apache-HttpClient/5.4.4

​

オペレーションの識別

StatementImpl stmt = (StatementImpl) conn.createStatement();
stmt.getLocalSettings().logComment("some-comment");

​

サポートされているデータ型

​

JDBC 型マッピング

• ResultSet#getObject(columnIndex) - 対応する Java クラスのオブジェクトを返すメソッドです。(Int8 -> java.lang.Byte, Int16 -> java.lang.Short など)
• ResultSetMetaData#getColumnType(columnIndex) - メソッドは、対応するJDBC型を返します。(Int8 -> java.lang.Byte, Int16 -> java.lang.Short, など)

• ResultSet#getObject(columnIndex, class) - このメソッドは値をclass型に変換しようとします。変換にはいくつか制限があります。詳細は各セクションを参照してください。

• 数値型は相互に変換できます。したがって、Int8 は Float64 として取得でき、逆も同様です。:
  • rs.getObject(1, Float64.class) は、Int8 カラムの値を Float64 として返します。
  • rs.getLong(1) は、Int8 カラムの値を Long として返します。
  • rs.getByte(1) は、Byte に収まる場合、Int16 カラムの値を Byte として返すことができます。
• より広い型からより狭い型への変換は、データが破損するおそれがあるため推奨されません。
• Bool 型は数値としても扱われます。
• すべての数値型は java.lang.String として読み出すことができます。
• Java の Float.MAX_VALUE を Float として保存すると問題が発生します (https://github.com/ClickHouse/clickhouse-java/issues/809) 。同じ値を Double として保存すれば、この問題は解決します。

• String は、java.lang.String または byte[] としてのみ読み込めます。
• FixedString はそのまま読み取られ、カラムの長さに合わせてゼロで埋められます。 (たとえば、'John' に対する FixedString(10) は 'John\0\0\0\0\0\0\0\0\0' として読み取られます。)

• Enum8 と Enum16 は、デフォルトでは java.lang.String にマッピングされます。
• Enum 値は、指定された getter メソッドまたは getObject(columnIndex, Integer.class) メソッドを使用して、数値として読み取ることができます。
• Enum16 は内部的に short にマッピングされ、Enum8 は byte にマッピングされます。データ破損のリスクがあるため、Enum16 を byte として読み取るのは避けてください。
• Enum の値は、PreparedStatement では文字列または数値として設定できます。

• Date / Time 型は、JDBC との互換性を高めるため、java.sql 型にマッピングされます。ただし、ResultSet#getObject(columnIndex, Class<T>) を使用し、第 2 引数に対応するクラスを指定することで、java.time.LocalDate、java.time.LocalDateTime、java.time.LocalTime を取得することもできます。
  • rs.getObject(1, java.time.LocalDate.class) は、Date カラムの値を java.time.LocalDate として返します。
  • rs.getObject(1, java.time.LocalDateTime.class) は、DateTime カラムの値を java.time.LocalDateTime として返します。
  • rs.getObject(1, java.time.LocalTime.class) は、Time カラムの値を java.time.LocalTime として返します。
• Date, Date32, Time, Time64 はサーバーのタイムゾーンの影響を受けません。
• DateTime と DateTime64 は、サーバーまたはセッションのタイムゾーンの影響を受けます。
• DateTime と DateTime64 は、getObject(colIndex, ZonedDateTime.class) を使用して ZonedDateTime として取得できます。

• JDBC との互換性を確保するため、Array はデフォルトで java.sql.Array にマッピングされます。これは、返される配列値についてより多くの情報を提供するためでもあります。型推論に役立ちます。
• Array は、元の配列と同じ内容の java.sql.ResultSet を返す getResultSet() メソッドを実装しています。
• コレクション型を java.lang.String として読み取るべきではありません。この形式はデータの有効な表現方法ではないためです (例: 配列内の文字列値はクォートされません) 。
• Map は OTHER に対応付けられます。値は getObject(columnIndex, Class<T>) メソッドでしか読み取れないためです。
  • Map には名前付きカラムがないため、java.sql.Struct ではありません。
• Tuple は異なる型を含めることができ、List は使用できないため、Object[] にマップされます。
• Tuple は、getObject(columnIndex, Array.class) メソッドを使用して Array として読み取れます。この場合、Array#baseTypeName は Tuple のカラム定義を返します。

• ラッパー型 (Nullable, LowCardinality) は getBaseTypeName() では保持されますが、getBaseType() は内部の型の JDBC コードを返します。
• ネストされた配列はメタデータ内でフラット化されます。getBaseTypeName() が返すのは直接の子要素ではなく、最も内側にある非配列要素の型です。
• パラメーター化された型 (FixedString(N)、完全な Enum/Tuple 定義) は、getBaseTypeName() でパラメーターが保持されます。

• V2 では、getBaseTypeName() はラッパー型 (Nullable, LowCardinality) や型パラメーター (FixedString(8)、完全な Enum および Tuple の定義) を含む完全な型シグネチャを保持します。V1 ではこれらが取り除かれ、基本型名のみが返されます。
• ClickHouse のタプルは名前付きフィールドを持ち、java.sql.Struct ではそれをサポートしていないため、Tuple 配列は V2 では STRUCT (2002) ではなく OTHER (1111) を使用します。
• UUID 配列は、スカラーの UUID マッピングに合わせて、V2 では OTHER (1111) を使用します。
• Enum 値は VARCHAR にマッピングされます。enum メンバーは、基になる数値エンコーディングに関係なく、文字列名で識別されるためです。

• typeName - 配列要素の型名。例: Array(Int32) -> "Int32"。
• elements - 配列の実際の要素。たとえば [[1, 2, 3], [4, 5, 6]] -> new Integer[][] {{1, 2, 3}, {4, 5, 6}}。

try (Connection conn = ...) {
    Array array = conn.createArrayOf("Int32", new Integer[][] {{1, 2, 3}, {4, 5, 6}});
    try (PreparedStatement ps = conn.prepareStatement("INSERT INTO mytable (arr) VALUES (?)")) {
        ps.setArray(1, array);
        ps.executeUpdate();
    }
}

try (Connection conn = ...) {
    try (PreparedStatement ps = conn.prepareStatement("SELECT ?::Array(Int32)")) {
        ps.setArray(1, array);
        try (ResultSet rs = ps.executeQuery()) {
            while (rs.next()) {
                Array array = rs.getArray(1);

                Object[] arr = (Object[]) array;
                Arrays.stream(arr).forEach(this::handleArrayElement);

                // or by using `ResultSet`
                ResultSet resultSet = array.getResultSet();
                while (resultSet.next()) {
                    // ...
                }
            }
        }
    } 
}

try (Connection conn = ...) {
    Tuple tuple = new Tuple(1, "test", LocalDate.parse("2026-03-02"));
    try (PreparedStatement ps = conn.prepareStatement("INSERT INTO mytable (tuple) VALUES (?)")) {
        ps.setObject(1, tuple);
        ps.executeUpdate();
    }
}

try (Connection conn = ...) {
    Struct struct = conn.createStruct("Tuple(Int32, String, Date)", new Object[] {1, "test", LocalDate.parse("2026-03-02")});
    try (PreparedStatement ps = conn.prepareStatement("INSERT INTO mytable (tuple) VALUES (?)")) {
        ps.setStruct(1, struct);
        ps.executeUpdate();
    }
}

try (Connection conn = ...) {
    try (PreparedStatement stmt = conn.prepareStatement("SELECT ?::Tuple(String, Int32, Date)")) {
        Array tuple = conn.createArrayOf("Tuple(String, Int32, Date)",  new Object[]{"test", 123, LocalDate.parse("2026-03-02")});
        stmt.setObject(1, tuple);
        try (ResultSet rs = stmt.executeQuery()) {
            rs.next();
            Array dbTuple = rs.getArray(1);
            Assert.assertEquals(dbTuple, tuple);
            Object arr = rs.getObject(1);
            Assert.assertEquals(arr, tuple.getArray());
        }
    }
}

try (Connection conn = ...) {
    Map<String, Integer> map = new HashMap<>();
    map.put("key1", 1);
    map.put("key2", 2);
    try (PreparedStatement ps = conn.prepareStatement("INSERT INTO mytable (map) VALUES (?)")) {
        ps.setObject(1, map);
        ps.executeUpdate();
    }
}

try (Connection conn = ...) {
    try (PreparedStatement ps = conn.prepareStatement("SELECT ?::Map(String, Int32)")) {
        ps.setStruct(1, struct);
        try (ResultSet rs = ps.executeQuery()) {
            while (rs.next()) {
                Map<String, Integer> map = rs.getObject(1, Map.class);
                // ...
            }
        }
    }
}

• typeName - ネストされた要素の型名です。たとえば Nested(Tuple(Int32, String)) -> "Nested(Tuple(Int32, String))"。
• elements - 実際にネストされた要素。たとえば、[1, 'test'] -> new Object[] {1, 'test'}。

try (Connection conn = ...) {
    Struct struct = conn.createStruct("Nested(Tuple(Int32, String))", new Object[] {1, 'test'});
    try (PreparedStatement ps = conn.prepareStatement("INSERT INTO mytable (nested) VALUES (?)")) {
        ps.setStruct(1, struct);
        ps.executeUpdate();
    }
}

try (Connection conn = ...) {
    try (PreparedStatement ps = conn.prepareStatement("SELECT ?::Nested(Tuple(Int32, String))")) {
        ps.setStruct(1, struct);
        try (ResultSet rs = ps.executeQuery()) {
            while (rs.next()) {
                Struct struct = rs.getStruct(1);
                Object[] tuple = (Object[]) struct;
                Arrays.stream(tuple).forEach(this::handleTupleElement);

                // or by using `ResultSet`
                ResultSet resultSet = struct.getResultSet();
                while (resultSet.next()) {
                    // ...
                }
            }
        }
    }
}

• Nullable と LowCardinality は、ほかの型をラップする特殊な型です。
• Nullable は、ResultSetMetaData で型名がどのように返されるかに影響します

• UUID は JDBC の標準型ではありません。ただし、JDK には含まれています。デフォルトでは、getObject() メソッドは java.util.UUID を返します。
• getObject(columnIndex, String.class) メソッドを使用すると、UUID は String として読み書きできます。
• IPv4 と IPv6 は JDBC の標準型ではありません。ただし、JDK には含まれています。デフォルトでは、getObject() メソッドは java.net.Inet4Address と java.net.Inet6Address を返します。
• IPv4 と IPv6 は、getObject(columnIndex, String.class) メソッドを使うと、String として読み書きできます。

{
    "key1": "value1",
    "key2": ["value2", "value3"]
    "key3": {
        "key4": "value4",
        "key5": "value5"
    }
}

Map<String, Object> map = new HashMap<>();
map.put("key1", "value1");
map.put("key2", Arrays.asList("value2", "value3"));
map.put("key3", new HashMap<String, Object>() {{
    put("key4", "value4");
    put("key5", "value5");
}});

Properties properties = new Properties();
properties.setProperty(
                ClientConfigProperties.serverSetting(ServerSettings.OUTPUT_FORMAT_BINARY_WRITE_JSON_AS_STRING),
                "1");
try (Connection conn = DriverManager.getConnection(url, properties)) {
     try (ResultSet rs = stmt.executeQuery("SELECT * FROM test_json ORDER BY order")) {
        while (rs.next()) {
            String json = rs.getString("json");
            // ...
        }
    }
}

Properties properties = new Properties();
properties.put(ClientConfigProperties.serverSetting("output_format_json_quote_64bit_integers"), "0");
properties.put(ClientConfigProperties.serverSetting("output_format_json_quote_64bit_floats"), "0");
properties.put(ClientConfigProperties.serverSetting("output_format_json_quote_decimals"), "0");

​

日付、時刻、タイムゾーンの処理

​

接続の作成

String url = "jdbc:ch://my-server:8123/system";

Properties properties = new Properties();
DataSource dataSource = new DataSource(url, properties);//DataSource or DriverManager are the main entry points
try (Connection conn = dataSource.getConnection()) {
... // do something with the connection

​

認証情報と設定の指定

String url = "jdbc:ch://localhost:8123?jdbc_ignore_unsupported_values=true&socket_timeout=10";

Properties info = new Properties();
info.put("user", "default");
info.put("password", "password");
info.put("database", "some_db");

//Creating a connection with DataSource
DataSource dataSource = new DataSource(url, info);
try (Connection conn = dataSource.getConnection()) {
... // do something with the connection
}

//Alternate approach using the DriverManager
try (Connection conn = DriverManager.getConnection(url, info)) {
... // do something with the connection
}

​

シンプルなステートメント

try (Connection conn = dataSource.getConnection(...);
    Statement stmt = conn.createStatement()) {
    ResultSet rs = stmt.executeQuery("select * from numbers(50000)");
    while(rs.next()) {
        // ...
    }
}

​

インサート

try (PreparedStatement ps = conn.prepareStatement("INSERT INTO mytable VALUES (?, ?)")) {
    ps.setString(1, "test"); // id
    ps.setObject(2, LocalDateTime.now()); // timestamp
    ps.addBatch();
    ...
    ps.executeBatch(); // stream everything on-hand into ClickHouse
}

​

HikariCP

// connection pooling won't help much in terms of performance,
// because the underlying implementation has its own pool.
// for example: HttpURLConnection has a pool for sockets
HikariConfig poolConfig = new HikariConfig();
poolConfig.setConnectionTimeout(5000L);
poolConfig.setMaximumPoolSize(20);
poolConfig.setMaxLifetime(300_000L);
poolConfig.setDataSource(new ClickHouseDataSource(url, properties));

try (HikariDataSource ds = new HikariDataSource(poolConfig);
     Connection conn = ds.getConnection();
     Statement s = conn.createStatement();
     ResultSet rs = s.executeQuery("SELECT * FROM system.numbers LIMIT 3")) {
    while (rs.next()) {
        // handle row
        log.info("Integer: {}, String: {}", rs.getInt(1), rs.getString(1));//Same column but different types
    }
}

​

詳細情報

​

トラブルシューティング

​

ロギング

​

大規模インサート時のJDBCタイムアウトの解消

Caused by: java.sql.SQLException: Read timed out, server myHostname [uri=https://hostname.aws.clickhouse.cloud:8443]

​

Mac OS

• net.inet.tcp.keepidle: 60000
• net.inet.tcp.keepintvl: 45000
• net.inet.tcp.keepinit: 45000
• net.inet.tcp.keepcnt: 8
• net.inet.tcp.always_keepalive: 1

​

Linux

1. /etc/sysctl.conf または関連する設定ファイルで、以下の Linux カーネルパラメーターを調整します。

• net.inet.tcp.keepidle: 60000
• net.inet.tcp.keepintvl: 45000
• net.inet.tcp.keepinit: 45000
• net.inet.tcp.keepcnt: 8
• net.inet.tcp.always_keepalive: 1
• net.ipv4.tcp_keepalive_intvl: 75
• net.ipv4.tcp_keepalive_probes: 9
• net.ipv4.tcp_keepalive_time: 60 (この値は、デフォルトの300秒から引き下げることを検討してもよいでしょう)

2. カーネルパラメータを変更した後、次のコマンドを実行して変更を反映してください。

sudo sysctl -p

properties.setProperty("socket_keepalive", "true");

​

移行ガイド

​

主な変更点

• JDBC V2 は、より軽量な実装となっており、一部の機能が削除されています。
  • ストリーミングデータはJDBC仕様やJavaに含まれていないため、JDBC V2ではサポートされていません。
• JDBC V2 では明示的な設定が必要です。フェイルオーバーのデフォルト設定はありません。
  • URLにはプロトコルを指定する必要があります。ポート番号による暗黙的なプロトコル判別は行われません。

​

設定の変更

• com.clickhouse.jdbc.DriverProperties - ドライバー固有の設定プロパティ。
• com.clickhouse.client.api.ClientConfigProperties - クライアント設定のプロパティです。クライアント設定の 変更点については、Java クライアントのドキュメントで説明しています。

• まず URL からプロパティが解析されます。それらは他のすべてのプロパティを上書きします。
• ドライバーのプロパティはクライアントには渡されません。
• エンドポイント (ホスト、ポート、プロトコル) はURLから抽出されます。

String url = "jdbc:ch://my-server:8443/default?" +
            "jdbc_ignore_unsupported_values=true&" +
            "socket_rcvbuf=800000";

Properties properties = new Properties();
properties.setProperty("socket_rcvbuf", "900000");
try (Connection conn = DriverManager.getConnection(url, properties)) {
    // Connection will use socket_rcvbuf=800000 and jdbc_ignore_unsupported_values=true
    // Endpoints: my-server:8443 protocol: http (not secure)
    // Database: default
}

​

データ型の変更

• 最大の違いは、移植性を高めるために、符号なし型がJavaの型にマッピングされている点です。

• FixedString は、どちらのバージョンでもそのまま読み取られます。たとえば、'John' に対する FixedString(10) は 'John\0\0\0\0\0\0\0\0\0' として読み取られます。
• PreparedStatement#setBytes を使用すると、unhex('<hex_string>') に変換され、その後 String として読み込まれます。
• StringはUTF-8でエンコードされて保存されます。

• Time と Time64 は、V2 でのみ新しい型としてサポートされています。
• DateTime と DateTime64 は、JDBC との互換性を高めるため、java.sql.Timestamp にマッピングされます。

• V2 では、JDBC との互換性を保つため、Array はデフォルトで java.sql.Array にマッピングされます。これは、返される配列値に関する情報をより多く提供するためでもあります。型推論に役立ちます。
• V2では、Array は元の配列と同じ内容を持つ java.sql.ResultSet を返す getResultSet() メソッドを実装しています。
• V1 では Map に STRUCT を使用しますが、返されるのは常に java.util.Map オブジェクトです。V2 では、Map を JAVA_OBJECT にマッピングすることでこの問題を修正しています。
• V1 では Tuple に STRUCT を使用しますが、返り値は常に List<Object> オブジェクトです。V2 では Tuple は OTHER にマップされ、デフォルトでは Object[] が返されます。
• V2 では、タプルを書き込むための com.clickhouse.data.Tuple#Tuple が導入されました。これにより、値がタプルなのか配列なのかを簡単に見分けられます。
• PreparedStatement#setBytes と ResultSet#getBytes は、コレクション型では使用できません。これらのメソッドは、バイナリ文字列を扱うように設計されています。
• 通常、Array型の書き込みと読み取りには java.sql.Array を使用します。JDBCドライバーはこれを完全にサポートしています。
• V2 では Nested は Array にマッピングされ、タプルの配列として扱われます。
• V2 は java.sql.Struct を部分的にサポートしています。これは Array 型と非常によく似ていますが、キー・バリューのペアはサポートしていません。Struct は Tuple の値を書き込むために使用できます。

• Nullable と LowCardinality は、他の型を包む特殊な型です。
• V2では、これらの型に変更はありません。

• V1 では UUID に VARCHAR を使用していますが、常に java.util.UUID オブジェクトを返します。V2 では、UUID を OTHER にマッピングすることでこの問題を修正し、java.util.UUID オブジェクトを返します。
• V1 では IPv4 と IPv6 に VARCHAR を使用していますが、返されるのは常に java.net.Inet4Address および java.net.Inet6Address オブジェクトです。V2 では、IPv4 と IPv6 を OTHER にマッピングすることでこの問題を修正し、java.net.Inet4Address および java.net.Inet6Address オブジェクトを返すようになりました。
• Dynamic と Variant は V2 で導入された新しい型です。V1 ではサポートされていません。
• JSON は Dynamic 型をベースにしています。そのため、V2 でのみサポートされます。
• IPv4 および IPv6 の値は、getBytes(columnIndex) メソッドを使用して byte[] として読み取ることもできます。ただし、これらの型については専用のクラスを使用することを推奨します。
• V2 は、変換が InetAddress クラスでより適切に実装されているため、IP アドレスを数値として読み取ることには対応していません。

​

データベースメタデータの変更

• V2 では、データベースの名称には Schema のみを使用します。Catalog は今後のために予約されています。
• V2 では、DatabaseMetaData.supportsTransactions() と DatabaseMetaData.supportsSavepoints() は false を返します。これは今後変更される予定です。
• DatabaseMetaData.getTypeInfo() では、LITERAL_PREFIX および LITERAL_SUFFIX カラムは、プレフィックスや接尾辞が想定されないデータ型 (たとえば数値型) に対して null を返すようになりました。 V1 では、これらのカラムはそのような型に対して非 null 値を返していました。これらのカラムは、データ型に応じてリテラル値を適切にクォートできるよう、SQL クエリの生成時に使用する必要があります。