Skip to content

Commit ea49d7f

Browse files
zhicwuzhicwu
authored
Add notice for upgrading
1 parent 0673c7f commit ea49d7f

File tree

1 file changed

+19
-9
lines changed

1 file changed

+19
-9
lines changed

‎README.md

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,29 @@
44

55
Java client and JDBC driver for ClickHouse. Java client is async, lightweight, and low-overhead library for ClickHouse; while JDBC driver is built on top of the Java client with more dependencies and extensions for JDBC-compliance.
66

7-
Java 8 or higher is required in order to use Java client([clickhouse-client](https://github.com/ClickHouse/clickhouse-jdbc/clickhouse-client)) and/or JDBC driver([clickhouse-jdbc](https://github.com/ClickHouse/clickhouse-jdbc/clickhouse-jdbc)). In addition, starting from 0.3.2, JDBC driver only works on ClickHouse 20.7 or above, so please consider to either downgrade the driver to 0.3.1-patch or upgrade server to one of [active releases](https://github.com/ClickHouse/ClickHouse/pulls?q=is%3Aopen+is%3Apr+label%3Arelease).
7+
Java 8 or higher is required in order to use Java client([clickhouse-client](https://github.com/ClickHouse/clickhouse-jdbc/clickhouse-client)) and/or JDBC driver([clickhouse-jdbc](https://github.com/ClickHouse/clickhouse-jdbc/clickhouse-jdbc)). In addition, starting from 0.3.2, JDBC driver only works with ClickHouse 20.7 or above, so please consider to either downgrade the driver to 0.3.1-patch or upgrade server to one of [active releases](https://github.com/ClickHouse/ClickHouse/pulls?q=is%3Aopen+is%3Apr+label%3Arelease).
88

9-
## Feature Matrix
9+
---
10+
11+
:exclamation: **IMPORTANT**
12+
13+
Maven groupId `ru.yandex.clickhouse` and legacy JDBC driver `ru.yandex.clickhouse.ClickHouseDriver` are deprecated.
14+
15+
Please use new groupId `com.clickhouse` and driver `com.clickhouse.jdbc.ClickHouseDriver` instead. It's highly recommended to upgrade to 0.3.2+ and start to integrate the new JDBC driver for improved performance and stability.
16+
17+
![image](https://user-images.githubusercontent.com/4270380/154429324-631f718d-9277-4522-b60d-13f87b2e6c31.png)
18+
Note: in general, the new driver(v0.3.2) is a few times faster with less memory usage. More information can be found at [here](https://github.com/ClickHouse/clickhouse-jdbc/issues/768).
19+
20+
---
21+
22+
## Features
1023

1124
| Category | Feature | Supported | Remark |
1225
| ------------- | ------------------------------------------------------------ | ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------- |
1326
| Protocol | [HTTP](https://clickhouse.com/docs/en/interfaces/http/) | :white_check_mark: | recommended, defaults to `java.net.HttpURLConnection` and can be changed to `java.net.http.HttpClient`(faster but less stable) |
1427
| | [gRPC](https://clickhouse.com/docs/en/interfaces/grpc/) | :white_check_mark: | experimental, still missing some features like LZ4 compression |
1528
| | [TCP/Native](https://clickhouse.com/docs/en/interfaces/tcp/) | :x: | will be available in 0.3.3 |
16-
| Compatibility | Server < 20.7 | :x: | use 0.3.1-patch |
29+
| Compatibility | Server < 20.7 | :x: | use 0.3.1-patch(or 0.2.6 if you're stuck with JDK 7) |
1730
| | Server >= 20.7 | :white_check_mark: | use 0.3.2 or above. All [active releases](https://github.com/ClickHouse/ClickHouse/pulls?q=is%3Aopen+is%3Apr+label%3Arelease) are supported. |
1831
| Data Type | AggregatedFunction | :x: | limited to `groupBitmap` |
1932
| | Array(\*) | :white_check_mark: | |
@@ -81,7 +94,7 @@ Java 8 or higher is required in order to use Java client([clickhouse-client](htt
8194

8295
| Property | Default | Description |
8396
| -------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
84-
| continueBatchOnError | `false` | Whether to continue batch processing when error occurred |
97+
| continueBatchOnError | `false` | Whether to continue batch processing when error occurred |
8598
| custom_http_headers | | comma separated custom http headers, for example: `User-Agent=client1,X-Gateway-Id=123` |
8699
| custom_http_params | | comma separated custom http query parameters, for example: `extremes=0,max_result_rows=100` |
87100
| jdbcCompliance | `true` | Whether to support standard synchronous UPDATE/DELETE and fake transaction |
@@ -189,7 +202,7 @@ Use `mvn clean verify` to compile, test and generate shaded packages if you're u
189202

190203
## Benchmark
191204

192-
To benchmark JDBC drivers for comparison:
205+
To benchmark JDBC drivers:
193206

194207
```bash
195208
cd clickhouse-benchmark
@@ -198,10 +211,7 @@ mvn -Drelease clean package
198211
java -DdbHost=localhost -jar target/benchmarks.jar -t 1 -p client=clickhouse-http-jdbc1 -p connection=reuse -p statement=prepared Query.selectInt8
199212
```
200213

201-
It's time consuming to run all benchmarks against all drivers using different parameters. If you just need some numbers to understand performance, please refer to table below and some more details like CPU and memory usage mentioned at [here](https://github.com/ClickHouse/clickhouse-jdbc/issues/768)(still have plenty of room to improve according to ranking at [here](https://github.com/go-faster/ch-bench)).
202-
203-
![image](https://user-images.githubusercontent.com/4270380/154429324-631f718d-9277-4522-b60d-13f87b2e6c31.png)
204-
214+
It's time consuming to run all benchmarks against all drivers using different parameters for comparison. If you just need some numbers to understand performance, please refer to table below and some more details like CPU and memory usage mentioned at [here](https://github.com/ClickHouse/clickhouse-jdbc/issues/768)(still have plenty of room to improve according to ranking at [here](https://github.com/go-faster/ch-bench)).
205215

206216
## Testing
207217

0 commit comments

Comments
 (0)