diff --git a/CHANGELOG.md b/CHANGELOG.md index a8a3022af..9e0aaf6a9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,8 @@ ## 0.6.0 ### Bug Fixes +### WARNING -- ClickHouse CLI Client deprecation +`clickhouse-cli-client` package is deprecated from version 0.6.0 and it's going to be removed in `0.7.0`. We recommend using [clickhouse-client](https://clickhouse.com/docs/en/interfaces/cli) instead. ## 0.5.0 ### Breaking Changes diff --git a/README.md b/README.md index ab6bc47cc..9c8f84e97 100644 --- a/README.md +++ b/README.md @@ -49,6 +49,12 @@ Java libraries for connecting to ClickHouse and processing data in various forma | | Implicit Type Conversion | :white_check_mark: | String/number to Date/Time/Timestamp and more | | | Object mapping | :white_check_mark: | supported since 0.4.6, slow and limited to simple data types | +## Planed to be removed + +| Feature | Version | Remark | +|--------------------------------|---------|----------------------------------------| +| Clickhouse ClI Client package | 0.7.0 | Use clickhouse-client directly instead | + ## Usage The library can be downloaded from both [Github Releases](../../releases) and [Maven Central](https://repo1.maven.org/maven2/com/clickhouse/). Development snapshots(aka. nightly build) are available on [Sonatype OSSRH](https://s01.oss.sonatype.org/content/repositories/snapshots/com/clickhouse/). diff --git a/clickhouse-cli-client/README.md b/clickhouse-cli-client/README.md index e3825df96..adfc829c3 100644 --- a/clickhouse-cli-client/README.md +++ b/clickhouse-cli-client/README.md @@ -1,5 +1,8 @@ # ClickHouse Command-line Client +## Warning +`clickhouse-cli-client` package is deprecated from version 0.6.0 and it's going to be removed in `0.7.0`. We recommend using [clickhouse-client](https://clickhouse.com/docs/en/interfaces/cli) instead. + This is a thin wrapper of ClickHouse native command-line client. It provides an alternative way to communicate with ClickHouse, which might be of use when you prefer: - TCP/native protocol over HTTP or gRPC diff --git a/clickhouse-cli-client/pom.xml b/clickhouse-cli-client/pom.xml index 253ef81dd..98d5b5858 100644 --- a/clickhouse-cli-client/pom.xml +++ b/clickhouse-cli-client/pom.xml @@ -13,7 +13,7 @@ jar ClickHouse Native Command-line Wrapper - Wrapper of ClickHouse native command-line client + Wrapper of ClickHouse native command-line client planed to be deprecated from version 0.6.0 and removed at 0.7.0 https://github.com/ClickHouse/clickhouse-java/tree/main/clickhouse-cli-client diff --git a/clickhouse-cli-client/src/main/java/com/clickhouse/client/cli/ClickHouseCommandLine.java b/clickhouse-cli-client/src/main/java/com/clickhouse/client/cli/ClickHouseCommandLine.java index 13bed4303..dc5a679b7 100644 --- a/clickhouse-cli-client/src/main/java/com/clickhouse/client/cli/ClickHouseCommandLine.java +++ b/clickhouse-cli-client/src/main/java/com/clickhouse/client/cli/ClickHouseCommandLine.java @@ -41,7 +41,8 @@ import com.clickhouse.data.ClickHouseUtils; import com.clickhouse.logging.Logger; import com.clickhouse.logging.LoggerFactory; - +// deprecate from version 0.6.0 +@Deprecated public class ClickHouseCommandLine implements AutoCloseable { private static final Logger log = LoggerFactory.getLogger(ClickHouseCommandLine.class); diff --git a/clickhouse-cli-client/src/main/java/com/clickhouse/client/cli/ClickHouseCommandLineClient.java b/clickhouse-cli-client/src/main/java/com/clickhouse/client/cli/ClickHouseCommandLineClient.java index 6a6ed6537..aa019264d 100644 --- a/clickhouse-cli-client/src/main/java/com/clickhouse/client/cli/ClickHouseCommandLineClient.java +++ b/clickhouse-cli-client/src/main/java/com/clickhouse/client/cli/ClickHouseCommandLineClient.java @@ -21,6 +21,8 @@ /** * Wrapper of ClickHouse native command-line client. */ +// deprecate from version 0.6.0 +@Deprecated public class ClickHouseCommandLineClient extends AbstractClient { private static final Logger log = LoggerFactory.getLogger(ClickHouseCommandLineClient.class); diff --git a/clickhouse-cli-client/src/main/java/com/clickhouse/client/cli/ClickHouseCommandLineResponse.java b/clickhouse-cli-client/src/main/java/com/clickhouse/client/cli/ClickHouseCommandLineResponse.java index cd3a7069d..eb5fbb0b6 100644 --- a/clickhouse-cli-client/src/main/java/com/clickhouse/client/cli/ClickHouseCommandLineResponse.java +++ b/clickhouse-cli-client/src/main/java/com/clickhouse/client/cli/ClickHouseCommandLineResponse.java @@ -6,7 +6,8 @@ import com.clickhouse.client.ClickHouseConfig; import com.clickhouse.client.ClickHouseResponseSummary; import com.clickhouse.client.ClickHouseStreamResponse; - +// deprecate from version 0.6.0 +@Deprecated public class ClickHouseCommandLineResponse extends ClickHouseStreamResponse { private static final long serialVersionUID = 4253185543390807162L; diff --git a/clickhouse-cli-client/src/main/java/com/clickhouse/client/cli/config/ClickHouseCommandLineOption.java b/clickhouse-cli-client/src/main/java/com/clickhouse/client/cli/config/ClickHouseCommandLineOption.java index e1334913e..b64f11daa 100644 --- a/clickhouse-cli-client/src/main/java/com/clickhouse/client/cli/config/ClickHouseCommandLineOption.java +++ b/clickhouse-cli-client/src/main/java/com/clickhouse/client/cli/config/ClickHouseCommandLineOption.java @@ -4,7 +4,8 @@ import com.clickhouse.config.ClickHouseOption; import com.clickhouse.data.ClickHouseChecker; - +// deprecate from version 0.6.0 +@Deprecated public enum ClickHouseCommandLineOption implements ClickHouseOption { /** * ClickHouse native command-line client path. Empty value is treated as diff --git a/clickhouse-cli-client/src/test/java/com/clickhouse/client/cli/ClickHouseCommandLineClientTest.java b/clickhouse-cli-client/src/test/java/com/clickhouse/client/cli/ClickHouseCommandLineClientTest.java index fa365b2cc..df194ef04 100644 --- a/clickhouse-cli-client/src/test/java/com/clickhouse/client/cli/ClickHouseCommandLineClientTest.java +++ b/clickhouse-cli-client/src/test/java/com/clickhouse/client/cli/ClickHouseCommandLineClientTest.java @@ -19,7 +19,8 @@ import org.testng.annotations.BeforeClass; import org.testng.annotations.DataProvider; import org.testng.annotations.Test; - +// deprecate from version 0.6.0 +@Deprecated public class ClickHouseCommandLineClientTest extends ClientIntegrationTest { @BeforeClass static void init() {