Skip to content

fixed default jdbc driver client name #2793

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chernser merged 1 commit into from
Mar 18, 2026
+36 −16
Merged

fixed default jdbc driver client name #2793

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion jdbc-v2/src/main/java/com/clickhouse/jdbc/ConnectionImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ public ConnectionImpl(String url, Properties info) throws SQLException {
this.appName = "";
this.readOnly = false;
this.holdability = ResultSet.HOLD_CURSORS_OVER_COMMIT;
String clientName = "ClickHouse JDBC Driver V2/" + Driver.getLibraryVersion();
String clientName = Driver.DRIVER_CLIENT_NAME + Driver.getLibraryVersion();

Map<String, String> clientProperties = config.getClientProperties();
if (clientProperties.get(ClientConfigProperties.CLIENT_NAME.getKey()) != null) {
Expand Down
50 changes: 35 additions & 15 deletions jdbc-v2/src/test/java/com/clickhouse/jdbc/ConnectionTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -306,33 +306,53 @@ public void isValidTest() throws SQLException {
}

@Test(groups = { "integration" }, dataProvider = "setAndGetClientInfoTestDataProvider")
public void setAndGetClientInfoTest(String clientName) throws SQLException {
public void setAndGetClientInfoTest(String clientName) throws Exception {
final String unsupportedProperty = "custom-unsupported-property";

// case when set via config
Properties clientNameConfig = new Properties();
if (clientName != null) {
clientNameConfig.setProperty(ClientConfigProperties.CLIENT_NAME.getKey(), clientName);
}
try (Connection localConnection = this.getJdbcConnection(clientNameConfig);
Statement stmt = localConnection.createStatement()) {

executeQueryAndVerifyUserAgent(stmt, clientName);
}

// case when set in runtime
try (Connection localConnection = this.getJdbcConnection();
Statement stmt = localConnection.createStatement()) {

executeQueryAndVerifyUserAgent(stmt, ""); // default value

localConnection.setClientInfo(unsupportedProperty, "i-am-unsupported-property");
Assert.assertNull(localConnection.getClientInfo("custom-property"));
localConnection.setClientInfo(ClientInfoProperties.APPLICATION_NAME.getKey(), clientName);
Assert.assertEquals(localConnection.getClientInfo(ClientInfoProperties.APPLICATION_NAME.getKey()), clientName);
Assert.assertNull(localConnection.getClientInfo(unsupportedProperty));

final String testQuery = "SELECT '" + UUID.randomUUID() + "'";
stmt.execute(testQuery);
String queryId = ((StatementImpl)stmt).getLastQueryId();
stmt.getResultSet().close(); // close result set to finalize request.
stmt.execute("SYSTEM FLUSH LOGS");
executeQueryAndVerifyUserAgent(stmt, clientName);
}
}

private void executeQueryAndVerifyUserAgent(Statement stmt, String clientName) throws Exception {
final String testQuery = "SELECT '" + UUID.randomUUID() + "'";
stmt.execute(testQuery);
String queryId = ((StatementImpl)stmt).getLastQueryId();
stmt.getResultSet().close(); // close result set to finalize request.
stmt.execute("SYSTEM FLUSH LOGS");

final String logQuery ="SELECT http_user_agent FROM clusterAllReplicas('default', system.query_log) WHERE query_id = " + stmt.enquoteLiteral(queryId);
try (ResultSet rs = stmt.executeQuery(logQuery)) {
Assert.assertTrue(rs.next());
String userAgent = rs.getString("http_user_agent");
if (clientName != null && !clientName.isEmpty()) {
Assert.assertTrue(userAgent.startsWith(clientName), "Expected to start with '" + clientName + "' but value was '" + userAgent + "'");
}
Assert.assertTrue(userAgent.contains(Client.CLIENT_USER_AGENT), "Expected to contain '" + Client.CLIENT_USER_AGENT + "' but value was '" + userAgent + "'");
Assert.assertTrue(userAgent.contains(Driver.DRIVER_CLIENT_NAME), "Expected to contain '" + Driver.DRIVER_CLIENT_NAME + "' but value was '" + userAgent + "'");

final String logQuery ="SELECT http_user_agent FROM clusterAllReplicas('default', system.query_log) WHERE query_id = " + stmt.enquoteLiteral(queryId);
try (ResultSet rs = stmt.executeQuery(logQuery)) {
Assert.assertTrue(rs.next());
String userAgent = rs.getString("http_user_agent");
if (clientName != null && !clientName.isEmpty()) {
Assert.assertTrue(userAgent.startsWith(clientName), "Expected to start with '" + clientName + "' but value was '" + userAgent + "'");
}
Assert.assertTrue(userAgent.contains(Client.CLIENT_USER_AGENT), "Expected to contain '" + Client.CLIENT_USER_AGENT + "' but value was '" + userAgent + "'");
Assert.assertTrue(userAgent.contains(Driver.DRIVER_CLIENT_NAME), "Expected to contain '" + Driver.DRIVER_CLIENT_NAME + "' but value was '" + userAgent + "'");
}
}

Expand Down
Loading