Skip to content

Add support to clickhouse JDBC V2 #10280

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
eddumelendez merged 4 commits into from
May 29, 2025
Merged

Add support to clickhouse JDBC V2 #10280

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c713cd6
#10279 Add Support to new ClickHouse JDBC Driver V2
thiagohora May 28, 2025
6fc39f2
#10279 Add support to clickhouse JDBC V2
thiagohora May 28, 2025
39d1faa
Adress PR review comments
thiagohora May 28, 2025
42ff691
Apply suggestions from code review
eddumelendez May 29, 2025
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 docs/modules/databases/r2dbc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ So that the URL becomes:

#### Using ClickHouse

`r2dbc:tc:clickhouse:///databasename?TC_IMAGE_TAG=21.9.2-alpine`
`r2dbc:tc:clickhouse:///databasename?TC_IMAGE_TAG=21.11.11-alpine`

#### Using MySQL

Expand Down
8 changes: 5 additions & 3 deletions modules/clickhouse/build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,14 @@ dependencies {
api project(':jdbc')

compileOnly project(':r2dbc')
compileOnly(group: 'com.clickhouse', name: 'clickhouse-r2dbc', version: '0.7.0', classifier: 'http')
compileOnly(group: 'com.clickhouse', name: 'clickhouse-r2dbc', version: '0.7.2', classifier: 'http')

testImplementation project(':jdbc-test')
testRuntimeOnly(group: 'com.clickhouse', name: 'clickhouse-jdbc', version: '0.7.0', classifier: 'http')
testRuntimeOnly(group: 'com.clickhouse', name: 'clickhouse-jdbc', version: '0.7.2', classifier: 'http')
testRuntimeOnly(group: 'com.clickhouse', name: 'jdbc-v2', version: '0.7.2', classifier: 'http')

testImplementation 'org.apache.httpcomponents.client5:httpclient5:5.4.2'
testImplementation 'org.assertj:assertj-core:3.26.3'
testImplementation testFixtures(project(':r2dbc'))
testRuntimeOnly(group: 'com.clickhouse', name: 'clickhouse-r2dbc', version: '0.7.0', classifier: 'http')
testRuntimeOnly(group: 'com.clickhouse', name: 'clickhouse-r2dbc', version: '0.7.2', classifier: 'http')
}
20 changes: 18 additions & 2 deletions modules/clickhouse/src/main/java/org/testcontainers/clickhouse/ClickHouseContainer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,9 @@ public class ClickHouseContainer extends JdbcDatabaseContainer<ClickHouseContain

static final Integer NATIVE_PORT = 9000;

private static final String DRIVER_CLASS_NAME = "com.clickhouse.jdbc.ClickHouseDriver";
private static final String LEGACY_V1_RIVER_CLASS_NAME = "com.clickhouse.jdbc.ClickHouseDriver";

private static final String DRIVER_CLASS_NAME = "com.clickhouse.jdbc.Driver";

private static final String JDBC_URL_PREFIX = "jdbc:clickhouse://";

