Skip to content

Commit

Permalink
Prepare CLI package for depreciation (#1520)
Browse files Browse the repository at this point in the history
* Prepeare CLI package for deprication

* Deprecated also tests

* Chnage minor version for testing

* remove since from deprication annotation

* Add a comment for deprication version

* Update clickhouse-cli-client/README.md

Co-authored-by: Mikhail Shustov <[email protected]>

* Change clickhouse-cli-client pom description

* Fix change log

---------

Co-authored-by: mzitnik <[email protected]>
Co-authored-by: Mikhail Shustov <[email protected]>
  • Loading branch information
3 people authored Jan 11, 2024
1 parent 4b2758c commit 2e42faa
Show file tree
Hide file tree
Showing 9 changed files with 22 additions and 5 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/).
Expand Down
3 changes: 3 additions & 0 deletions clickhouse-cli-client/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion clickhouse-cli-client/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
<packaging>jar</packaging>

<name>ClickHouse Native Command-line Wrapper</name>
<description>Wrapper of ClickHouse native command-line client</description>
<description>Wrapper of ClickHouse native command-line client planed to be deprecated from version 0.6.0 and removed at 0.7.0</description>
<url>https://github.com/ClickHouse/clickhouse-java/tree/main/clickhouse-cli-client</url>

<dependencies>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@
/**
* Wrapper of ClickHouse native command-line client.
*/
// deprecate from version 0.6.0
@Deprecated
public class ClickHouseCommandLineClient extends AbstractClient<ClickHouseCommandLine> {
private static final Logger log = LoggerFactory.getLogger(ClickHouseCommandLineClient.class);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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() {
Expand Down

0 comments on commit 2e42faa

Please sign in to comment.