Merge branch 'main' into dependabot/maven/dnsjava-dnsjava-3.6.0

Author: chernser

.github/workflows/build.yml

@@ -51,15 +51,20 @@ jobs:
         uses: actions/setup-java@v4
         with:
           distribution: "temurin"
-          java-version: 8
+          java-version: |
+            8
+            21
           cache: "maven"
       - name: Build and install libraries
         run: mvn --batch-mode --no-transfer-progress --show-version --strict-checksums --threads 2 -Dmaven.wagon.rto=30000 -DclickhouseVersion=$PREFERRED_LTS_VERSION -Dj8 install
       - name: Compile examples
         run: |
           export LIB_VER=$(grep '<revision>' pom.xml | sed -e 's|[[:space:]]*<[/]*revision>[[:space:]]*||g')
           find `pwd`/examples -type f -name pom.xml -exec sed -i -e "s|\(<clickhouse-java.version>\).*\(<\)|\1$LIB_VER\2|g" {} \;
-          for d in $(ls -d `pwd`/examples/*/); do cd $d && mvn  --batch-mode --no-transfer-progress clean compile; done
+          for d in $(ls -d `pwd`/examples/*/); do \
+            if [ -e $d/pom.xml ]; then cd $d && mvn  --batch-mode --no-transfer-progress clean compile; fi;
+            if [ -e $d/gradlew ]; then cd $d && ./gradlew clean build; fi;
+          done
       - name: Upload test results
         uses: actions/upload-artifact@v4
         if: failure()
@@ -141,45 +146,6 @@ jobs:
       - name: Test compressed native image
         run: ./clickhouse-jdbc/target/clickhouse-jdbc-bin
 
-  test-cli-client:
-    runs-on: ubuntu-latest
-    needs: compile
-    timeout-minutes: 10
-    name: CLI client + CH LTS
-    steps:
-      - name: Check out repository
-        uses: actions/checkout@v4
-      - name: Check out PR
-        run: |
-          git fetch --no-tags --prune --progress --no-recurse-submodules --depth=1 \
-            origin pull/${{ github.event.inputs.pr }}/merge:merged-pr && git checkout merged-pr
-        if: github.event.inputs.pr != ''
-      - name: Install JDK 8 and Maven
-        uses: actions/setup-java@v4
-        with:
-          distribution: "temurin"
-          java-version: 8
-          cache: "maven"
-      - name: Install ClickHouse native command line
-        run: |
-          sudo apt-get update \
-            && sudo apt-get install -y apt-transport-https ca-certificates dirmngr \
-            && sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv 8919F6BD2B48D754 \
-            && echo "deb https://packages.clickhouse.com/deb lts main" | sudo tee /etc/apt/sources.list.d/clickhouse.list \
-            && sudo apt-get update && sudo apt-get install -y clickhouse-client \
-            && clickhouse client --version
-      - name: Test CLI client
-        run: |
-          mvn --also-make --batch-mode --no-transfer-progress --projects clickhouse-cli-client -DclickhouseVersion=$PREFERRED_LTS_VERSION -Dj8 -DskipUTs verify
-      - name: Upload test results
-        uses: actions/upload-artifact@v4
-        if: failure()
-        with:
-          name: result ${{ github.job }}
-          path: |
-            **/target/failsafe-reports
-            **/target/surefire-reports
-
   test-java-client:
     runs-on: ubuntu-latest
     needs: compile
@@ -230,7 +196,7 @@ jobs:
           CLICKHOUSE_CLOUD_HOST: ${{ secrets.INTEGRATIONS_TEAM_TESTS_CLOUD_HOST_SMT }}
           CLICKHOUSE_CLOUD_PASSWORD: ${{ secrets.INTEGRATIONS_TEAM_TESTS_CLOUD_PASSWORD_SMT }}
         run: |
-          mvn --also-make --batch-mode --no-transfer-progress --projects clickhouse-cli-client,clickhouse-grpc-client,clickhouse-http-client -DclickhouseVersion=${{ matrix.clickhouse }} verify
+          mvn --also-make --batch-mode --no-transfer-progress --projects clickhouse-http-client -DclickhouseVersion=${{ matrix.clickhouse }} verify
       - name: Upload test results
         uses: actions/upload-artifact@v4
         if: failure()
@@ -265,6 +231,7 @@ jobs:
           java-version: |
             8
             17
+            21
           cache: "maven"
       - name: Setup Toolchain
         shell: bash