Expand Down Expand Up @@ -78,7 +80,21 @@ public Set<Integer> getLivenessCheckPortNumbers() {

@Override
public String getDriverClassName() {
return DRIVER_CLASS_NAME;

if (isClassLoaded(DRIVER_CLASS_NAME)) {
return DRIVER_CLASS_NAME;
} else {
return LEGACY_V1_RIVER_CLASS_NAME;
}
}

public static boolean isClassLoaded(String driverClassName) {
try {
Class.forName(driverClassName);
return true;
} catch (ClassNotFoundException e) {
return false;
}
}

@Override
Expand Down
26 changes: 17 additions & 9 deletions modules/clickhouse/src/main/java/org/testcontainers/containers/ClickHouseContainer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,9 @@ public class ClickHouseContainer extends JdbcDatabaseContainer<ClickHouseContain

private static final String LEGACY_DRIVER_CLASS_NAME = "ru.yandex.clickhouse.ClickHouseDriver";

private static final String DRIVER_CLASS_NAME = "com.clickhouse.jdbc.ClickHouseDriver";
private static final String LEGACY_V1_DRIVER_CLASS_NAME = "com.clickhouse.jdbc.ClickHouseDriver";

private static final String DRIVER_CLASS_NAME = "com.clickhouse.jdbc.Driver";

private static final String JDBC_URL_PREFIX = "jdbc:" + NAME + "://";

Expand Down Expand Up @@ -79,15 +81,21 @@ public Set<Integer> getLivenessCheckPortNumbers() {

@Override
public String getDriverClassName() {
if (supportsNewDriver && isClassLoaded(DRIVER_CLASS_NAME)) {
return DRIVER_CLASS_NAME;
} else if (isClassLoaded(LEGACY_V1_DRIVER_CLASS_NAME)) {
return LEGACY_V1_DRIVER_CLASS_NAME;
} else {
return LEGACY_DRIVER_CLASS_NAME;
}
}

public static boolean isClassLoaded(String driverClassName) {
try {
if (supportsNewDriver) {
Class.forName(DRIVER_CLASS_NAME);
return DRIVER_CLASS_NAME;
} else {
return LEGACY_DRIVER_CLASS_NAME;
}
Class.forName(driverClassName);
return true;
} catch (ClassNotFoundException e) {
return LEGACY_DRIVER_CLASS_NAME;
return false;
}
}

Expand All @@ -98,7 +106,7 @@ private static boolean isNewDriverSupported(DockerImageName dockerImageName) {

@Override
public String getJdbcUrl() {
return JDBC_URL_PREFIX + getHost() + ":" + getMappedPort(HTTP_PORT) + "/" + databaseName;
return JDBC_URL_PREFIX + getHost() + ":" + getMappedPort(HTTP_PORT) + "/" + databaseName + constructUrlParameters("?", "&");
}

@Override
Expand Down
2 changes: 1 addition & 1 deletion modules/clickhouse/src/test/java/org/testcontainers/ClickhouseTestImages.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
import org.testcontainers.utility.DockerImageName;

public interface ClickhouseTestImages {
DockerImageName CLICKHOUSE_IMAGE = DockerImageName.parse("clickhouse/clickhouse-server:21.9.2-alpine");
DockerImageName CLICKHOUSE_IMAGE = DockerImageName.parse("clickhouse/clickhouse-server:21.11.11-alpine");

DockerImageName CLICKHOUSE_24_12_IMAGE = DockerImageName.parse("clickhouse/clickhouse-server:24.12-alpine");
}
7 changes: 4 additions & 3 deletions modules/clickhouse/src/test/java/org/testcontainers/clickhouse/ClickHouseContainerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ public class ClickHouseContainerTest extends AbstractContainerDatabaseTest {

@Test
public void testSimple() throws SQLException {
try (ClickHouseContainer clickhouse = new ClickHouseContainer("clickhouse/clickhouse-server:21.9.2-alpine")) {
try (ClickHouseContainer clickhouse = new ClickHouseContainer("clickhouse/clickhouse-server:21.11-alpine")) {
clickhouse.start();

ResultSet resultSet = performQuery(clickhouse, "SELECT 1");
Expand All @@ -26,11 +26,12 @@ public void testSimple() throws SQLException {
@Test
public void customCredentialsWithUrlParams() throws SQLException {
try (
ClickHouseContainer clickhouse = new ClickHouseContainer("clickhouse/clickhouse-server:21.9.2-alpine")
ClickHouseContainer clickhouse = new ClickHouseContainer("clickhouse/clickhouse-server:21.11.2-alpine")
.withUsername("default")
.withPassword("")
.withDatabaseName("test")
.withUrlParam("max_result_rows", "5")
// The new driver uses the prefix `clickhouse_setting_` for session settings
.withUrlParam("clickhouse_setting_max_result_rows", "5")
) {
clickhouse.start();

Expand Down
4 changes: 2 additions & 2 deletions ...use/src/test/java/org/testcontainers/clickhouse/ClickHouseR2DBCDatabaseContainerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ protected ConnectionFactoryOptions getOptions(ClickHouseContainer container) {

@Override
protected String createR2DBCUrl() {
return "r2dbc:tc:clickhouse:///db?TC_IMAGE_TAG=21.9.2-alpine";
return "r2dbc:tc:clickhouse:///db?TC_IMAGE_TAG=21.11.11-alpine";
}

@Override
protected ClickHouseContainer createContainer() {
return new ClickHouseContainer("clickhouse/clickhouse-server:21.9.2-alpine");
return new ClickHouseContainer("clickhouse/clickhouse-server:21.11.11-alpine");
}
}