Merge branch 'main' into issue-2218

Author: Paultagoras

.github/workflows/benchmarks.yml

@@ -0,0 +1,62 @@
+name: Benchmarks
+description: Runs minimal JMH benchmark 
+
+on:
+  schedule:
+    - cron: "55 15 * * *"
+  workflow_dispatch:
+    inputs:
+      pr:
+        description: "Pull request#"
+        required: false
+
+env:
+  CHC_BRANCH: "main"
+  CH_VERSION: "24.8"
+  JAVA_VERSION: 17
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event_name == 'pull_request' && github.event.number || github.sha }}
+  cancel-in-progress: true
+
+jobs:
+  jmh:
+    if: ${{ startsWith(github.repository, 'ClickHouse/') }}
+    name: "Mininal JMH Benchmarks"
+    runs-on: "ubuntu-latest"
+    timeout-minutes: 20
+    steps:
+      - name: Check out Git repository
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ env.CHC_BRANCH }}
+      - 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 and Maven
+        uses: actions/setup-java@v4
+        with:
+          distribution: "temurin"
+          java-version: ${{ env.JAVA_VERSION }}
+          cache: "maven"
+      - name: Build
+        run: mvn --batch-mode --no-transfer-progress -Dj8 -DskipTests=true clean install
+      - name: Prepare Dataset
+        run: |
+          cd ./performance &&
+          mvn --batch-mode --no-transfer-progress clean compile exec:exec -Dexec.executable=java \
+          -Dexec.args="-classpath %classpath com.clickhouse.benchmark.data.DataSetGenerator -input sample_dataset.sql -name default -rows 100000"
+      - name: Run Benchmarks 
+        run: |
+          cd ./performance &&
+          mvn --batch-mode --no-transfer-progress clean compile exec:exec -Dexec.executable=java -Dexec.args="-classpath %classpath com.clickhouse.benchmark.BenchmarkRunner \
+          -l 100000,10000 -m 3 -t 15 -b q,i -d file://default.csv"
+      - name: Upload test results
+        uses: actions/upload-artifact@v4
+        if: success()
+        with:
+          name: result ${{ github.job }}
+          path: |
+            performance/jmh-results*

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

@@ -1,6 +1,7 @@
 package com.clickhouse.jdbc;
 
 import com.clickhouse.client.api.Client;
+import com.clickhouse.client.api.ClientConfigProperties;
 import com.clickhouse.client.api.internal.ServerSettings;
 import com.clickhouse.client.api.query.GenericRecord;
 import com.clickhouse.client.api.query.QuerySettings;
