Add ClickHouseStatement.setMirroredOutput() for dumping ResultSet

Author: zhicwu

CHANGELOG.md

@@ -1,5 +1,9 @@
 ## 0.4.6, 2023-04-26
+### New Features
+* ClickHouseStatement.setMirroredOutput() for dumping ResultSet.
+
 ### Bug Fixes
+* NoClassDefFoundError with clickhouse-apache-http-client-jdbc. [#1319](https://github.com/ClickHouse/clickhouse-java/issues/1319)
 * client certificate password exposure in exception. [#1331](https://github.com/ClickHouse/clickhouse-java/issues/1331)
 
 ## 0.4.5, 2023-04-25

clickhouse-jdbc/src/main/java/com/clickhouse/jdbc/ClickHouseResultSet.java

@@ -1,7 +1,9 @@
 package com.clickhouse.jdbc;
 
 import java.io.ByteArrayInputStream;
+import java.io.IOException;
 import java.io.InputStream;
+import java.io.OutputStream;
 import java.io.Reader;
 import java.io.StringReader;
 import java.io.UncheckedIOException;
@@ -110,6 +112,15 @@ public ClickHouseResultSet(String database, String table, ClickHouseStatement st
         this.wrapObject = statement.getConnection().getJdbcConfig().useWrapperObject();
         this.defaultCalendar = conn.getDefaultCalendar();
 
+        OutputStream output = statement.getMirroredOutput();
+        if (output != null) {
+            try {
+                response.getInputStream().setCopyToTarget(output);
+            } catch (IOException e) {
+                throw SqlExceptionUtils.clientError(e);
+            }
+        }
+
         this.mapper = statement.getConnection().getJdbcTypeMapping();
         Map<String, Class<?>> typeMap = conn.getTypeMap();
         this.defaultTypeMap = typeMap != null && !typeMap.isEmpty() ? Collections.unmodifiableMap(typeMap)

clickhouse-jdbc/src/main/java/com/clickhouse/jdbc/ClickHouseStatement.java

@@ -1,5 +1,6 @@
 package com.clickhouse.jdbc;
 
+import java.io.OutputStream;
 import java.sql.SQLException;
 import java.sql.Statement;
 
@@ -13,6 +14,22 @@ public interface ClickHouseStatement extends Statement {
 
     ClickHouseConfig getConfig();
 
+    /**
+     * Gets mirrored output stream.
+     *
+     * @return mirrored output stream, could be null
+     */
+    OutputStream getMirroredOutput();
+
+    /**
+     * Sets mirrored output stream, which will be later used for dumping all
+     * {@link java.sql.ResultSet} generated by this statement, via
+     * {@link com.clickhouse.data.ClickHouseInputStream#setCopyToTarget(OutputStream)}.
+     *
+     * @param out mirrored output stream, could be null
+     */
+    void setMirroredOutput(OutputStream out);
+
     int getNullAsDefault();
 
     void setNullAsDefault(int level);

clickhouse-jdbc/src/main/java/com/clickhouse/jdbc/Main.java

@@ -10,7 +10,6 @@
 import java.sql.PreparedStatement;
 import java.sql.ResultSet;
 import java.sql.SQLException;
-import java.sql.Statement;
 import java.util.Arrays;
 import java.util.List;
 import java.util.Locale;
@@ -75,7 +74,11 @@ private Options(String url, String query, String file) {
                 this.query = query;
             }
             if (file == null || file.isEmpty()) {
-                this.file = requiresJdbc ? "jdbc.out" : "java.out";
+                if (output) {
+                    this.file = requiresJdbc ? "jdbc.out" : "java.out";
+                } else {
+                    this.file = "";
+                }
             } else {
                 this.file = file;
             }
@@ -105,6 +108,10 @@ int getSamples() {
             return s;
         }
 
+        boolean hasFile() {
+            return !file.isEmpty();
+        }
+
         boolean isDumpAction() {
             return "dump".equals(action);
         }
@@ -331,7 +338,7 @@ final long dump() throws ClickHouseException, SQLException {
                 try (ClickHouseConnection conn = new ClickHouseConnectionImpl(options.url)) {
                     ClickHouseRequest<?> request = conn.unwrap(ClickHouseRequest.class).query(options.query);
                     if (!request.getServer().getConfig().hasOption(ClickHouseClientOption.FORMAT)) {
-                        request.format(defaultFormat.defaultInputFormat());
+                        request.format(defaultFormat);
                     }
                     request.output(options.file);
                     try (ClickHouseResponse response = request.executeAndWait()) {
@@ -343,7 +350,7 @@ final long dump() throws ClickHouseException, SQLException {
                 try (ClickHouseClient client = ClickHouseClient.newInstance(server.getProtocol())) {
                     ClickHouseRequest<?> request = client.read(server).query(options.query);
                     if (!server.getConfig().hasOption(ClickHouseClientOption.FORMAT)) {
-                        request.format(defaultFormat.defaultInputFormat());
+                        request.format(defaultFormat);
                     }
                     request.output(options.file);
                     try (ClickHouseResponse response = request.query(options.query).executeAndWait()) {
@@ -389,14 +396,16 @@ final long read(Options options) throws ClickHouseException, SQLException {
             final long rows;
             if (options.requiresJdbc) {
                 try (ClickHouseConnection conn = new ClickHouseConnectionImpl(options.url);
-                        Statement stmt = conn.createStatement()) {
-                    try (ResultSet rs = stmt.executeQuery(options.query)) {
+                        ClickHouseStatement stmt = conn.createStatement()) {
+                    if (options.hasFile()) {
                         try {
-                            rs.unwrap(ClickHouseResponse.class).getInputStream()
-                                    .setCopyToTarget(new FileOutputStream(options.file, false)); // NOSONAR
+                            stmt.setMirroredOutput(
+                                    !"-".equals(options.file) ? new FileOutputStream(options.file, false) : System.out); // NOSONAR
                         } catch (IOException e) {
                             throw SqlExceptionUtils.clientError(e);
                         }
+                    }
+                    try (ResultSet rs = stmt.executeQuery(options.query)) {
                         rows = read(rs);
                     }
                 }
@@ -408,10 +417,14 @@ final long read(Options options) throws ClickHouseException, SQLException {
                         request.format(defaultFormat);
                     }
                     try (ClickHouseResponse response = request.executeAndWait()) {
-                        try {
-                            response.getInputStream().setCopyToTarget(new FileOutputStream(options.file, false)); // NOSONAR
-                        } catch (IOException e) {
-                            throw ClickHouseException.of(e, server);
+                        if (options.hasFile()) {
+                            try {
+                                response.getInputStream().setCopyToTarget(
+                                        !"-".equals(options.file) ? new FileOutputStream(options.file, false)
+                                                : System.out); // NOSONAR
+                            } catch (IOException e) {
+                                throw ClickHouseException.of(e, server);
+                            }
                         }
                         rows = read(response);
                     }
@@ -764,14 +777,14 @@ private static void printUsage() {
         println("Properties: -Dkey=value [-Dkey=value]*");
         println("  action \tAction, one of read(default), write, dump(no deserialization), and load(no serialization)");
         println("  batch  \tBatch size for JDBC writing, defaults to 1000");
-        println("  output \tWhether to write raw response into a file(java.out or jdbc.out), defaults to false");
+        println("  output \tWhether to write raw response into stdout or a file(java.out or jdbc.out), defaults to false");
         println("  samples\tSamples, defaults to 500000000");
         println("  serde  \tWhether to use default serialization/deserializion mechanism in Java client, defaults to true");
         println("  type   \tPredefined QUERY, one of Int8, UInt64, String, Array, Tuple, Nested, and Mixed");
         println("  verbose\tWhether to show logs, defaults to false");
         println();
         println("Examples:");
-        println("  -  %s 'https://localhost?sslmode=none' 'select 1'",
+        println("  -  %s 'https://localhost?sslmode=none' 'select 1' -",
                 index > 0 ? (execFile.substring(0, index) + " -Dverbose=true" + execFile.substring(index))
                         : (execFile + " -Dverbose=true"));
         println("  -  %s 'jdbc:ch://user:password@localhost:8123/default' 'select 1' output.file", execFile);
@@ -802,7 +815,7 @@ public static void main(String[] args) throws Exception {
         final long rows = query.run();
         if (options.verbose) {
             long elapsedNanos = System.nanoTime() - startTime;
-            println("Processed %,d rows in %,.2f ms (%,.2f rows/s)", rows, elapsedNanos / 1_000_000D,
+            println("\nProcessed %,d rows in %,.2f ms (%,.2f rows/s)", rows, elapsedNanos / 1_000_000D,
                     rows * 1_000_000_000D / elapsedNanos);
         }
         System.exit(rows > 0L ? 0 : 1);

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

@@ -2,6 +2,7 @@
 
 import java.io.IOException;
 import java.io.InputStream;
+import java.io.OutputStream;
 import java.io.Serializable;
 import java.nio.file.Path;
 import java.sql.ResultSet;
@@ -77,6 +78,7 @@ public class ClickHouseStatementImpl extends JdbcWrapper
     private int fetchSize;
     private int maxFieldSize;
     private long maxRows;
+    private OutputStream mirroredOutput;
     private int nullAsDefault;
     private boolean poolable;
     private volatile String queryId;
@@ -902,6 +904,23 @@ public ClickHouseConfig getConfig() {
         return request.getConfig();
     }
 
+    @Override
+    public OutputStream getMirroredOutput() {
+        return mirroredOutput;
+    }
+
+    @Override
+    public void setMirroredOutput(OutputStream out) {
+        if (this.mirroredOutput != null) {
+            try {
+                this.mirroredOutput.flush();
+            } catch (IOException e) {
+                // ignore
+            }
+        }
+        this.mirroredOutput = out;
+    }
+
     @Override
     public int getNullAsDefault() {
         return nullAsDefault;