Skip to content

[client-v2] Abstract transport layer #2893

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

Open
chernser wants to merge 6 commits into
base: main
Choose a base branch
from
Open

[client-v2] Abstract transport layer #2893

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
7b2d5c1
separated request creation and execution
chernser Jun 24, 2026
70217f5
Merge branch 'main' into 06/22/26/extract_request_logic
chernser Jun 24, 2026
54cc9c6
Merge branch 'main' into 06/22/26/extract_request_logic
chernser Jun 25, 2026
fd444b0
Added more tests and removed dead code halding 503 in client
chernser Jun 26, 2026
47a4965
Added cancelation tests
chernser Jun 26, 2026
e1018a7
Merge branch 'main' into 06/22/26/extract_request_logic
chernser Jun 26, 2026
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
149 changes: 58 additions & 91 deletions client-v2/src/main/java/com/clickhouse/client/api/Client.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
import com.clickhouse.client.api.insert.InsertResponse;
import com.clickhouse.client.api.insert.InsertSettings;
import com.clickhouse.client.api.internal.ClientStatisticsHolder;
import com.clickhouse.client.api.internal.ClientUtils;
import com.clickhouse.client.api.internal.CredentialsManager;
import com.clickhouse.client.api.internal.HttpAPIClientHelper;
import com.clickhouse.client.api.internal.MapUtils;
Expand All @@ -37,16 +38,15 @@
import com.clickhouse.client.api.serde.POJOSerDe;
import com.clickhouse.client.api.transport.Endpoint;
import com.clickhouse.client.api.transport.HttpEndpoint;
import com.clickhouse.client.api.transport.internal.TransportRequest;
import com.clickhouse.client.api.transport.internal.TransportResponse;
import com.clickhouse.client.config.ClickHouseClientOption;
import com.clickhouse.data.ClickHouseColumn;
import com.clickhouse.data.ClickHouseDataType;
import com.clickhouse.data.ClickHouseFormat;
import com.google.common.collect.ImmutableList;
import net.jpountz.lz4.LZ4Factory;
import org.apache.hc.core5.concurrent.DefaultThreadFactory;
import org.apache.hc.core5.http.ClassicHttpResponse;
import org.apache.hc.core5.http.Header;
import org.apache.hc.core5.http.HttpStatus;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