@@ -50,6 +51,7 @@ public class ConnectionImpl implements Connection, JdbcV2Wrapper {
     protected String cluster;
     private String catalog;
     private String schema;
+    private String appName;
     private QuerySettings defaultQuerySettings;
 
     private final com.clickhouse.jdbc.metadata.DatabaseMetaData metadata;
@@ -62,14 +64,27 @@ public ConnectionImpl(String url, Properties info) throws SQLException {
             this.config = new JdbcConfiguration(url, info);
             this.onCluster = false;
             this.cluster = null;
+            this.appName = "";
             String clientName = "ClickHouse JDBC Driver V2/" + Driver.driverVersion;
 
+            Map<String, String> clientProperties = config.getClientProperties();
+            if (clientProperties.get(ClientConfigProperties.CLIENT_NAME.getKey()) != null) {
+                this.appName = clientProperties.get(ClientConfigProperties.CLIENT_NAME.getKey()).trim();
+                clientName = this.appName + " " + clientName; // Use the application name as client name
+            } else if (clientProperties.get(ClientConfigProperties.PRODUCT_NAME.getKey()) != null) {
+                // Backward compatibility for old property
+                this.appName = clientProperties.get(ClientConfigProperties.PRODUCT_NAME.getKey()).trim();
+                clientName = this.appName + " " + clientName; // Use the application name as client name
+            }
+
             if (this.config.isDisableFrameworkDetection()) {
                 log.debug("Framework detection is disabled.");
             } else {
                 String detectedFrameworks = Driver.FrameworksDetection.getFrameworksDetected();
                 log.debug("Detected frameworks: {}", detectedFrameworks);
-                clientName += " (" + detectedFrameworks + ")";
+                if (!detectedFrameworks.trim().isEmpty()) {
+                    clientName += " (" + detectedFrameworks + ")";
+                }
             }
 
             this.client = this.config.applyClientProperties(new Client.Builder())
@@ -441,8 +456,6 @@ public boolean isValid(int timeout) throws SQLException {
         return true;
     }
 
-    private String appName = "";
-
     @Override
     public void setClientInfo(String name, String value) throws SQLClientInfoException {
         if (ClientInfoProperties.APPLICATION_NAME.getKey().equals(name)) {

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

@@ -134,6 +134,8 @@ protected static String parseJdbcEscapeSyntax(String sql) {
         // Handle outer escape syntax
         //sql = sql.replaceAll("\\{escape '([^']*)'\\}", "'$1'");
 
+        // Clean new empty lines in sql
+        sql = sql.replaceAll("(?m)^\\s*$\\n?", "");
         // Add more replacements as needed for other JDBC escape sequences
         LOG.trace("Parsed SQL: {}", sql);
         return sql;

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

@@ -3,6 +3,7 @@
 import com.clickhouse.client.api.Client;
 import com.clickhouse.client.api.ClientConfigProperties;
 import com.clickhouse.jdbc.Driver;
+import com.google.common.collect.ImmutableMap;
 
 import java.net.URI;
 import java.sql.DriverPropertyInfo;
@@ -26,6 +27,9 @@ public class JdbcConfiguration {
     final boolean disableFrameworkDetection;
 
     final Map<String, String> clientProperties;
+    public Map<String, String> getClientProperties() {
+        return ImmutableMap.copyOf(clientProperties);
+    }
 
     private final Map<String, String> driverProperties;
 
@@ -62,6 +66,7 @@ public JdbcConfiguration(String url, Properties info) throws SQLException {
         if (bearerToken != null) {
             clientProperties.put(ClientConfigProperties.BEARERTOKEN_AUTH.getKey(), bearerToken);
         }
+
         this.connectionUrl = createConnectionURL(tmpConnectionUrl, useSSL);
         this.isIgnoreUnsupportedRequests= Boolean.parseBoolean(getDriverProperty(DriverProperties.IGNORE_UNSUPPORTED_VALUES.getKey(), "false"));
     }
@@ -186,9 +191,7 @@ private void initProperties(Map<String, String> urlProperties, Properties provid
             }
         }
 
-        for (Map.Entry<String, String> entry : urlProperties.entrySet()) {
-            props.put(entry.getKey(), entry.getValue());
-        }
+        props.putAll(urlProperties);
 
         // Process all properties
         Map<String, DriverPropertyInfo> propertyInfos = new HashMap<>();

jdbc-v2/src/test/java/com/clickhouse/jdbc/ConnectionTest.java

@@ -282,6 +282,35 @@ public void setAndGetClientInfoTest(String clientName) throws SQLException {
         }
     }
 
+    @Test(groups = { "integration" })
+    public void influenceUserAgentClientNameTest() throws SQLException {
+        String clientName = UUID.randomUUID().toString().replace("-", "");
+        influenceUserAgentTest(clientName, "?" + ClientConfigProperties.CLIENT_NAME.getKey() + "=" + clientName);
+        influenceUserAgentTest(clientName, "?" + ClientConfigProperties.PRODUCT_NAME.getKey() + "=" + clientName);
+    }
+    private void influenceUserAgentTest(String clientName, String urlParam) throws SQLException {
+        Properties info = new Properties();
+        info.setProperty("user", "default");
+        info.setProperty("password", ClickHouseServerForTest.getPassword());
+        info.setProperty(ClientConfigProperties.DATABASE.getKey(), ClickHouseServerForTest.getDatabase());
+
+        try (Connection localConnection = new ConnectionImpl(getEndpointString() + urlParam, info);
+             Statement stmt = localConnection.createStatement()) {
+
+            final String testQuery = "SELECT '" + UUID.randomUUID() + "'";
+            stmt.execute(testQuery);
+            stmt.execute("SYSTEM FLUSH LOGS");
+
+            final String logQuery ="SELECT http_user_agent " +
+                    " FROM system.query_log WHERE query = '" + testQuery.replaceAll("'", "\\\\'") + "'";
+            try (ResultSet rs = stmt.executeQuery(logQuery)) {
+                Assert.assertTrue(rs.next());
+                String userAgent = rs.getString("http_user_agent");
+                Assert.assertTrue(userAgent.startsWith(clientName), "Expected to start with '" + clientName + "' but value was '" + userAgent + "'");
+            }
+        }
+    }
+
     @DataProvider(name = "setAndGetClientInfoTestDataProvider")
     public static Object[][] setAndGetClientInfoTestDataProvider() {
         return new Object[][] {

jdbc-v2/src/test/java/com/clickhouse/jdbc/StatementTest.java

@@ -573,7 +573,73 @@ public void testSwitchDatabase() throws Exception {
             }
         }
     }
+  
+  
+    @Test(groups = { "integration" })
+    public void testNewLineSQLParsing() throws Exception {
+        try (Connection conn = getJdbcConnection()) {
+            String sqlCreate = "CREATE TABLE balance ( `id` UUID, `currency` String, `amount` Decimal(64, 18), `create_time` DateTime64(6), `_version` UInt64, `_sign` UInt8 ) ENGINE = ReplacingMergeTree PRIMARY KEY id ORDER BY id;";
+            try (Statement stmt = conn.createStatement()) {
+                int r = stmt.executeUpdate(sqlCreate);
+                assertEquals(r, 0);
+            }
+            try (Statement stmt = conn.createStatement()) {
+                String sqlInsert = "INSERT INTO balance VALUES (generateUUIDv4(), 'EUR', '42.42', now(), 144, 255);";
+                int r = stmt.executeUpdate(sqlInsert);
+                assertEquals(r, 1);
+            }
+            try (Statement stmt = conn.createStatement()) {
+                String sqlSelect = new StringBuilder("-- SELECT amount FROM balance FINAL;\n")
+                        .append("SELECT amount FROM balance FINAL;").toString();
+                ResultSet rs = stmt.executeQuery(sqlSelect);
+                assertTrue(rs.next());
+            }
+            try (Statement stmt = conn.createStatement()) {
+                String sqlSelect = new StringBuilder("-- SELECT * FROM balance\n")
+                        .append("\n")
+                        .append("WITH balance_cte AS (\n")
+                        .append("SELECT\n")
+                        .append("id, currency, amount\n")
+                        .append("FROM balance\n")
+                        .append("LIMIT 10\n")
+                        .append(")\n")
+                        .append("SELECT * FROM balance_cte;").toString();
+                ResultSet rs = stmt.executeQuery(sqlSelect);
+                assertTrue(rs.next());
+                assertFalse(rs.next());
+            }
+            try (Statement stmt = conn.createStatement()) {
+                String sqlSelect = new StringBuilder("-- SELECT amount FROM balance FINAL;\n")
+                        .append("\n")
+                        .append("SELECT amount FROM balance FINAL;").toString();
+                ResultSet rs = stmt.executeQuery(sqlSelect);
+                assertTrue(rs.next());
+            }
+            try (Statement stmt = conn.createStatement()) {
+                String sqlSelect = new StringBuilder("-- SELECT amount FROM balance FINAL;\n")
+                        .append("\n")
+                        .append("SELECT amount /* test */FROM balance FINAL;").toString();
+                ResultSet rs = stmt.executeQuery(sqlSelect);
+                assertTrue(rs.next());
+            }
+            try (Statement stmt = conn.createStatement()) {
+                String sqlSelect = new StringBuilder("-- SELECT amount FROM balance FINAL;\n")
+                        .append("\n")
+                        .append("SELECT amount FROM balance FINAL; /* test */").toString();
+                ResultSet rs = stmt.executeQuery(sqlSelect);
+                assertTrue(rs.next());
+            }
+            try (Statement stmt = conn.createStatement()) {
+                String sqlSelect = new StringBuilder("-- SELECT amount FROM balance FINAL;\n")
+                        .append("\n")
+                        .append("SELECT amount FROM balance FINAL; /* test */ -- SELECT 1").toString();
+                ResultSet rs = stmt.executeQuery(sqlSelect);
+                assertTrue(rs.next());
+            }
+        }
+    }
 
+    
     @Test(groups = { "integration" })
     public void testNullableFixedStringType() throws Exception {
         try (Connection conn = getJdbcConnection()) {

performance/README.md

@@ -1,16 +1,46 @@
 
+## JMH Benchmarks
 
-## DataSetGenerator 
+
+### Dependencies 
+
+
+
+### How to Run
+
+
+#### Generating Dataset
 
 ```shell
- mvn exec:java -Dscope=test -Dexec.mainClass="com.clickhouse.benchmark.data.ClickHouseDataTypesShort" -input <table_fields.sql> -rows <number_of_rows>
+mvn compile exec:exec -Dexec.executable=java -Dexec.args="-classpath %classpath com.clickhouse.benchmark.data.DataSetGenerator \
+-input sample_dataset.sql -name default -rows 10"
 ```
 
+#### Running Benchmarks 
+ 
+With default settings :
+```shell
+mvn compile exec:exec
+```
 
-## Performance Test
-
-with custom dataset
+With custom measurement iterations: 
 ```shell
-mvn test-compile exec:java -Dexec.classpathScope=test -Dexec.mainClass="com.clickhouse.benchmark.BenchmarkRunner" -Dexec.args="--dataset=file://dataset_1741150759025.csv"
+mvn compile exec:exec -Dexec.executable=java -Dexec.args="-classpath %classpath com.clickhouse.benchmark.BenchmarkRunner -m 3"
 ```
 
+Other options:
+- "-d" - dataset name or file path (like `file://default.csv`)
+- "-l" - dataset limits to test coma separated (ex.: `-l 10000,10000`)
+- "-m" - number of measurement iterations
+- "-t" - time in seconds per iteration
+- "-b" - benchmark mask coma separated. Ex.: `-b writer,reader,i`. Default : `-b i,q`
+  - "all" - Run alpl benchmarks
+  - "i" - InsertClient - insert operation benchmarks
+  - "q" - QueryClient - query operation benchmarks
+  - "ci" - ConcurrentInsertClient - concurrent version of insert benchmarks
+  - "cq" - ConcurrentQueryClient - concurrent version of query benchmarks
+  - "lz" - Compression - compression related benchmarks
+  - "writer" - Serializer - serialization only logic benchmarks
+  - "reader" - DeSerilalizer - deserialization only logic benchmarks
+  - "mixed" - MixedWorkload 
+