Merge pull request #2008 from ClickHouse/v2_process_jdbc_properties

[jdbc-v2] JDBC Properties configuration

Author: chernser

client-v2/src/main/java/com/clickhouse/client/api/Client.java

@@ -209,6 +209,10 @@ public void close() {
         if (oldClient != null) {
             oldClient.close();
         }
+
+        if (httpClientHelper != null) {
+            httpClientHelper.close();
+        }
     }
 
     public static class Builder {
@@ -290,7 +294,7 @@ public Builder addEndpoint(String endpoint) {
                     throw new IllegalArgumentException("Only HTTP and HTTPS protocols are supported");
                 }
             } catch (java.net.MalformedURLException e) {
-                throw new IllegalArgumentException("Endpoint should be a valid URL string", e);
+                throw new IllegalArgumentException("Endpoint should be a valid URL string, but was " + endpoint, e);
             }
             return this;
         }
@@ -940,6 +944,16 @@ public Builder setClientName(String clientName) {
             return this;
         }
 
+        /**
+         * Sets client options from provided map. Values are copied as is
+         * @param options - map of client options
+         * @return same instance of the builder
+         */
+        public Builder setOptions(Map<String, String> options) {
+            this.configuration.putAll(options);
+            return this;
+        }
+
         public Client build() {
             setDefaults();
 
@@ -950,7 +964,7 @@ public Client build() {
             // check if username and password are empty. so can not initiate client?
             if (!this.configuration.containsKey("access_token") &&
                 (!this.configuration.containsKey("user") || !this.configuration.containsKey("password")) &&
-                !MapUtils.getFlag(this.configuration, "ssl_authentication")) {
+                !MapUtils.getFlag(this.configuration, "ssl_authentication", false)) {
                 throw new IllegalArgumentException("Username and password (or access token, or SSL authentication) are required");
             }
 
@@ -2105,6 +2119,10 @@ public Set<String> getEndpoints() {
         return Collections.unmodifiableSet(endpoints);
     }
 
+    public String getUser() {
+        return this.configuration.get(ClientConfigProperties.USER.getKey());
+    }
+
     /**
      * Sets list of DB roles that should be applied to each query.
      *

client-v2/src/main/java/com/clickhouse/client/api/ClientConfigProperties.java

@@ -17,14 +17,14 @@ public enum ClientConfigProperties {
 
     HTTP_USE_BASIC_AUTH("http_use_basic_auth"),
 
-    USER("user"),
+    USER("user", "default"),
 
-    PASSWORD("password"),
+    PASSWORD("password", ""),
 
     /**
      * Maximum number of active connection in internal connection pool.
      */
-    HTTP_MAX_OPEN_CONNECTIONS("max_open_connections"),
+    HTTP_MAX_OPEN_CONNECTIONS("max_open_connections", "10"),
 
     /**
      * HTTP keep-alive timeout override.
@@ -59,7 +59,7 @@ public enum ClientConfigProperties {
 
     SOCKET_LINGER_OPT("socket_linger"),
 
-    DATABASE("database"),
+    DATABASE("database", "default"),
 
     COMPRESS_SERVER_RESPONSE("compress"), // actually a server setting, but has client effect too
 
@@ -118,14 +118,37 @@ public enum ClientConfigProperties {
 
     private String key;
 
+    private String defaultValue;
+
+    private List<String> choices;
+
+
     ClientConfigProperties(String key) {
+        this(key, null, Collections.emptyList());
+    }
+
+    ClientConfigProperties(String key, String defaultValue) {
+        this(key, defaultValue, Collections.emptyList());
+    }
+
+    ClientConfigProperties(String key, String defaultValue, List<String> choices) {
         this.key = key;
+        this.defaultValue = defaultValue;
+        this.choices = Collections.unmodifiableList(choices);
     }
 
     public String getKey() {
         return key;
     }
 
+    public List<String> getChoices() {
+        return choices;
+    }
+
+    public String getDefaultValue() {
+        return defaultValue;
+    }
+
     public static final String HTTP_HEADER_PREFIX = "http_header_";
 
     public static final String SERVER_SETTING_PREFIX = "clickhouse_setting_";

client-v2/src/main/java/com/clickhouse/client/api/data_formats/internal/AbstractBinaryFormatReader.java

@@ -518,6 +518,7 @@ public boolean hasValue(int colIndex) {
 
     @Override
     public boolean hasValue(String colName) {
+        getSchema().getColumnByName(colName);
         return currentRecord.containsKey(colName);
     }
 

client-v2/src/main/java/com/clickhouse/client/api/internal/HttpAPIClientHelper.java

@@ -42,6 +42,7 @@
 import org.apache.hc.core5.http.impl.io.DefaultHttpResponseParserFactory;
 import org.apache.hc.core5.http.io.SocketConfig;
 import org.apache.hc.core5.http.io.entity.EntityTemplate;
+import org.apache.hc.core5.io.CloseMode;
 import org.apache.hc.core5.io.IOCallback;
 import org.apache.hc.core5.net.URIBuilder;
 import org.apache.hc.core5.pool.PoolConcurrencyPolicy;
@@ -639,4 +640,8 @@ public static Map<String, String> parseUrlParameters(URL url) {
 
         return params;
     }
+
+    public void close() {
+        httpClient.close(CloseMode.IMMEDIATE);
+    }
 }

client-v2/src/main/java/com/clickhouse/client/api/internal/ServerSettings.java

@@ -22,4 +22,14 @@ public final class ServerSettings {
      */
     public static final String OUTPUT_FORMAT_BINARY_WRITE_JSON_AS_STRING = "output_format_binary_write_json_as_string";
 
+    /**
+     * Limit number of rows in a result set
+     */
+    public static final String MAX_RESULT_ROWS = "max_result_rows";
+
+    /**
+     * Defines server response if result set exceeded a limit set by {@code max_result_rows}.
+     * Possible values are 'throw' or 'break'. Default is 'throw'
+     */
+    public static final String RESULT_OVERFLOW_MODE = "result_overflow_mode";
 }

client-v2/src/main/java/com/clickhouse/client/api/metadata/NoSuchColumnException.java

@@ -0,0 +1,10 @@
+package com.clickhouse.client.api.metadata;
+
+import com.clickhouse.client.api.ClientException;
+
+public class NoSuchColumnException extends ClientException {
+
+    public NoSuchColumnException(String message) {
+        super(message);
+    }
+}

client-v2/src/main/java/com/clickhouse/client/api/metadata/TableSchema.java

@@ -1,5 +1,6 @@
 package com.clickhouse.client.api.metadata;
 
+import com.clickhouse.client.api.ClientException;
 import com.clickhouse.data.ClickHouseColumn;
 
 import java.util.ArrayList;
@@ -87,20 +88,22 @@ public void addColumn(String name, String type, String defaultType) {
     }
 
     public ClickHouseColumn getColumnByName(String name) {
-        for (ClickHouseColumn column : columns) {
-            if (column.getColumnName().equalsIgnoreCase(name)) {
-                return column;//TODO: Try to deep clone the column rather than reference pass
-            }
-        }
-
-        return null;
+        return columns.get(nameToIndex(name));
     }
 
     public String indexToName(int index) {
-        return columns.get(index).getColumnName();
+        try {
+            return columns.get(index).getColumnName();
+        } catch (IndexOutOfBoundsException e) {
+            throw new NoSuchColumnException("Result has no column with index = " + index);
+        }
     }
 
     public int nameToIndex(String name) {
+        Integer index = colIndex.get(name);
+        if (index == null) {
+            throw new NoSuchColumnException("Result has no column with name '" + name + "'");
+        }
         return colIndex.get(name).intValue();
     }
 

jdbc-v2/src/main/java/com/clickhouse/jdbc/ConnectionImpl.java

@@ -8,6 +8,7 @@
 import com.clickhouse.jdbc.internal.DriverProperties;
 import com.clickhouse.jdbc.internal.JdbcConfiguration;
 import com.clickhouse.jdbc.internal.ExceptionUtils;
+import com.clickhouse.jdbc.internal.JdbcConfiguration;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -68,24 +69,13 @@ public ConnectionImpl(String url, Properties info) throws SQLException {
             clientName += " (" + detectedFrameworks + ")";
         }
 
-        this.client =  new Client.Builder()
-                .fromUrl(this.config.getUrl())//URL without prefix
-                .setUsername(config.getUser())
-                .setPassword(config.getPassword())
+        this.client =  this.config.applyClientProperties(new Client.Builder())
                 .setClientName(clientName)
                 .build();
-        this.schema = client.getDefaultDatabase(); // TODO: fix in properties handling?
+        this.schema = client.getDefaultDatabase();
         this.defaultQuerySettings = new QuerySettings();
 
-        this.metadata = new com.clickhouse.jdbc.metadata.DatabaseMetaData(this, false);
-    }
-
-    public String getUser() {
-        return config.getUser();
-    }
-
-    public String getURL() {
-        return url;
+        this.metadata = new com.clickhouse.jdbc.metadata.DatabaseMetaData(this, false, url);
     }
 
     public QuerySettings getDefaultQuerySettings() {
@@ -506,6 +496,14 @@ public void setShardingKey(ShardingKey shardingKey) throws SQLException {
         Connection.super.setShardingKey(shardingKey);
     }
 
+    /**
+     * Returns instance of the client used to execute queries by this connection.
+     * @return - client instance
+     */
+    public Client getClient() {
+        return client;
+    }
+
     private void checkOpen() throws SQLException {
         if (isClosed()) {
             throw new SQLException("Connection is closed", ExceptionUtils.SQL_STATE_CONNECTION_EXCEPTION);

jdbc-v2/src/main/java/com/clickhouse/jdbc/Driver.java

@@ -1,6 +1,7 @@
 package com.clickhouse.jdbc;
 
 
+import com.clickhouse.client.api.ClientConfigProperties;
 import com.clickhouse.jdbc.internal.JdbcConfiguration;
 import com.clickhouse.jdbc.internal.ExceptionUtils;
 import org.slf4j.Logger;
@@ -130,7 +131,7 @@ public boolean acceptsURL(String url) throws SQLException {
 
     @Override
     public DriverPropertyInfo[] getPropertyInfo(String url, Properties info) throws SQLException {
-        return JdbcConfiguration.getDriverPropertyInfo(info).toArray(new DriverPropertyInfo[0]);
+        return new JdbcConfiguration(url, info).getDriverPropertyInfo().toArray(new DriverPropertyInfo[0]);
     }
 
     public static int getDriverMajorVersion() {
@@ -156,6 +157,10 @@ public boolean jdbcCompliant() {
         return false;
     }
 
+    public static String chSettingKey(String key) {
+        return ClientConfigProperties.serverSetting(key);
+    }
+
     @Override
     public java.util.logging.Logger getParentLogger() throws SQLFeatureNotSupportedException {
         throw new SQLFeatureNotSupportedException("Method not supported", ExceptionUtils.SQL_STATE_FEATURE_NOT_SUPPORTED);

jdbc-v2/src/main/java/com/clickhouse/jdbc/internal/DriverProperties.java

@@ -1,24 +1,54 @@
 package com.clickhouse.jdbc.internal;
 
+import java.util.Collections;
+import java.util.List;
+
 /**
- * JDBC driver specific properties. Do not include any ClickHouse client properties here.
+ * JDBC driver specific properties. Should not include any of ClientConfigProperties.
+ * Processing logic should be the follows
+ * 1. If property is among DriverProperties then Driver handles it specially and will not pass to a client
+ * 2. If property is not among DriverProperties then it is passed to a client
  */
 public enum DriverProperties {
 
     IGNORE_UNSUPPORTED_VALUES("jdbc_ignore_unsupported_values", ""),
     SCHEMA_TERM("jdbc_schema_term", ""),
-    PLACEHOLDER("placeholder", "Placeholder for unknown properties");
+    /**
+     * Indicates if driver should create a secure connection over SSL/TLS
+     */
+    SECURE_CONNECTION("ssl", "false"),
+
+    /**
+     * query settings to be passed along with query operation.
+     * {@see com.clickhouse.client.api.query.QuerySettings}
+     */
+    DEFAULT_QUERY_SETTINGS("default_query_settings", null);
 
     private final String key;
 
-    private final String description;
+    private final String defaultValue;
+
+    private final List<String> choices;
+
+    DriverProperties(String key, String defaultValue) {
+        this(key, defaultValue, Collections.emptyList());
+    }
 
-    DriverProperties(String key, String description) {
+    DriverProperties(String key, String defaultValue, List<String> choices) {
         this.key = key;
-        this.description = description;
+        this.defaultValue = defaultValue;
+        this.choices = choices;
     }
 
     public String getKey() {
         return key;
     }
+
+    public String getDefaultValue() {
+        return defaultValue;
+    }
+
+    public List<String> getChoices() {
+        return choices;
+    }
 }