From b3c41bd18dbf92707f24c035cc3fc98da1041f6b Mon Sep 17 00:00:00 2001 From: Mike Lewis <315540040+mikelewisCH@users.noreply.github.com> Date: Sat, 17 Oct 2026 14:59:27 -0400 Subject: [PATCH 1/2] docs: note Cloud and self-hosted, update the paragraph breaks The README does not say whether the client can be pointed at a hosted ClickHouse or one you run yourself. Add a sentence to `About the Project` that says the client and driver work with both, linking a Cloud trial and the self-hosted install guide. Also update the paragraph breaks in the opening description, which makes room for the new sentence. Trailing whitespace had been running the `Historically, there are two versions` sentence onto the end of the JDBC one. Link the ClickHouse repository and site in the first sentence. The repository URL was bare and spelled `Clickhouse`. Co-Authored-By: Claude Opus 5 --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 38a32dd53..9f81a74c1 100644 --- a/README.md +++ b/README.md @@ -22,8 +22,11 @@ Table of Contents ## About the Project -This is a repo of the Java Client and JDBC Driver for ClickHouse Database (https://github.com/ClickHouse/Clickhouse) supported by the ClickHouse team. The Java Client is the core component that provides an API to interact with the database via HTTP Protocol. -The JDBC driver component implements the JDBC specification and communicates with ClickHouse using the Java Client API. +This is the repository for the Java Client and JDBC Driver for the [ClickHouse database](https://github.com/ClickHouse/ClickHouse), supported by the [ClickHouse](https://clickhouse.com) team. + +The Java Client is the core component that provides an API to interact with the database via HTTP Protocol. The JDBC driver component implements the JDBC specification and communicates with ClickHouse using the Java Client API. + +The client and driver work with both ClickHouse Cloud and self-hosted ClickHouse. You can [start a free Cloud trial](https://console.clickhouse.cloud/signUp?utm_medium=referral&utm_source=github&utm_campaign=readme&utm_content=clickhouse-java) or [install ClickHouse](https://clickhouse.com/docs/get-started/setup/install) locally. Historically, there are two versions of both components. The previous version of the Java client required a significant rewrite, so we decided to create a new one, `client-v2`, not to disturb anyone's work and to give time for migration. The JDBC driver also required changes to be compatible with the new client and comply more with JDBC specs, and we created `jdbc-v2`. This component will replace an old version (to keep the artifact name). ## Client Features From e0cb6f3605498481e262d09cc331b1d17ca2471b Mon Sep 17 00:00:00 2001 From: Mike Lewis <315540040+mikelewisCH@users.noreply.github.com> Date: Mon, 19 Oct 2026 12:00:10 -0400 Subject: [PATCH 2/2] docs: separate the new paragraph from the one below it The sentence added in the previous commit had no blank line after it, so it rendered joined to `Historically, there are two versions` -- the same fault this branch set out to repair. Co-Authored-By: Claude Opus 5 --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 9f81a74c1..a70c8cddf 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,7 @@ This is the repository for the Java Client and JDBC Driver for the [ClickHouse d The Java Client is the core component that provides an API to interact with the database via HTTP Protocol. The JDBC driver component implements the JDBC specification and communicates with ClickHouse using the Java Client API. The client and driver work with both ClickHouse Cloud and self-hosted ClickHouse. You can [start a free Cloud trial](https://console.clickhouse.cloud/signUp?utm_medium=referral&utm_source=github&utm_campaign=readme&utm_content=clickhouse-java) or [install ClickHouse](https://clickhouse.com/docs/get-started/setup/install) locally. + Historically, there are two versions of both components. The previous version of the Java client required a significant rewrite, so we decided to create a new one, `client-v2`, not to disturb anyone's work and to give time for migration. The JDBC driver also required changes to be compatible with the new client and comply more with JDBC specs, and we created `jdbc-v2`. This component will replace an old version (to keep the artifact name). ## Client Features