@@ -308,7 +275,7 @@ jobs:
       matrix:
         clickhouse: ["23.8", "24.3", "24.6", "latest", "cloud"]
         # here http, http_client and apache_http_client represent different value of http_connection_provider
-        protocol: ["http", "http_client", "apache_http_client", "grpc"]
+        protocol: ["http", "http_client", "apache_http_client"]
       fail-fast: false
     timeout-minutes: 15
     name: JDBC driver + CH ${{ matrix.clickhouse }} (${{ matrix.protocol }})
@@ -347,7 +314,7 @@ jobs:
           </toolchains>
           EOF
       - name: Install Java client
-        run: mvn --also-make --batch-mode --no-transfer-progress --projects clickhouse-cli-client,clickhouse-grpc-client,clickhouse-http-client -DskipTests install
+        run: mvn --also-make --batch-mode --no-transfer-progress --projects clickhouse-http-client -DskipTests install
       - name: Test JDBC driver
         env:
           CLICKHOUSE_CLOUD_HOST: ${{ secrets.INTEGRATIONS_TEAM_TESTS_CLOUD_HOST_SMT }}
@@ -463,7 +430,7 @@ jobs:
           java-version: 8
           cache: "maven"
       - name: Install Java client
-        run: mvn --also-make --batch-mode --no-transfer-progress --projects clickhouse-cli-client,clickhouse-grpc-client,clickhouse-http-client -Dj8 -DskipTests install
+        run: mvn --also-make --batch-mode --no-transfer-progress --projects clickhouse-http-client -Dj8 -DskipTests install
       - name: Test JDBC and R2DBC drivers
         run: |
           mvn --batch-mode --no-transfer-progress --projects clickhouse-jdbc,clickhouse-r2dbc -DclickhouseVersion=$PREFERRED_LTS_VERSION \

.github/workflows/nightly.yml

@@ -12,7 +12,7 @@ on:
 
 env:
   CHC_BRANCH: "main"
-  CHC_VERSION: "0.6.3"
+  CHC_VERSION: "0.6.4"
 
 jobs:
   nightly:

.github/workflows/release.yml

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

CHANGELOG.md

@@ -1,5 +1,56 @@
 ## Latest
 
