Repository navigation
[Integration Spec] Update docs/integration-jdbc.md #3103
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
chernser
wants to merge
5
commits into
main
Choose a base branch
from
09/06/26/int_spec_jdbc_changes
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
c139eec
Updated integration-jdbc with error handling and some additional info…
chernser abb7085
Merge branch 'main' into 09/06/26/int_spec_jdbc_changes
chernser eeb1124
Merge branch 'main' into 09/06/26/int_spec_jdbc_changes
chernser dd2cf91
updated integration-jdbc: corrections, restructured some sections. mo…
chernser 6b56c3c
Added documentation for FINAL and sequential consistency. Fixed some …
chernser File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -88,6 +88,49 @@ The JDBC driver is a thin adaptation layer that uses the Java Client underneath | |
|
|
||
| --- | ||
|
|
||
| ## Development Environment | ||
|
|
||
| ### Java Version | ||
|
|
||
| The ClickHouse JDBC driver and Client require **Java 8 or newer**. All mainstream development and testing are validated on recent LTS versions (Java 8, 11, 17, and 21 as available). We recommend using up-to-date LTS releases, as feature coverage, TLS support, and performance are best with newer runtimes. | ||
|
|
||
| ### Local ClickHouse for Development | ||
|
|
||
| For local development and rapid prototyping, you can run ClickHouse in a container with minimal setup: | ||
|
|
||
| ```sh | ||
| docker run --rm -d -p 8123:8123 --name clickhouse-server clickhouse/clickhouse-server:latest | ||
| ``` | ||
|
|
||
| This launches a fresh ClickHouse server, with the HTTP API available at `localhost:8123`. The default database is `default` and no password is required for the default user (`default`). This is ideal for smoke tests, schema exploration, and validating basic integration. | ||
|
|
||
| You can also use any recent [official ClickHouse binary](https://clickhouse.com/docs/en/getting-started/install/) or use Docker Compose for more complex setups. | ||
|
|
||
| > **Note:** Local environments are best for initial integration, experiments, and CI pipelines — not for realistic scale, performance, or operational requirements. | ||
|
|
||
| ### ClickHouse Cloud (Recommended for Production-like Integration) | ||
|
|
||
| While local ClickHouse is excellent for early development, **we strongly recommend using [ClickHouse Cloud](https://clickhouse.com/cloud/)** for end-to-end integration and before considering your application production ready. | ||
|
|
||
| ClickHouse Cloud environments mirror real-world production settings: | ||
|
|
||
| - Managed authentication, scaling, secure TLS endpoints | ||
| - Production-like network performance and stability | ||
| - Long-running, stateful databases without the churn or "works on my machine" surprises | ||
|
|
||
| Using ClickHouse Cloud during integration helps uncover configuration or authentication nuances, avoid brittle local-only assumptions, and validates your app against true cloud operations. All features described in this guide are supported equally, and connection examples are identical — just provide your cloud hostname, port, and TLS-enabled URL in the JDBC connection string. | ||
|
|
||
| > **Best practice:** Validate your integration against ClickHouse Cloud regularly, especially before feature launches and release cutoffs. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🪨 ⭐ |
||
|
|
||
| ### Summary | ||
|
|
||
| - **Local ClickHouse**: Fast, simple; best for initial trials and interactive development. | ||
| - **ClickHouse Cloud**: Closest to real-world production, surfaces integration and operational issues early, and ensures all JDBC (and client) features work as expected. | ||
|
|
||
| For more, see the [ClickHouse Cloud docs](https://clickhouse.com/docs/en/cloud/) and the [official integrations guide](https://clickhouse.com/docs/en/integrations/java/). | ||
|
|
||
| --- | ||
|
|
||
| ## Choosing Between the Java Client and JDBC | ||
|
|
||
| Making the right choice between the client and driver is crucial for application architecture and long-term maintainability. | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
do you know of any documentation that outlines the differences between cloud? might be good to link to