Merge pull request #1249 from zhicwu/main

prepare 0.4.1 release

.github/workflows/nightly.yml

@@ -12,7 +12,7 @@ on:
 
 env:
   CHC_BRANCH: "main"
-  CHC_VERSION: "0.4.1"
+  CHC_VERSION: "0.4.2"
 
 jobs:
   nightly:

.github/workflows/release.yml

@@ -6,7 +6,7 @@ on:
       version:
         description: "Release version"
         required: true
-        default: "0.4.1-SNAPSHOT"
+        default: "0.4.2-SNAPSHOT"
 
 jobs:
   release:

.gitignore

@@ -7,6 +7,7 @@
 *.jar
 *.war
 *.ear
+*.out
 
 # VSCode
 .bloop

README.md

@@ -69,7 +69,7 @@ The library can be downloaded from both [Github Releases](../../releases) and [M
     <groupId>com.clickhouse</groupId>
     <!-- or clickhouse-grpc-client if you prefer gRPC -->
     <artifactId>clickhouse-http-client</artifactId>
-    <version>0.4.0</version>
+    <version>0.4.1</version>
 </dependency>
 ```
 
@@ -105,15 +105,9 @@ try (ClickHouseClient client = ClickHouseClient.newInstance(ClickHouseProtocol.H
 <dependency>
     <groupId>com.clickhouse</groupId>
     <artifactId>clickhouse-jdbc</artifactId>
-    <version>0.4.0</version>
+    <version>0.4.1</version>
     <!-- use uber jar with all dependencies included, change classifier to http for smaller jar -->
     <classifier>all</classifier>
-    <exclusions>
-        <exclusion>
-            <groupId>*</groupId>
-            <artifactId>*</artifactId>
-        </exclusion>
-    </exclusions>
 </dependency>
 ```
 

clickhouse-benchmark/pom.xml

@@ -141,6 +141,10 @@
 
     <build>
         <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-javadoc-plugin</artifactId>
+            </plugin>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-shade-plugin</artifactId>
@@ -161,10 +165,21 @@
                                     implementation="org.apache.maven.plugins.shade.resource.ServicesResourceTransformer" />
                             </transformers>
                             <filters>
+                                <filter>
+                                    <artifact>cc.blynk.clickhouse:clickhouse4j</artifact>
+                                    <excludes>
+                                        <exclude>net/**</exclude>
+                                        <exclude>org/**</exclude>
+                                    </excludes>
+                                </filter>
                                 <filter>
                                     <artifact>*:*</artifact>
                                     <excludes>
+                                        <exclude>**/maven</exclude>
                                         <exclude>**/module-info.class</exclude>
+                                        <exclude>**/DEPENDENCIES*</exclude>
+                                        <exclude>**/LICENSE*</exclude>
+                                        <exclude>**/NOTICE*</exclude>
                                         <exclude>META-INF/MANIFEST.MF</exclude>
                                         <exclude>META-INF/*.SF</exclude>
                                         <exclude>META-INF/*.DSA</exclude>

clickhouse-cli-client/README.md

@@ -20,7 +20,7 @@ Either [clickhouse](https://clickhouse.com/docs/en/interfaces/cli/) or [docker](
 <dependency>
     <groupId>com.clickhouse</groupId>
     <artifactId>clickhouse-cli-client</artifactId>
-    <version>0.4.0</version>
+    <version>0.4.1</version>
 </dependency>
 ```
 

clickhouse-client/README.md

@@ -38,7 +38,7 @@ client.connect("http://localhost/system")
 <dependency>
     <groupId>com.clickhouse</groupId>
     <artifactId>clickhouse-http-client</artifactId>
-    <version>0.4.0</version>
+    <version>0.4.1</version>
 </dependency>
 ```
 

clickhouse-client/src/main/java/com/clickhouse/client/ClickHouseClient.java

@@ -329,7 +329,7 @@ static CompletableFuture<ClickHouseResponseSummary> dump(ClickHouseNode server,
 
         return submit(() -> {
             try (ClickHouseClient client = newInstance(theServer.getProtocol())) {
-                ClickHouseRequest<?> request = client.connect(theServer).output(stream);
+                ClickHouseRequest<?> request = client.read(theServer).output(stream);
                 // FIXME what if the table name is `try me`?
                 if (theQuery.indexOf(' ') < 0) {
                     request.table(theQuery);
@@ -415,7 +415,7 @@ static CompletableFuture<ClickHouseResponseSummary> dump(ClickHouseNode server,
 
         return submit(() -> {
             try (ClickHouseClient client = newInstance(theServer.getProtocol())) {
-                ClickHouseRequest<?> request = client.connect(theServer).compressServerResponse(compression)
+                ClickHouseRequest<?> request = client.read(theServer).compressServerResponse(compression)
                         .format(format).output(output);
                 // FIXME what if the table name is `try me`?
                 if (theQuery.indexOf(' ') < 0) {
@@ -485,7 +485,7 @@ static CompletableFuture<ClickHouseResponseSummary> load(ClickHouseNode server,
 
         return submit(() -> {
             try (ClickHouseClient client = newInstance(theServer.getProtocol());
-                    ClickHouseResponse response = client.connect(theServer).write().table(table).data(stream)
+                    ClickHouseResponse response = client.write(theServer).table(table).data(stream)
                             .executeAndWait()) {
                 return response.getSummary();
             }
@@ -516,7 +516,7 @@ static CompletableFuture<ClickHouseResponseSummary> load(ClickHouseNode server,
 
         return submit(() -> {
             try (ClickHouseClient client = newInstance(theServer.getProtocol());
-                    ClickHouseResponse response = client.connect(theServer).write().table(table).data(writer)
+                    ClickHouseResponse response = client.write(theServer).table(table).data(writer)
                             .decompressClientRequest(compression).format(format).executeAndWait()) {
                 return response.getSummary();
             }
@@ -611,7 +611,7 @@ static CompletableFuture<ClickHouseResponseSummary> load(ClickHouseNode server,
 
         return submit(() -> {
             try (ClickHouseClient client = newInstance(theServer.getProtocol());
-                    ClickHouseResponse response = client.connect(theServer).write().table(table).data(input)
+                    ClickHouseResponse response = client.write(theServer).table(table).data(input)
                             .decompressClientRequest(compression).format(format).executeAndWait()) {
                 return response.getSummary();
             } finally {
@@ -697,7 +697,7 @@ static CompletableFuture<List<ClickHouseResponseSummary>> send(ClickHouseNode se
             try (ClickHouseClient client = ClickHouseClient.builder()
                     .nodeSelector(ClickHouseNodeSelector.of(theServer.getProtocol()))
                     .option(ClickHouseClientOption.ASYNC, false).build()) {
-                ClickHouseRequest<?> request = client.connect(theServer).format(ClickHouseFormat.RowBinary);
+                ClickHouseRequest<?> request = client.read(theServer).format(ClickHouseFormat.RowBinary);
                 if ((boolean) ClickHouseDefaults.AUTO_SESSION.getEffectiveDefaultValue() && queries.size() > 1) {
                     request.session(request.getManager().createSessionId(), false);
                 }
@@ -736,7 +736,7 @@ static CompletableFuture<ClickHouseResponseSummary> send(ClickHouseNode server,
             try (ClickHouseClient client = ClickHouseClient.builder()
                     .nodeSelector(ClickHouseNodeSelector.of(theServer.getProtocol()))
                     .option(ClickHouseClientOption.ASYNC, false).build();
-                    ClickHouseResponse resp = client.connect(theServer).format(ClickHouseFormat.RowBinary).query(sql)
+                    ClickHouseResponse resp = client.read(theServer).format(ClickHouseFormat.RowBinary).query(sql)
                             .params(params).executeAndWait()) {
                 return resp.getSummary();
             }
@@ -806,7 +806,7 @@ static CompletableFuture<List<ClickHouseResponseSummary>> send(ClickHouseNode se
                     .nodeSelector(ClickHouseNodeSelector.of(theServer.getProtocol()))
                     .option(ClickHouseClientOption.ASYNC, false).build()) {
                 // format doesn't matter here as we only need a summary
-                ClickHouseRequest<?> request = client.connect(theServer).format(ClickHouseFormat.RowBinary).query(sql);
+                ClickHouseRequest<?> request = client.read(theServer).format(ClickHouseFormat.RowBinary).query(sql);
                 for (int i = 0; i < size; i++) {
                     Object[] o = params[i];
                     String[] arr = new String[len];
@@ -859,7 +859,7 @@ static CompletableFuture<List<ClickHouseResponseSummary>> send(ClickHouseNode se
                     .nodeSelector(ClickHouseNodeSelector.of(theServer.getProtocol()))
                     .option(ClickHouseClientOption.ASYNC, false).build()) {
                 // format doesn't matter here as we only need a summary
-                ClickHouseRequest<?> request = client.connect(theServer).format(ClickHouseFormat.RowBinary);
+                ClickHouseRequest<?> request = client.read(theServer).format(ClickHouseFormat.RowBinary);
                 ClickHouseParameterizedQuery query = ClickHouseParameterizedQuery.of(request.getConfig(), sql);
                 StringBuilder builder = new StringBuilder();
                 for (String[] p : params) {
@@ -1093,7 +1093,7 @@ default boolean ping(ClickHouseNode server, int timeout) {
             if (server.getProtocol() == ClickHouseProtocol.ANY) {
                 server = ClickHouseNode.probe(server.getHost(), server.getPort(), timeout);
             }
-            try (ClickHouseResponse resp = connect(server) // create request
+            try (ClickHouseResponse resp = read(server) // create request
                     .option(ClickHouseClientOption.ASYNC, false) // use current thread
                     .option(ClickHouseClientOption.CONNECTION_TIMEOUT, timeout)
                     .option(ClickHouseClientOption.SOCKET_TIMEOUT, timeout)

clickhouse-client/src/test/java/com/clickhouse/client/ClickHouseNodeTest.java

@@ -107,6 +107,17 @@ public void testBuildInOneGo() {
         checkCustomValues(node, "", host, port, 1, protocol, database, null, new String[] { "read-only", "primary" });
     }
 
+    @Test(groups = { "unit" })
+    public void testCredentials() {
+        ClickHouseNode node = ClickHouseNode.builder().build();
+        Assert.assertEquals(node.getCredentials().orElse(null), null);
+
+        ClickHouseCredentials credentials = ClickHouseCredentials.fromUserAndPassword("default", "password");
+        node = ClickHouseNode.builder().credentials(credentials).build();
+        Assert.assertEquals(node.getCredentials().orElse(null), credentials);
+        Assert.assertTrue(node.getCredentials().orElse(null) == credentials, "Should be the exact same instance");
+    }
+
     @Test(groups = { "unit" })
     public void testDatabase() {
         ClickHouseConfig config = new ClickHouseConfig(

clickhouse-client/src/test/java/com/clickhouse/client/ClientIntegrationTest.java

@@ -1441,6 +1441,8 @@ public void testCustomWriter() throws ClickHouseException {
 
                 try (ClickHouseResponse resp = req.data(w).executeAndWait()) {
                     Assert.assertNotNull(resp);
+                } catch (Exception e) {
+                    Assert.fail("Failed to call executeAndWait(): async=" + b, e);
                 }
                 Assert.assertTrue(req.getInputStream().get().isClosed(), "Input stream should have been closed");
             }

clickhouse-data/README.md

@@ -8,7 +8,7 @@
 <dependency>
     <groupId>com.clickhouse</groupId>
     <artifactId>clickhouse-data</artifactId>
-    <version>0.4.0</version>
+    <version>0.4.1</version>
 </dependency>
 ```
 

clickhouse-jdbc/README.md

@@ -10,15 +10,9 @@ Keep in mind that `clickhouse-jdbc` is synchronous, and in general it has more o
 <dependency>
     <groupId>com.clickhouse</groupId>
     <artifactId>clickhouse-jdbc</artifactId>
-    <version>0.4.0</version>
+    <version>0.4.1</version>
     <!-- use uber jar with all dependencies included, change classifier to http for smaller jar -->
     <classifier>all</classifier>
-    <exclusions>
-        <exclusion>
-            <groupId>*</groupId>
-            <artifactId>*</artifactId>
-        </exclusion>
-    </exclusions>
 </dependency>
 ```
 

clickhouse-r2dbc/README.md

@@ -9,7 +9,7 @@
     <groupId>com.clickhouse</groupId>
     <!-- change to clickhouse-r2dbc_0.9.1 for SPI 0.9.1.RELEASE -->
     <artifactId>clickhouse-r2dbc</artifactId>
-    <version>0.4.0</version>
+    <version>0.4.1</version>
     <!-- use uber jar with all dependencies included, change classifier to http or grpc for smaller jar -->
     <classifier>all</classifier>
     <exclusions>

examples/grpc/pom.xml → examples/client/pom.xml

@@ -5,12 +5,12 @@
     <modelVersion>4.0.0</modelVersion>
 
     <groupId>com.clickhouse</groupId>
-    <artifactId>grpc-examples</artifactId>
+    <artifactId>java-client-examples</artifactId>
     <version>1.0.0</version>
     <packaging>jar</packaging>
 
-    <name>grpc-examples</name>
-    <description>gRPC Examples</description>
+    <name>java-client-examples</name>
+    <description>Java Client Examples</description>
     <url>https://github.com/ClickHouse/clickhouse-java</url>
     <inceptionYear>2022</inceptionYear>
 
@@ -66,7 +66,7 @@
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
 
-        <clickhouse-grpc.version>0.4.0</clickhouse-grpc.version>
+        <clickhouse-java.version>0.4.1</clickhouse-java.version>
 
         <compiler-plugin.version>3.8.1</compiler-plugin.version>
 
@@ -76,8 +76,12 @@
     <dependencies>
         <dependency>
             <groupId>com.clickhouse</groupId>
-            <artifactId>clickhouse-grpc-client</artifactId>
-            <version>${clickhouse-grpc.version}</version>
+            <!--
+                change to clickhouse-cli-client for TCP
+                or clickhouse-grpc-client for gRPC
+            -->
+            <artifactId>clickhouse-http-client</artifactId>
+            <version>${clickhouse-java.version}</version>
             <classifier>shaded</classifier>
             <exclusions>
                 <exclusion>

examples/grpc/src/main/java/com/clickhouse/examples/jdbc/Main.java → examples/client/src/main/java/com/clickhouse/examples/jdbc/Main.java

@@ -88,13 +88,15 @@ static int query(ClickHouseNode server, String table) throws ClickHouseException
 
     public static void main(String[] args) {
         ClickHouseNode server = ClickHouseNode.builder()
-                .host(System.getProperty("chHost", "127.0.0.1"))
-                .port(ClickHouseProtocol.GRPC, Integer.parseInt(System.getProperty("chPort", "9100")))
+                .host(System.getProperty("chHost", "localhost"))
+                .port(ClickHouseProtocol.HTTP, Integer.getInteger("chPort", 8123))
+                // .port(ClickHouseProtocol.GRPC, Integer.getInteger("chPort", 9000))
+                // .port(ClickHouseProtocol.TCP, Integer.getInteger("chPort", 9100))
                 .database("system").credentials(ClickHouseCredentials.fromUserAndPassword(
                         System.getProperty("chUser", "default"), System.getProperty("chPassword", "")))
                 .build();
 
-        String table = "grpc_example_table";
+        String table = "java_client_example_table";
 
         try {
             dropAndCreateTable(server, table);

examples/jdbc/pom.xml

@@ -66,7 +66,7 @@
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
 
-        <clickhouse-jdbc.version>0.4.0</clickhouse-jdbc.version>
+        <clickhouse-java.version>0.4.1</clickhouse-java.version>
         <hikaricp.version>4.0.3</hikaricp.version>
 
         <compiler-plugin.version>3.8.1</compiler-plugin.version>
@@ -78,14 +78,8 @@
         <dependency>
             <groupId>com.clickhouse</groupId>
             <artifactId>clickhouse-jdbc</artifactId>
-            <version>${clickhouse-jdbc.version}</version>
+            <version>${clickhouse-java.version}</version>
             <classifier>http</classifier>
-            <exclusions>
-                <exclusion>
-                    <groupId>*</groupId>
-                    <artifactId>*</artifactId>
-                </exclusion>
-            </exclusions>
         </dependency>
         <dependency>
             <groupId>com.zaxxer</groupId>

examples/r2dbc/clickhouse-r2dbc-spring-webflux-sample/pom.xml

@@ -37,7 +37,7 @@
         <dependency>
             <groupId>com.clickhouse</groupId>
             <artifactId>clickhouse-r2dbc</artifactId>
-            <version>0.4.0</version>
+            <version>0.4.1</version>
         </dependency>
         <dependency>
             <groupId>com.fasterxml.jackson.datatype</groupId>

pom.xml

@@ -84,7 +84,7 @@
     </distributionManagement>
 
     <properties>
-        <revision>0.4.1-SNAPSHOT</revision>
+        <revision>0.4.2-SNAPSHOT</revision>
         <project.current.year>2023</project.current.year>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
@@ -157,7 +157,7 @@
         <sonar.moduleKey>${project.artifactId}</sonar.moduleKey>
         <sonar.organization>zhicwu</sonar.organization>
         <sonar.host.url>https://sonarcloud.io</sonar.host.url>
-        <sonar.projectVersion>0.4.0</sonar.projectVersion>
+        <sonar.projectVersion>0.4.1</sonar.projectVersion>
         <sonar.cpd.exclusions>**/*0*.java,**/data/*Value.java,**/data/array/*Value.java,**/stream/*Stream.java</sonar.cpd.exclusions>
     </properties>