+## 0.6.4
+
+### Deprecations
+- Following components will be deprecated and archived in next release:
+  - clickhouse-cli-client
+  - clickhouse-grpc-client
+- No more builds for non-lts Java versions - no more Java 9 release builds.
+- Lowest supported Java version will be 11.
+  - Java 11 support will be ended before the end of 2023. 
+  - It is recommended to use Java 21.
+
+### Important Changes
+- [Client-V1] Fix for handling DateTime without timezone when `session_timezone` is set. Now server timezone 
+is parsed from server response when present (https://github.com/ClickHouse/clickhouse-java/issues/1464)
+
+### New Features 
+- [Client-V1/Apache HTTP] More configuration parameters for connection management. Useful for tuning performance.
+(https://github.com/ClickHouse/clickhouse-java/pull/1771)
+    - com.clickhouse.client.config.ClickHouseClientOption#CONNECTION_TTL - to configure connection time-to-live
+    - com.clickhouse.client.http.config.ClickHouseHttpOption#KEEP_ALIVE_TIMEOUT - to configure keep-alive timeout
+    - com.clickhouse.client.http.config.ClickHouseHttpOption#CONNECTION_REUSE_STRATEGY - defines how connection pool behaves.
+If `FIFO` is selected then connections are reused in the order they were created. It results in even distribution of connections.
+If `LIFO` is selected then connections are reused as soon they are returned to the pool. 
+Note: only for `APACHE_HTTP_CLIENT` connection provider. 
+    - Additionally switched to using LAX connection pool for Apache Connection Manager to improve performance 
+for concurrent requests.
+- [Client-V2] Connection pool configuration https://github.com/ClickHouse/clickhouse-java/pull/1766
+    - com.clickhouse.client.api.Client.Builder.setConnectionRequestTimeout - to configure connection request timeout.
+Important when there are no connections available in the pool to fail fast. 
+    - com.clickhouse.client.api.Client.Builder.setMaxConnections - configures how soft limit of connections per host.
+Note: Total number of connections is unlimited because in most cases there is one host.
+    - com.clickhouse.client.api.Client.Builder.setConnectionTTL - to limit connection live ignoring keep-alive from server.
+    - com.clickhouse.client.api.Client.Builder.setConnectionReuseStrategy - to configure how connections are used.
+Select FIFO to reuse connections evenly or LIFO (default) to reuse the most recently active connections.
+- [Client-V2] All operations are now executed in calling thread to avoid extra threads creation. 
+Async operations can be enabled by `com.clickhouse.client.api.Client.Builder.useAsyncRequests` (https://github.com/ClickHouse/clickhouse-java/pull/1767)
+- [Client-V2] Content and HTTP native compression is supported now Currently only LZ4 is available. (https://github.com/ClickHouse/clickhouse-java/pull/1761) 
+- [Client-V2] HTTPS support added. Required to communicate with ClickHouse Cloud Services.
+Client certificates are supported, too. (https://github.com/ClickHouse/clickhouse-java/pull/1753)
+- [Client-V2] Added support for HTTP proxy (https://github.com/ClickHouse/clickhouse-java/pull/1748)
+
+### Documentation
+- [Client-V2] Spring Demo Service as usage example (https://github.com/ClickHouse/clickhouse-java/pull/1765)
+- [Client-V2] Examples for using text based formats (https://github.com/ClickHouse/clickhouse-java/pull/1752)
+
+
+### Bug Fixes
+- [Client-V2] Data is read fully from a stream. Important for Cloud instances (https://github.com/ClickHouse/clickhouse-java/pull/1759)
+- [Client-V2] Timezone from a server response is now used to parse DateTime values (https://github.com/ClickHouse/clickhouse-java/pull/1763)
+- [Client-V1] Timezone from a server response is now used to parse DateTime values (https://github.com/ClickHouse/clickhouse-java/issues/1464)
+
 ## 0.6.3
 
 ### Important Changes

clickhouse-cli-client/src/main/java/com/clickhouse/client/cli/ClickHouseCommandLineResponse.java

@@ -14,7 +14,7 @@ public class ClickHouseCommandLineResponse extends ClickHouseStreamResponse {
     private final transient ClickHouseCommandLine cli;
 
     protected ClickHouseCommandLineResponse(ClickHouseConfig config, ClickHouseCommandLine cli) throws IOException {
-        super(config, cli.getInputStream(), null, null, ClickHouseResponseSummary.EMPTY);
+        super(config, cli.getInputStream(), null, null, ClickHouseResponseSummary.EMPTY, null);
         this.cli = cli;
 
         if (processor.getInputStream().available() < 1) {

clickhouse-cli-client/src/test/java/com/clickhouse/client/cli/ClickHouseCommandLineClientTest.java

@@ -10,6 +10,7 @@
 import com.clickhouse.client.ClientIntegrationTest;
 import com.clickhouse.client.cli.config.ClickHouseCommandLineOption;
 import com.clickhouse.data.ClickHouseCompression;
+import com.clickhouse.data.ClickHouseFormat;
 import org.testcontainers.containers.GenericContainer;
 import org.testng.SkipException;
 import org.testng.annotations.BeforeClass;
@@ -199,4 +200,9 @@ public void testLoadBalancingPolicyFailover(ClickHouseLoadBalancingPolicy loadBa
     public void testFailover() {
         throw new SkipException("Skip due to failover is not supported");
     }
+
+    @Override
+    public void testServerTimezoneAppliedFromHeader(ClickHouseFormat format) throws Exception {
+        throw new SkipException("Skip due to session timezone is not supported");
+    }
 }

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

@@ -9,6 +9,7 @@
 import java.util.NoSuchElementException;
 import java.util.Spliterator;
 import java.util.Spliterators;
+import java.util.TimeZone;
 import java.util.stream.Stream;
 import java.util.stream.StreamSupport;
 
@@ -39,7 +40,7 @@ public interface ClickHouseResponse extends AutoCloseable, Serializable {
     /**
      * Empty response that can never be closed.
      */
-    static final ClickHouseResponse EMPTY = new ClickHouseResponse() {
+    ClickHouseResponse EMPTY = new ClickHouseResponse() {
         @Override
         public List<ClickHouseColumn> getColumns() {
             return Collections.emptyList();
@@ -75,6 +76,11 @@ public boolean isClosed() {
             // ensure the instance is "stateless"
             return false;
         }
+
+        @Override
+        public TimeZone getTimeZone() {
+            return null;
+        }
     };
 
     /**
@@ -102,6 +108,15 @@ public boolean isClosed() {
      */
     ClickHouseInputStream getInputStream();
 
+    /**
+     * Returns a server timezone if it is returned by server in a header {@code X-ClickHouse-Timezone } or
+     * other way. If not, it returns null
+     * @return server timezone from server response or null
+     */
+    default TimeZone getTimeZone() {
+        return null;
+    }
+
     /**
      * Gets the first record only. Please use {@link #records()} instead if you need
      * to access the rest of records.

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

@@ -1,10 +1,5 @@
 package com.clickhouse.client;
 
-import java.util.ArrayList;
-import java.util.Collections;
-import java.util.LinkedList;
-import java.util.List;
-
 import com.clickhouse.data.ClickHouseColumn;
 import com.clickhouse.data.ClickHouseInputStream;
 import com.clickhouse.data.ClickHouseRecord;
@@ -13,12 +8,19 @@
 import com.clickhouse.data.ClickHouseSimpleRecord;
 import com.clickhouse.data.ClickHouseValue;
 
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.LinkedList;
+import java.util.List;
+import java.util.TimeZone;
+
 /**
  * A simple response built on top of two lists: columns and records.
  */
 public class ClickHouseSimpleResponse implements ClickHouseResponse {
     private static final long serialVersionUID = 6883452584393840649L;
 
+    private final TimeZone timeZone;
     /**
      * Creates a response object using columns definition and raw values.
      *
@@ -28,7 +30,7 @@ public class ClickHouseSimpleResponse implements ClickHouseResponse {
      * @return response object
      */
     public static ClickHouseResponse of(ClickHouseConfig config, List<ClickHouseColumn> columns, Object[][] values) {
-        return of(config, columns, values, null);
+        return of(config, columns, values, null, null);
     }
 
     /**
@@ -41,7 +43,7 @@ public static ClickHouseResponse of(ClickHouseConfig config, List<ClickHouseColu
      * @return response object
      */
     public static ClickHouseResponse of(ClickHouseConfig config, List<ClickHouseColumn> columns, Object[][] values,
-            ClickHouseResponseSummary summary) {
+            ClickHouseResponseSummary summary, TimeZone timeZone) {
         if (columns == null) {
             columns = Collections.emptyList();
         }
@@ -69,7 +71,7 @@ public static ClickHouseResponse of(ClickHouseConfig config, List<ClickHouseColu
             }
         }
 
-        return new ClickHouseSimpleResponse(columns, wrappedValues, summary);
+        return new ClickHouseSimpleResponse(columns, wrappedValues, summary, timeZone);
     }
 
     /**
@@ -118,7 +120,7 @@ public static ClickHouseResponse of(ClickHouseResponse response, ClickHouseRecor
             records.add(rec);
         }
 
-        return new ClickHouseSimpleResponse(response.getColumns(), records, response.getSummary());
+        return new ClickHouseSimpleResponse(response.getColumns(), records, response.getSummary(), response.getTimeZone());
     }
 
     private final List<ClickHouseColumn> columns;
@@ -129,14 +131,15 @@ public static ClickHouseResponse of(ClickHouseResponse response, ClickHouseRecor
     private volatile boolean closed;
 
     protected ClickHouseSimpleResponse(List<ClickHouseColumn> columns, List<ClickHouseRecord> records,
-            ClickHouseResponseSummary summary) {
+                                       ClickHouseResponseSummary summary, TimeZone timeZone) {
         this.columns = columns;
         this.records = Collections.unmodifiableList(records);
         this.summary = summary != null ? summary : ClickHouseResponseSummary.EMPTY;
+        this.timeZone = timeZone;
     }
 
     protected ClickHouseSimpleResponse(List<ClickHouseColumn> columns, ClickHouseValue[][] values,
-            ClickHouseResponseSummary summary) {
+            ClickHouseResponseSummary summary, TimeZone timeZone) {
         this.columns = columns;
 
         int len = values.length;
@@ -148,6 +151,7 @@ protected ClickHouseSimpleResponse(List<ClickHouseColumn> columns, ClickHouseVal
         this.records = Collections.unmodifiableList(list);
 
         this.summary = summary != null ? summary : ClickHouseResponseSummary.EMPTY;
+        this.timeZone = timeZone;
     }
 
     @Override
@@ -165,6 +169,11 @@ public ClickHouseInputStream getInputStream() {
         throw new UnsupportedOperationException("An in-memory response does not have input stream");
     }
 
+    @Override
+    public TimeZone getTimeZone() {
+        return timeZone;
+    }
+
     @Override
     public Iterable<ClickHouseRecord> records() {
         return records;