[client-v2] Attach TimeZone to a QueryResponse & use TimeZone settings in binary readers

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-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;

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

@@ -5,6 +5,7 @@
 import java.util.Collections;
 import java.util.List;
 import java.util.Map;
+import java.util.TimeZone;
 
 import com.clickhouse.data.ClickHouseColumn;
 import com.clickhouse.data.ClickHouseDataProcessor;
@@ -23,32 +24,35 @@ public class ClickHouseStreamResponse implements ClickHouseResponse {
 
     private static final long serialVersionUID = 2271296998310082447L;
 
+    private final TimeZone timeZone;
+
     protected static final List<ClickHouseColumn> defaultTypes = Collections
             .singletonList(ClickHouseColumn.of("results", "Nullable(String)"));
-
-    public static ClickHouseResponse of(ClickHouseConfig config, ClickHouseInputStream input) throws IOException {
-        return of(config, input, null, null, null);
-    }
-
-    public static ClickHouseResponse of(ClickHouseConfig config, ClickHouseInputStream input,
-            Map<String, Serializable> settings) throws IOException {
-        return of(config, input, settings, null, null);
-    }
-
-    public static ClickHouseResponse of(ClickHouseConfig config, ClickHouseInputStream input,
-            List<ClickHouseColumn> columns) throws IOException {
-        return of(config, input, null, columns, null);
-    }
-
-    public static ClickHouseResponse of(ClickHouseConfig config, ClickHouseInputStream input,
-            Map<String, Serializable> settings, List<ClickHouseColumn> columns) throws IOException {
-        return of(config, input, settings, columns, null);
-    }
-
+//
+//    public static ClickHouseResponse of(ClickHouseConfig config, ClickHouseInputStream input) throws IOException {
+//        return of(config, input, null, null, null);
+//    }
+//
+//    public static ClickHouseResponse of(ClickHouseConfig config, ClickHouseInputStream input,
+//            Map<String, Serializable> settings) throws IOException {
+//        return of(config, input, settings, null, null);
+//    }
+//
+//    public static ClickHouseResponse of(ClickHouseConfig config, ClickHouseInputStream input,
+//            List<ClickHouseColumn> columns) throws IOException {
+//        return of(config, input, null, columns, null);
+//    }
+//
+//    public static ClickHouseResponse of(ClickHouseConfig config, ClickHouseInputStream input,
+//            Map<String, Serializable> settings, List<ClickHouseColumn> columns) throws IOException {
+//        return of(config, input, settings, columns, null);
+//    }
+//
     public static ClickHouseResponse of(ClickHouseConfig config, ClickHouseInputStream input,
-            Map<String, Serializable> settings, List<ClickHouseColumn> columns, ClickHouseResponseSummary summary)
+                                        Map<String, Serializable> settings, List<ClickHouseColumn> columns,
+                                        ClickHouseResponseSummary summary, TimeZone timeZone)
             throws IOException {
-        return new ClickHouseStreamResponse(config, input, settings, columns, summary);
+        return new ClickHouseStreamResponse(config, input, settings, columns, summary, timeZone);
     }
 
     protected final ClickHouseConfig config;
