This is an automated email from the ASF dual-hosted git repository.
diqiu50 pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/gravitino.git
The following commit(s) were added to refs/heads/main by this push:
new 9377ca23b6 [#10308] docs(clickhouse): clarify verified JDBC
compatibility matrix (#10463)
9377ca23b6 is described below
commit 9377ca23b6e14996926cbb4fdb6fd4623ec425dc
Author: Qi Yu <[email protected]>
AuthorDate: Fri Mar 20 21:46:05 2026 +0800
[#10308] docs(clickhouse): clarify verified JDBC compatibility matrix
(#10463)
### What changes were proposed in this pull request?
- Update docs/jdbc-clickhouse-catalog.md to provide a practical
compatibility matrix with only verified supported combinations.
- Keep only confirmed support mapping: ClickHouse 24.8.x -> JDBC driver
0.7.1.
- Add concise guidance that other ClickHouse versions may require
different driver versions and users should rely on staging validation +
official ClickHouse docs.
### Why are the changes needed?
- Issue #10308 indicates version compatibility confusion in real usage.
- The previous wording was too generic and not directly actionable for
operators.
Fix: #10308
### Does this PR introduce _any_ user-facing change?
- Yes. Documentation guidance for ClickHouse JDBC driver version
selection is now explicit and verification-based.
### How was this patch tested?
- Documentation-only change. Verified markdown structure and final diff
locally.
---------
Co-authored-by: Copilot <[email protected]>
---
docs/jdbc-clickhouse-catalog.md | 11 +++++++++--
1 file changed, 9 insertions(+), 2 deletions(-)
diff --git a/docs/jdbc-clickhouse-catalog.md b/docs/jdbc-clickhouse-catalog.md
index 7be0533219..6a6ed463fd 100644
--- a/docs/jdbc-clickhouse-catalog.md
+++ b/docs/jdbc-clickhouse-catalog.md
@@ -31,8 +31,15 @@ ClickHouse catalog is not included in the standard Gravitino
server distribution
| 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/) |
| 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.
+### ClickHouse server and JDBC driver compatibility matrix
+
+| ClickHouse version | Supported ClickHouse JDBC driver versions |
+|--------------------------------|-------------------------------------------|
+| `24.8.x` (including `24.8.14`) | `0.7.1 ~ 0.8.4` |
+
+:::tip
+For other ClickHouse versions (not 24.8.x), the required JDBC driver version
may be different.
+Use your staging validation results and the official ClickHouse documentation
as the final reference.
:::
### Catalog properties
