Merge pull request #2235 from markgrex/mg/schema-with-params

Support getting table schema from a query with params

Author: chernser

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

@@ -1865,7 +1865,7 @@ public TableSchema getTableSchema(String table) {
      */
     public TableSchema getTableSchema(String table, String database) {
         final String sql = "DESCRIBE TABLE " + table + " FORMAT " + ClickHouseFormat.TSKV.name();
-        return getTableSchemaImpl(sql, table, null, database);
+        return getTableSchemaImpl(sql, table, null, database, null);
     }
 
     /**
@@ -1874,16 +1874,22 @@ public TableSchema getTableSchema(String table, String database) {
      * @return table schema for the query
      */
     public TableSchema getTableSchemaFromQuery(String sql) {
+        return getTableSchemaFromQuery(sql, null);
+    }
+
+    public TableSchema getTableSchemaFromQuery(String sql, Map<String, Object> params) {
         final String describeQuery = "DESC (" + sql + ") FORMAT " + ClickHouseFormat.TSKV.name();
-        return getTableSchemaImpl(describeQuery, null, sql, getDefaultDatabase());
+        return getTableSchemaImpl(describeQuery, null, sql, getDefaultDatabase(), params);
     }
 
-    private TableSchema getTableSchemaImpl(String describeQuery, String name, String originalQuery, String database) {
+    private TableSchema getTableSchemaImpl(
+            String describeQuery, String name, String originalQuery, String database, Map<String, Object> queryParams) {
         int operationTimeout = getOperationTimeout();
 
         QuerySettings settings = new QuerySettings().setDatabase(database);
-        try (QueryResponse response = operationTimeout == 0 ? query(describeQuery, settings).get() :
-                query(describeQuery, settings).get(getOperationTimeout(), TimeUnit.SECONDS)) {
+        try (QueryResponse response = operationTimeout == 0
+                ? query(describeQuery, queryParams, settings).get()
+                : query(describeQuery, queryParams, settings).get(getOperationTimeout(), TimeUnit.SECONDS)) {
             return TableSchemaParser.readTSKV(response.getInputStream(), name, originalQuery, database);
         } catch (TimeoutException e) {
             throw new ClientException("Operation has likely timed out after " + getOperationTimeout() + " seconds.", e);

client-v2/src/test/java/com/clickhouse/client/query/QueryTests.java

@@ -1632,7 +1632,7 @@ public void testGetTableSchemaError() {
     }
 
     @Test(groups = {"integration"})
-    public void testGetTableSchemaFromQuery() throws Exception {
+    public void testGetTableSchemaFromQuery() {
         TableSchema schema = client.getTableSchemaFromQuery("SELECT toUInt32(1) as col1, 'value' as col2");
         Assert.assertNotNull(schema);
         Assert.assertEquals(schema.getColumns().size(), 2);
@@ -1642,6 +1642,20 @@ public void testGetTableSchemaFromQuery() throws Exception {
         Assert.assertEquals(schema.getColumns().get(1).getDataType(), ClickHouseDataType.String);
     }
 
+    @Test(groups = {"integration"})
+    public void testGetTableSchemaFromQueryWithParams() {
+        Map<String, Object> queryParams = new HashMap<>();
+        queryParams.put("param1", 2);
+        TableSchema schema = client.getTableSchemaFromQuery("SELECT toUInt32(1) as col1, {param1:String} as col2",
+                queryParams);
+        Assert.assertNotNull(schema);
+        Assert.assertEquals(schema.getColumns().size(), 2);
+        Assert.assertEquals(schema.getColumns().get(0).getColumnName(), "col1");
+        Assert.assertEquals(schema.getColumns().get(0).getDataType(), ClickHouseDataType.UInt32);
+        Assert.assertEquals(schema.getColumns().get(1).getColumnName(), "col2");
+        Assert.assertEquals(schema.getColumns().get(1).getDataType(), ClickHouseDataType.String);
+    }
+
     @Test(groups = {"integration"})
     public void testServerTimeZoneFromHeader() {