Expand Down Expand Up @@ -1378,43 +1378,30 @@ public CompletableFuture<InsertResponse> insert(String tableName, List<?> data,
RuntimeException lastException = null;
for (int i = 0; i <= maxRetries; i++) {
// Execute request
try (ClassicHttpResponse httpResponse =
httpClientHelper.executeRequest(selectedEndpoint, requestSettings.getAllSettings(),
out -> {
out.write("INSERT INTO ".getBytes());
out.write(tableName.getBytes());
out.write(" \n FORMAT ".getBytes());
out.write(format.name().getBytes());
out.write(" \n".getBytes());
for (Object obj : data) {

for (POJOFieldSerializer serializer : serializersForTable) {
try {
serializer.serialize(obj, out);
} catch (InvocationTargetException | IllegalAccessException | IOException e) {
throw new DataSerializationException(obj, serializer, e);
}
}
TransportRequest transportRequest = httpClientHelper.createRequest(selectedEndpoint, requestSettings.getAllSettings(),
out -> {
out.write("INSERT INTO ".getBytes());
out.write(tableName.getBytes());
out.write(" \n FORMAT ".getBytes());
out.write(format.name().getBytes());
out.write(" \n".getBytes());
for (Object obj : data) {

for (POJOFieldSerializer serializer : serializersForTable) {
try {
serializer.serialize(obj, out);
} catch (InvocationTargetException | IllegalAccessException | IOException e) {
throw new DataSerializationException(obj, serializer, e);
}
out.close();
})) {


// Check response
if (httpResponse.getCode() == HttpStatus.SC_SERVICE_UNAVAILABLE) {
LOG.warn("Failed to get response. Server returned {}. Retrying. (Duration: {})", httpResponse.getCode(), durationSince(startTime));
selectedEndpoint = getNextAliveNode();
continue;
}

}
}
out.close();
});
try (TransportResponse transportResponse = httpClientHelper.executeRequest(transportRequest)) {
ClientStatisticsHolder clientStats = globalClientStats.remove(operationId);
OperationMetrics metrics = new OperationMetrics(clientStats);
String summary = HttpAPIClientHelper.getHeaderVal(httpResponse.getFirstHeader(ClickHouseHttpProto.HEADER_SRV_SUMMARY), "{}");
ProcessParser.parseSummary(summary, metrics);
String queryId = HttpAPIClientHelper.getHeaderVal(httpResponse.getFirstHeader(ClickHouseHttpProto.HEADER_QUERY_ID), requestSettings.getQueryId(), String::valueOf);
metrics.operationComplete();
metrics.setQueryId(queryId);
return new InsertResponse(metrics, HttpAPIClientHelper.collectResponseHeaders(httpResponse));
OperationMetrics metrics = completeOperation(transportResponse, clientStats, requestSettings.getQueryId());

return new InsertResponse(transportResponse, metrics);
} catch (Exception e) {
String msg = requestExMsg("Insert", (i + 1), durationSince(startTime).toMillis(), requestSettings.getQueryId());
lastException = httpClientHelper.wrapException(msg, e, requestSettings.getQueryId());
Expand All @@ -1429,10 +1416,10 @@ public CompletableFuture<InsertResponse> insert(String tableName, List<?> data,

String errMsg = requestExMsg("Insert", retries, durationSince(startTime).toMillis(), requestSettings.getQueryId());
LOG.warn(errMsg);
throw (lastException == null ? new ClientException(errMsg) : lastException); };
throw (lastException == null ? new ClientException(errMsg) : lastException);
};

return runAsyncOperation(supplier, requestSettings.getAllSettings());

}

/**
Expand Down Expand Up @@ -1568,7 +1555,7 @@ public CompletableFuture<InsertResponse> insert(String tableName,
clientStats.start(ClientMetrics.OP_DURATION);
final ClientStatisticsHolder finalClientStats = clientStats;

Supplier<InsertResponse> responseSupplier;


final int writeBufferSize = requestSettings.getInputStreamCopyBufferSize() <= 0 ?
(int) configuration.get(ClientConfigProperties.CLIENT_NETWORK_BUFFER_SIZE.getKey()) :
Expand All @@ -1592,36 +1579,24 @@ public CompletableFuture<InsertResponse> insert(String tableName,
if (requestSettings.getQueryId() == null && queryIdGenerator != null) {
requestSettings.setQueryId(queryIdGenerator.get());
}
responseSupplier = () -> {

Supplier<InsertResponse> responseSupplier = () -> {
long startTime = System.nanoTime();
// Selecting some node
Endpoint selectedEndpoint = getNextAliveNode();

RuntimeException lastException = null;
for (int i = 0; i <= retries; i++) {
// Execute request
try (ClassicHttpResponse httpResponse =
httpClientHelper.executeRequest(selectedEndpoint, requestSettings.getAllSettings(),
out -> {
writer.onOutput(out);
out.close();
})) {


// Check response
if (httpResponse.getCode() == HttpStatus.SC_SERVICE_UNAVAILABLE) {
LOG.warn("Failed to get response. Server returned {}. Retrying. (Duration: {})", httpResponse.getCode(), durationSince(startTime));
selectedEndpoint = getNextAliveNode();
continue;
}

OperationMetrics metrics = new OperationMetrics(finalClientStats);
String summary = HttpAPIClientHelper.getHeaderVal(httpResponse.getFirstHeader(ClickHouseHttpProto.HEADER_SRV_SUMMARY), "{}");
ProcessParser.parseSummary(summary, metrics);
String queryId = HttpAPIClientHelper.getHeaderVal(httpResponse.getFirstHeader(ClickHouseHttpProto.HEADER_QUERY_ID), requestSettings.getQueryId(), String::valueOf);
metrics.operationComplete();
metrics.setQueryId(queryId);
return new InsertResponse(metrics, HttpAPIClientHelper.collectResponseHeaders(httpResponse));
TransportRequest transportRequest = httpClientHelper.createRequest(selectedEndpoint, requestSettings.getAllSettings(),
out -> {
writer.onOutput(out);
out.close();
});

try (TransportResponse transportResponse = httpClientHelper.executeRequest(transportRequest)) {
OperationMetrics metrics = completeOperation(transportResponse, finalClientStats, requestSettings.getQueryId());
return new InsertResponse(transportResponse, metrics);
} catch (Exception e) {
String msg = requestExMsg("Insert", (i + 1), durationSince(startTime).toMillis(), requestSettings.getQueryId());
lastException = httpClientHelper.wrapException(msg, e, requestSettings.getQueryId());
Expand Down Expand Up @@ -1728,38 +1703,20 @@ public CompletableFuture<QueryResponse> query(String sqlQuery, Map<String, Objec
Endpoint selectedEndpoint = getNextAliveNode();
RuntimeException lastException = null;
for (int i = 0; i <= retries; i++) {
ClassicHttpResponse httpResponse = null;
TransportRequest request = httpClientHelper.createRequest(selectedEndpoint, requestSettings.getAllSettings(), sqlQuery);
TransportResponse transportResp = null;
try {
httpResponse = httpClientHelper.executeRequest(selectedEndpoint,
requestSettings.getAllSettings(),
sqlQuery);
// Check response
if (httpResponse.getCode() == HttpStatus.SC_SERVICE_UNAVAILABLE) {
LOG.warn("Failed to get response. Server returned {}. Retrying. (Duration: {})", httpResponse.getCode(), durationSince(startTime));
selectedEndpoint = getNextAliveNode();
HttpAPIClientHelper.closeQuietly(httpResponse);
continue;
}

OperationMetrics metrics = new OperationMetrics(clientStats);
String summary = HttpAPIClientHelper.getHeaderVal(httpResponse
.getFirstHeader(ClickHouseHttpProto.HEADER_SRV_SUMMARY), "{}");
ProcessParser.parseSummary(summary, metrics);
String queryId = HttpAPIClientHelper.getHeaderVal(httpResponse
.getFirstHeader(ClickHouseHttpProto.HEADER_QUERY_ID), requestSettings.getQueryId());
metrics.setQueryId(queryId);
metrics.operationComplete();
Header formatHeader = httpResponse.getFirstHeader(ClickHouseHttpProto.HEADER_FORMAT);
ClickHouseFormat responseFormat = requestSettings.getFormat();
if (formatHeader != null) {
responseFormat = ClickHouseFormat.valueOf(formatHeader.getValue());
transportResp = httpClientHelper.executeRequest(request);
OperationMetrics metrics = completeOperation(transportResp, clientStats, requestSettings.getQueryId());
ClickHouseFormat responseFormat = transportResp.getDataFormat();
if (responseFormat == null) {
responseFormat = requestSettings.getFormat();
}

return new QueryResponse(httpResponse, responseFormat, requestSettings, metrics,
HttpAPIClientHelper.collectResponseHeaders(httpResponse));
return new QueryResponse(transportResp, responseFormat, requestSettings, metrics);

} catch (Exception e) {
HttpAPIClientHelper.closeQuietly(httpResponse);
ClientUtils.quiteClose(transportResp, LOG);

@cursor cursor Bot Jun 27, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Plain HTTP 503 no retry

Medium Severity

After the transport refactor, query and insert retry loops no longer treat HTTP 503 as retryable on their own. A 503 is turned into a ServerException with unknown ClickHouse code, shouldRetry returns false, and the client fails instead of picking another node like before.

Additional Locations (2)
Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit e1018a7. Configure here.

String msg = requestExMsg("Query", (i + 1), durationSince(startTime).toMillis(), requestSettings.getQueryId());
lastException = httpClientHelper.wrapException(msg, e, requestSettings.getQueryId());
if (httpClientHelper.shouldRetry(e, requestSettings.getAllSettings())) {
Expand All @@ -1781,6 +1738,16 @@ public CompletableFuture<QueryResponse> query(String sqlQuery, Map<String, Objec
return query(sqlQuery, queryParams, null);
}

private OperationMetrics completeOperation(TransportResponse transportResponse, ClientStatisticsHolder clientStats, String originalQueryId) {
OperationMetrics metrics = new OperationMetrics(clientStats);
String summary = transportResponse.getSummaryJson();
ProcessParser.parseSummary(summary, metrics);
String queryId = transportResponse.getQueryId();
metrics.setQueryId(queryId == null ? originalQueryId : queryId);
metrics.operationComplete();
return metrics;
}

/**
* <p>Queries data in one of descriptive format and creates a reader out of the response stream.</p>
* <p>Format is selected internally so is ignored when passed in settings. If query contains format
Expand Down
10 changes: 3 additions & 7 deletions client-v2/src/main/java/com/clickhouse/client/api/insert/InsertResponse.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,17 @@
import com.clickhouse.client.api.http.ClickHouseHttpProto;
import com.clickhouse.client.api.metrics.OperationMetrics;
import com.clickhouse.client.api.metrics.ServerMetrics;
import com.clickhouse.client.api.transport.internal.TransportResponse;

import java.util.Collections;
import java.util.Map;

public class InsertResponse implements AutoCloseable {
private OperationMetrics operationMetrics;
private final Map<String, String> responseHeaders;

public InsertResponse(OperationMetrics metrics) {
this(metrics, Collections.emptyMap());
}

public InsertResponse(OperationMetrics metrics, Map<String, String> responseHeaders) {
public InsertResponse(TransportResponse transportResponse, OperationMetrics metrics) {
this.operationMetrics = metrics;
this.responseHeaders = responseHeaders;
this.responseHeaders = transportResponse.getHeaders();
}

@Override
Expand Down
15 changes: 15 additions & 0 deletions client-v2/src/main/java/com/clickhouse/client/api/internal/ClientUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
package com.clickhouse.client.api.internal;

import org.slf4j.Logger;

import java.io.Closeable;
import java.io.IOException;

Check warning on line 6 in client-v2/src/main/java/com/clickhouse/client/api/internal/ClientUtils.java

View check run for this annotation

SonarQubeCloud / SonarCloud Code Analysis

Remove this unused import 'java.io.IOException'. 


See more on https://sonarcloud.io/project/issues?id=ClickHouse_clickhouse-java&issues=AZ778qSCY1I2F-bSCCX8&open=AZ778qSCY1I2F-bSCCX8&pullRequest=2893

/**
* Class containing utility methods used across the client.
*/
Expand All @@ -14,4 +19,14 @@
public static boolean isBlank(String str) {
return str == null || str.trim().isEmpty();
}

public static void quiteClose(Closeable closeable, Logger log) {
if (closeable != null) {
try {
closeable.close();
} catch (Exception e) {
log.warn("Failed to close object " + closeable, e);
}
}
}
}
Loading
Loading