@@ -58,9 +62,11 @@ public static ClickHouseResponse of(ClickHouseConfig config, ClickHouseInputStre
     private volatile boolean closed;
 
     protected ClickHouseStreamResponse(ClickHouseConfig config, ClickHouseInputStream input,
-            Map<String, Serializable> settings, List<ClickHouseColumn> columns, ClickHouseResponseSummary summary)
+            Map<String, Serializable> settings, List<ClickHouseColumn> columns, ClickHouseResponseSummary summary,
+                                       TimeZone timeZone)
             throws IOException {
 
+        this.timeZone = timeZone;
         boolean hasError = true;
         try {
             this.processor = ClickHouseDataStreamFactory.getInstance().getProcessor(config, input, null, settings,
@@ -144,6 +150,11 @@ public Iterable<ClickHouseRecord> records() {
         return processor.records();
     }
 
+    @Override
+    public TimeZone getTimeZone() {
+        return timeZone;
+    }
+
     @Override
     public <T> Iterable<T> records(Class<T> objClass) {
         if (processor == null) {

clickhouse-grpc-client/src/main/java/com/clickhouse/client/grpc/ClickHouseGrpcResponse.java

@@ -4,6 +4,7 @@
 import java.io.Serializable;
 import java.io.UncheckedIOException;
 import java.util.Map;
+import java.util.TimeZone;
 import java.util.concurrent.TimeUnit;
 
 import com.clickhouse.client.ClickHouseConfig;
@@ -28,7 +29,7 @@ static void checkError(Result result) {
 
     protected ClickHouseGrpcResponse(ClickHouseConfig config, Map<String, Serializable> settings,
             ClickHouseStreamObserver observer) throws IOException {
-        super(config, observer.getInputStream(), settings, null, observer.getSummary());
+        super(config, observer.getInputStream(), settings, null, observer.getSummary(), null);
 
         this.observer = observer;
     }
@@ -42,7 +43,8 @@ protected ClickHouseGrpcResponse(ClickHouseConfig config, Map<String, Serializab
                         : ClickHouseGrpcClientImpl.getInput(config, result.getOutput().newInput(),
                                 () -> checkError(result)),
                 settings, null,
-                new ClickHouseResponseSummary(null, null));
+                new ClickHouseResponseSummary(null, null),
+                TimeZone.getTimeZone(result.getTimeZone()));
 
         this.observer = null;
         if (result.hasProgress()) {

clickhouse-http-client/src/main/java/com/clickhouse/client/http/ApacheHttpConnectionImpl.java

@@ -128,8 +128,8 @@ private ClickHouseHttpResponse buildResponse(ClickHouseConfig config, CloseableH
                 format = ClickHouseFormat.valueOf(value);
                 hasQueryResult = true;
             }
-            value = getResponseHeader(response, ClickHouseHttpProto.HEADER_TIMEZONE, "");
-            timeZone = !ClickHouseChecker.isNullOrEmpty(value) ? TimeZone.getTimeZone(value)
+            String tzValue = getResponseHeader(response, ClickHouseHttpProto.HEADER_TIMEZONE, "");
+            timeZone = !ClickHouseChecker.isNullOrEmpty(tzValue) ? TimeZone.getTimeZone(tzValue)
                     : timeZone;
         }
 

clickhouse-http-client/src/main/java/com/clickhouse/client/http/ClickHouseHttpClient.java

@@ -212,7 +212,7 @@ protected ClickHouseResponse send(ClickHouseRequest<?> sealedRequest) throws Cli
 
 
         return ClickHouseStreamResponse.of(httpResponse.getConfig(sealedRequest), httpResponse.getInputStream(),
-                sealedRequest.getSettings(), null, httpResponse.summary);
+                sealedRequest.getSettings(), null, httpResponse.summary, httpResponse.getTimeZone());
     }
 
     @Override

clickhouse-http-client/src/main/java/com/clickhouse/client/http/ClickHouseHttpResponse.java

@@ -81,4 +81,8 @@ public ClickHouseHttpResponse(ClickHouseHttpConnection connection, ClickHouseInp
     public ClickHouseInputStream getInputStream() {
         return input;
     }
+
+    public TimeZone getTimeZone() {
+        return timeZone;
+    }
 }

clickhouse-jdbc/src/main/java/com/clickhouse/jdbc/internal/ClickHouseStatementImpl.java

@@ -55,6 +55,7 @@
 import java.util.List;
 import java.util.Map;
 import java.util.Map.Entry;
+import java.util.TimeZone;
 import java.util.concurrent.TimeUnit;
 import java.util.concurrent.TimeoutException;
 import java.util.function.Function;
@@ -222,8 +223,10 @@ protected ClickHouseResponse processSqlStatement(ClickHouseSqlStatement stmt) th
 
                 f = getFile(f, stmt);
                 final ClickHouseResponseSummary summary = new ClickHouseResponseSummary(null, null);
+                TimeZone responseTimeZone = null;
                 try (ClickHouseResponse response = request.query(stmt.getSQL()).output(f).executeAndWait()) {
                     summary.add(response.getSummary());
+                    responseTimeZone = response.getTimeZone();
                 } catch (ClickHouseException e) {
                     throw SqlExceptionUtils.handle(e);
                 }
@@ -236,7 +239,8 @@ protected ClickHouseResponse processSqlStatement(ClickHouseSqlStatement stmt) th
                         new Object[][] { { file, f.getFormat().name(),
                                 f.hasCompression() ? f.getCompressionAlgorithm().encoding() : "none",
                                 f.getCompressionLevel(), f.getFile().length() } },
-                        summary);
+                        summary,
+                        responseTimeZone);
             } else if (stmt.getStatementType() == StatementType.INSERT) {
                 final Mutation m = request.write().query(stmt.getSQL());
                 final ClickHouseResponseSummary summary = new ClickHouseResponseSummary(null, null);
@@ -267,7 +271,7 @@ protected ClickHouseResponse processSqlStatement(ClickHouseSqlStatement stmt) th
                 } catch (IOException e) {
                     throw SqlExceptionUtils.handle(e);
                 }
-                return ClickHouseSimpleResponse.of(null, null, new Object[0][], summary);
+                return ClickHouseSimpleResponse.of(null, null, new Object[0][], summary, null);
             }
         }