[client-v2] Adding JSON support with predefined paths #2531
+173
−7
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
|
…imports and undeprecated ClickHouseUtils as we use it
|
mshustov
reviewed
Aug 14, 2025
| public static final String JSON_MAX_DYN_TYPES_PARAM = "max_dynamic_types"; | ||
| public static final String JSON_SKIP_MARKER = "SKIP"; | ||
|
|
||
| public static void parseJSONColumn(String args, List<ClickHouseColumn> nestedColumns, List<String> parameters) { |
Member
There was a problem hiding this comment.
Doesn't it deserve a dedicated set of tests?
Contributor
Author
There was a problem hiding this comment.
This part is tested via integration tests. I think no need to duplicate same in unit.
While testing I'm checking coverage to make sure integration tests validate the code.
There was a problem hiding this comment.
Pull Request Overview
This PR adds JSON support with predefined paths for client-v2, enabling proper handling of JSON columns where path types are encoded for RowBinary format instead of Dynamic format when predefined paths are specified.
- Adds JSON column parsing logic to handle predefined paths and parameters in column definitions
- Updates binary format reader to use predefined column types when reading JSON data
- Adds comprehensive test coverage for various JSON column definition formats
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| clickhouse-data/src/main/java/com/clickhouse/data/ClickHouseColumn.java | Implements JSON column parsing with predefined paths and parameters support |
| client-v2/src/main/java/com/clickhouse/client/api/data_formats/internal/BinaryStreamReader.java | Updates JSON data reading to use predefined column types from schema |
| clickhouse-data/src/test/java/com/clickhouse/data/ClickHouseColumnTest.java | Adds unit tests for JSON column parsing validation |
| client-v2/src/test/java/com/clickhouse/client/datatypes/DataTypeTests.java | Adds integration tests for JSON binary format reading |
| jdbc-v2/src/test/java/com/clickhouse/jdbc/DataTypeTests.java | Adds JDBC integration test for JSON binary reading |
| clickhouse-data/src/main/java/com/clickhouse/data/ClickHouseUtils.java | Removes deprecated annotation from utility class |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
client-v2/src/main/java/com/clickhouse/client/api/data_formats/internal/BinaryStreamReader.java
Show resolved
Hide resolved
| nestedColumns.sort(Comparator.comparing(o -> o.getDataType().name())); | ||
| column = new ClickHouseColumn(ClickHouseDataType.JSON, name, originalTypeName, nullable, lowCardinality, | ||
| parameters, nestedColumns); | ||
| column.jsonPredefinedPaths = nestedColumns.stream().collect(Collectors.toMap(ClickHouseColumn::getColumnName, |
There was a problem hiding this comment.
[nitpick] The line continuation should be properly aligned. The lambda parameter c -> c on the next line should be aligned with the method call parameters.
Suggested change
| column.jsonPredefinedPaths = nestedColumns.stream().collect(Collectors.toMap(ClickHouseColumn::getColumnName, | |
| column.jsonPredefinedPaths = nestedColumns.stream().collect(Collectors.toMap( | |
| ClickHouseColumn::getColumnName, |
mshustov
approved these changes
Aug 18, 2025
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
Closes #2462
Checklist
Delete items not relevant to your PR: