This is an automated email from the ASF dual-hosted git repository. yuqi4733 pushed a commit to branch docs-clickhouse-compat-10308 in repository https://gitbox.apache.org/repos/asf/gravitino.git
commit c3db0929bbfc4634b855f7d7c23433a0512df0cd Author: yuqi <[email protected]> AuthorDate: Tue Mar 17 21:37:45 2026 +0800 [#10308] docs(clickhouse): clarify verified JDBC compatibility matrix Update ClickHouse JDBC catalog docs to keep only verified compatibility mapping and add concise staging and official-doc guidance for other versions. Fix: #10308 Co-authored-by: Copilot <[email protected]> --- docs/jdbc-clickhouse-catalog.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/docs/jdbc-clickhouse-catalog.md b/docs/jdbc-clickhouse-catalog.md index d50a952353..25b07433bc 100644 --- a/docs/jdbc-clickhouse-catalog.md +++ b/docs/jdbc-clickhouse-catalog.md @@ -28,11 +28,23 @@ ClickHouse catalog is not included in the standard Gravitino server distribution | Scope | One catalog maps to one ClickHouse instance | | Metadata/DDL | Supports JDBC-based metadata management and DDL | | Column defaults | Supports column default values | -| Drivers | Requires user-provided ClickHouse JDBC driver in `${GRAVITINO_HOME}/catalogs/jdbc-clickhouse/libs`, please download the jar from [link](https://repo1.maven.org/maven2/com/clickhouse/clickhouse-jdbc/0.7.1/) | +| Drivers | Requires user-provided ClickHouse JDBC driver in `${GRAVITINO_HOME}/catalogs/jdbc-clickhouse/libs`. We recommend a shaded artifact (`classifier=all` or `clickhouse-jdbc-all`) from [ClickHouse JDBC docs](https://clickhouse.com/docs/en/integrations/language-clients/java/jdbc). | | Supported version | All the codes are tested by ClickHouse `24.8.14`, newer versions like `25.x` may also work but we did not conduct thorough tests. Report to the community if something does not work as expected. | :::note -ClickHouse Driver 0.7.1 is recommended for better compatibility. Some older versions of the ClickHouse JDBC driver have issues such as incorrect metadata reporting that may cause problems with Gravitino's metadata management. If you encounter issues, please check the driver version and consider upgrading to 0.7.1 or later. If the problem still persists, please report it to the Gravitino community for further investigation. +Only verified supported combinations are listed in the matrix below. +::: + +### ClickHouse server and JDBC driver compatibility matrix + +| ClickHouse version | Supported ClickHouse JDBC driver versions | +|--------------------|-------------------------------------------| +| `24.8.x` (including `24.8.14`) | `0.7.1` | + +:::tip +For production, pin exact server/driver versions and validate upgrades in a staging environment. +For other ClickHouse versions, the required JDBC driver version may be different. +Use your staging validation results and the official ClickHouse documentation as the final reference. ::: ### Catalog properties
