[JDBC] NetworkTimeout #2522
Draft
[JDBC] NetworkTimeout #2522
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Client V2 CoverageCoverage Report
Class Coverage
|
JDBC V2 CoverageCoverage Report
Class Coverage
|
JDBC V1 CoverageCoverage Report
Class Coverage
|
|
Client V1 CoverageCoverage Report
Class Coverage
|
There was a problem hiding this comment.
Pull Request Overview
This PR implements JDBC network timeout functionality by adding support for Connection#abort and Connection#setNetworkTimeout methods. The implementation includes timeout detection, connection abortion logic, and proper propagation of socket timeout exceptions throughout the JDBC stack.
- Implements
Connection#abortto properly close connections using an executor - Implements
Connection#setNetworkTimeoutwith timeout caching and connection closure on timeout - Adds network timeout detection and handling across statement execution classes
Reviewed Changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| ConnectionTest.java | Updates tests to verify abort and network timeout functionality instead of expecting unsupported feature exceptions |
| JdbcUtils.java | Adds utility method for safe resource cleanup with logging |
| WriterStatementImpl.java | Adds socket timeout detection and connection notification in write operations |
| StatementImpl.java | Adds socket timeout detection and connection notification in query execution |
| ResultSetImpl.java | Adds socket timeout detection and connection notification in result set iteration |
| ConnectionImpl.java | Implements abort and network timeout methods with proper executor handling |
| QuerySettings.java | Adds network timeout getter/setter methods for query configuration |
| InsertSettings.java | Adds network timeout methods and merge functionality for insert operations |
Comments suppressed due to low confidence (2)
jdbc-v2/src/main/java/com/clickhouse/jdbc/ConnectionImpl.java:272
- Converting Long to intValue() can cause data loss if the timeout value exceeds Integer.MAX_VALUE. Consider using the Long value directly or adding validation.
return TRANSACTION_NONE;
jdbc-v2/src/main/java/com/clickhouse/jdbc/ConnectionImpl.java:282
- Converting Long to intValue() can cause data loss if the timeout value exceeds Integer.MAX_VALUE. Consider using the Long value directly or adding validation.
public void clearWarnings() throws SQLException {
| // Some connection pools set timeout before calling Connection#close() to ensure that this operation will not hang | ||
| // Socket timeout is propagated with QuerySettings this connection has. | ||
| networkTimeoutExecutor = executor; | ||
| defaultQuerySettings.setOption(ClientConfigProperties.SOCKET_OPERATION_TIMEOUT.getKey(), (long)milliseconds); |
There was a problem hiding this comment.
The cast to (long)milliseconds is inconsistent with the getNetworkTimeout() method which converts back to intValue(). Consider using consistent data types throughout.
Suggested change
| defaultQuerySettings.setOption(ClientConfigProperties.SOCKET_OPERATION_TIMEOUT.getKey(), (long)milliseconds); | |
| defaultQuerySettings.setOption(ClientConfigProperties.SOCKET_OPERATION_TIMEOUT.getKey(), Integer.valueOf(milliseconds)); |
Copilot uses AI. Check for mistakes.
Comment on lines
+622
to
+623
| // Proxy method for child objects. Do not call. | ||
| public void onNetworkTimeout() throws SQLException { |
There was a problem hiding this comment.
The comment 'Do not call' is unclear and potentially confusing. Consider explaining when and how this method should be used, or make it package-private if it's only for internal use.
Suggested change
| // Proxy method for child objects. Do not call. | |
| public void onNetworkTimeout() throws SQLException { | |
| /** | |
| * Proxy method for use by child objects within the package to handle network timeouts. | |
| */ | |
| void onNetworkTimeout() throws SQLException { |
Copilot uses AI. Check for mistakes.
mzitnik
reviewed
Aug 10, 2025
| } | ||
|
|
||
| public Long getNetworkTimeout() { | ||
| return (Long) rawSettings.get(ClientConfigProperties.SOCKET_OPERATION_TIMEOUT.getKey()); |
There was a problem hiding this comment.
Those methods are never used. Do you have any plans to add tests?
| // Some connection pools set timeout before calling Connection#close() to ensure that this operation will not hang | ||
| // Socket timeout is propagated with QuerySettings this connection has. | ||
| networkTimeoutExecutor = executor; | ||
| defaultQuerySettings.setOption(ClientConfigProperties.SOCKET_OPERATION_TIMEOUT.getKey(), (long)milliseconds); |
There was a problem hiding this comment.
Why not use the new method setNetworkTimeout
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Connection#abortConnection#setNetworkTimeoutand logic that caches timeout exception and closes a connectionCloses #2413
Checklist
Delete items not relevant to your PR: