https://github.com/ClickHouse/clickhouse-java
ClickHouse Java Clients & JDBC Driver
https://github.com/ClickHouse/clickhouse-java
clickhouse java-client jdbc jdbc-driver
Last synced: 21 days ago
JSON representation
ClickHouse Java Clients & JDBC Driver
- Host: GitHub
- URL: https://github.com/ClickHouse/clickhouse-java
- Owner: ClickHouse
- License: apache-2.0
- Created: 2016-07-15T12:48:27.000Z (almost 9 years ago)
- Default Branch: main
- Last Pushed: 2024-11-08T18:03:02.000Z (7 months ago)
- Last Synced: 2024-11-11T08:54:22.812Z (6 months ago)
- Topics: clickhouse, java-client, jdbc, jdbc-driver
- Language: Java
- Homepage: https://clickhouse.com
- Size: 7.62 MB
- Stars: 1,447
- Watchers: 54
- Forks: 534
- Open Issues: 274
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-clickhouse - ClickHouse/clickhouse-java - ClickHouse/clickhouse-java is a repository providing Java clients and a JDBC driver for efficient interaction with the ClickHouse database, supporting modern features and compatibility with active ClickHouse versions. (Language bindings / Java)
README
ClickHouse Java Client & JDBC Driver
Table of Contents
* [About The project](#about-the-project)
* [Important](#important)
* [Installation](#installation)
* [Client V2](#client-v2)
* [Artifacts](#artifacts)
* [Examples](#examples)
* [Client V1](#client-v1)
* [Artifacts](#artifacts-1)
* [Examples](#examples-1)
* [Contributing](#contributing)
## 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.
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
| Name | Client V2 | Client V1 | Comments
|----------------------------------------------|:---------:|:---------:|:---------:|
| Http Connection |✔ |✔ | |
| Http Compression (LZ4) |✔ |✔ | |
| Server Response Compression - LZ4 |✔ |✔ | |
| Client Request Compression - LZ4 |✔ |✔ | |
| HTTPS |✔ |✔ | |
| Client SSL Cert (mTLS) |✔ |✔ | |
| Http Proxy with Authentication |✔ |✔ | |
| Java Object SerDe |✔ |✗ | |
| Connection Pool |✔ |✔ | Apache HTTP Client only |
| Named Parameters |✔ |✔ | |
| Retry on failure |✔ |✔ | |
| Failover |✗ |✔ | |
| Load-balancing |✗ |✔ | |
| Server auto-discovery |✗ |✔ | |
| Log Comment |✔ |✔ | |
| Session Roles |✔ |✔ | |
| SSL Client Authentication |✔ |✔ | |
| Session timezone |✔ |✔ | |
## Important
### Upcoming deprecations:
| Component | Version | Comment |
|--------------------------------|---------|--------------------------------------------------|
| ClickHouse Java v1 | TBC | We'll be deprecating Java v1 in 2025 |
## Installation
Releases: Maven Central (web site https://mvnrepository.com/artifact/com.clickhouse)
Nightly Builds: https://s01.oss.sonatype.org/content/repositories/snapshots/com/clickhouse/
## Client V2
### Artifacts
| Component | Maven Central Link | Javadoc Link | Documentation Link |
|---------------------------|--------------------|--------------|---------------------|
| ClickHouse Java Client V2 | [](https://mvnrepository.com/artifact/com.clickhouse/client-v2) | [](https://javadoc.io/doc/com.clickhouse/client-v2) | [docs](https://clickhouse.com/docs/integrations/java) |
### Examples
[Begin-with Usage Examples](../../tree/main/examples/client-v2)
[Spring Demo Service](https://github.com/ClickHouse/clickhouse-java/tree/main/examples/demo-service)
## JDBC Driver
### Artifacts
| Component | Maven Central Link | Javadoc Link | Documentation Link |
|-----------|--------------------|--------------|--------------------|
| ClickHouse JDBC Driver | [](https://mvnrepository.com/artifact/com.clickhouse/clickhouse-jdbc) |[](https://javadoc.io/doc/com.clickhouse/clickhouse-jdbc)|[docs](https://clickhouse.com/docs/integrations/language-clients/java/jdbc)|
### Examples
See [JDBC examples](../../tree/main/examples/jdbc)
## R2DBC Driver
### Artifacts
| Component | Maven Central Link | Javadoc Link | Documentation Link |
|-----------|--------------------|--------------|--------------------|
| ClickHouse R2DBC Driver | [](https://mvnrepository.com/artifact/com.clickhouse/clickhouse-r2dbc) | [](https://javadoc.io/doc/com.clickhouse/clickhouse-r2dbc) | [docs](https://clickhouse.com/docs/integrations/java/r2dbc)|
### Misc Artifacts
| Component | Maven Central Link | Javadoc Link |
|-----------|--------------------|--------------|
| ClickHouse Java Unified Client | [](https://mvnrepository.com/artifact/com.clickhouse/clickhouse-client) | [](https://javadoc.io/doc/com.clickhouse/clickhouse-client) |
| ClickHouse Java HTTP Client | [](https://mvnrepository.com/artifact/com.clickhouse/clickhouse-http-client) | [](https://javadoc.io/doc/com.clickhouse/clickhouse-http-client) |
## Compatibility
- All projects in this repo are tested with all [active LTS versions](https://github.com/ClickHouse/ClickHouse/pulls?q=is%3Aopen+is%3Apr+label%3Arelease) of ClickHouse.
- [Support policy](https://github.com/ClickHouse/ClickHouse/blob/master/SECURITY.md#security-change-log-and-support)
- We recommend to upgrade client continuously to not miss security fixes and new improvements
- If you have an issue with migration - create and issue and we will respond!
## Contributing
Please see our [contributing guide](./CONTRIBUTING.md).