Skip to content

Allow to serialize/deserialize JSON column as single String column in Native format#70312

Merged
vdimir merged 11 commits intoClickHouse:masterfrom
Avogar:native-json-as-string
Oct 10, 2024
Merged

Allow to serialize/deserialize JSON column as single String column in Native format#70312
vdimir merged 11 commits intoClickHouse:masterfrom
Avogar:native-json-as-string

Conversation

@Avogar
Copy link
Copy Markdown
Member

@Avogar Avogar commented Oct 3, 2024

Changelog category (leave one):

  • New Feature

Changelog entry (a user-readable short description of the changes that goes to CHANGELOG.md):

Allow to serialize/deserialize JSON column as single String column in Native format. For output use setting output_format_native_write_json_as_string. For input, use serialization version 1 before the column data.

Closes #70281

Documentation entry for user-facing changes

  • Documentation is written (mandatory for new features)

Information about CI checks: https://clickhouse.com/docs/en/development/continuous-integration/

CI Settings (Only check the boxes if you know what you are doing):

  • Allow: All Required Checks
  • Allow: Stateless tests
  • Allow: Stateful tests
  • Allow: Integration Tests
  • Allow: Performance tests
  • Allow: All Builds
  • Allow: batch 1, 2 for multi-batch jobs
  • Allow: batch 3, 4, 5, 6 for multi-batch jobs

  • Exclude: Style check
  • Exclude: Fast test
  • Exclude: All with ASAN
  • Exclude: All with TSAN, MSAN, UBSAN, Coverage
  • Exclude: All with aarch64, release, debug

  • Run only fuzzers related jobs (libFuzzer fuzzers, AST fuzzers, etc.)
  • Exclude: AST fuzzers

  • Do not test
  • Woolen Wolfdog
  • Upload binaries for special builds
  • Disable merge-commit
  • Disable CI cache

@Avogar Avogar mentioned this pull request Oct 3, 2024
56 tasks
@robot-ch-test-poll robot-ch-test-poll added the pr-feature Pull request with new product feature label Oct 3, 2024
@robot-ch-test-poll4
Copy link
Copy Markdown
Contributor

robot-ch-test-poll4 commented Oct 3, 2024

This is an automated comment for commit 82aeaac with description of existing statuses. It's updated for the latest CI running

❌ Click here to open a full report in a separate page

Check nameDescriptionStatus
Stateless testsRuns stateless functional tests for ClickHouse binaries built in various configurations -- release, debug, with sanitizers, etc❌ failure
Successful checks
Check nameDescriptionStatus
AST fuzzerRuns randomly generated queries to catch program errors. The build type is optionally given in parenthesis. If it fails, ask a maintainer for help✅ success
BuildsThere's no description for the check yet, please add it to tests/ci/ci_config.py:CHECK_DESCRIPTIONS✅ success
ClickBenchRuns [ClickBench](https://github.com/ClickHouse/ClickBench/) with instant-attach table✅ success
Compatibility checkChecks that clickhouse binary runs on distributions with old libc versions. If it fails, ask a maintainer for help✅ success
Docker keeper imageThe check to build and optionally push the mentioned image to docker hub✅ success
Docker server imageThe check to build and optionally push the mentioned image to docker hub✅ success
Docs checkBuilds and tests the documentation✅ success
Fast testNormally this is the first check that is ran for a PR. It builds ClickHouse and runs most of stateless functional tests, omitting some. If it fails, further checks are not started until it is fixed. Look at the report to see which tests fail, then reproduce the failure locally as described here✅ success
Flaky testsChecks if new added or modified tests are flaky by running them repeatedly, in parallel, with more randomization. Functional tests are run 100 times with address sanitizer, and additional randomization of thread scheduling. Integration tests are run up to 10 times. If at least once a new test has failed, or was too long, this check will be red. We don't allow flaky tests, read the doc✅ success
Install packagesChecks that the built packages are installable in a clear environment✅ success
Integration testsThe integration tests report. In parenthesis the package type is given, and in square brackets are the optional part/total tests✅ success
Performance ComparisonMeasure changes in query performance. The performance test report is described in detail here. In square brackets are the optional part/total tests✅ success
Stateful testsRuns stateful functional tests for ClickHouse binaries built in various configurations -- release, debug, with sanitizers, etc✅ success
Stress testRuns stateless functional tests concurrently from several clients to detect concurrency-related errors✅ success
Style checkRuns a set of checks to keep the code style clean. If some of tests failed, see the related log from the report✅ success
Unit testsRuns the unit tests for different release types✅ success
Upgrade checkRuns stress tests on server version from last release and then tries to upgrade it to the version from the PR. It checks if the new server can successfully startup without any errors, crashes or sanitizer asserts✅ success

@vdimir vdimir assigned vdimir and unassigned vdimir Oct 3, 2024
M(Bool, input_format_native_allow_types_conversion, true, "Allow data types conversion in Native input format", 0) \
M(Bool, input_format_native_decode_types_in_binary_format, false, "Read data types in binary format instead of type names in Native input format", 0) \
M(Bool, output_format_native_encode_types_in_binary_format, false, "Write data types in binary format instead of type names in Native output format", 0) \
M(Bool, output_format_native_write_json_as_string, false, "Write data of JSON column as String column containing JSON strings", 0) \
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

It may be worth mentioning what we will have by default when setting is disabled. And what is possible drawbacks of using this mode (or why we are keeping two modes)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

We also may add new setting to randomization

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

It may be worth mentioning what we will have by default when setting is disabled

By default we use some complex serialization that is used only internally for inter-server communications via Native protocol, and I believe no-one will support this default serialization. We decided to add the possibility to serialize/deserialize JSON column as String to simplify the integration with clients in other languages so they can support new JSON type in Native format.

So I am not sure what to write here, smth like Write data of JSON column as String column containing JSON strings instead of default native JSON serialization?

We also may add new setting to randomization

Yes, let's do it

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

And what is the advantages of using that complex serialization for inter-server? Can't we switch to simple via string there as well?

Copy link
Copy Markdown
Member Author

@Avogar Avogar Oct 4, 2024

Choose a reason for hiding this comment

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

And what is the advantages of using that complex serialization for inter-server?

It serializes/deserializes the internal representation of JSON column - all typed and dynamic paths are serialized as separate subcolumns in separate streams (which means better compression and fast columnar serialization/deserialization) + has logic of serialization the special shared data column with type Array(Tuple(paths String, values String)) that contains paths and values when the limit on dynamic paths is reached. Basically, almost the same as we serialize JSON column in the MergeTree data parts because it's the same code. So, the serialization and deserialization is much faster then serializing/deserializing the JSON column into/from String representation

@Avogar
Copy link
Copy Markdown
Member Author

Avogar commented Oct 10, 2024

Stateless tests (debug) [2/2] — Server died, fail: 17, passed: 2678, skipped: 43 - #67317

@Avogar Avogar requested a review from vdimir October 10, 2024 02:36
@vdimir vdimir added this pull request to the merge queue Oct 10, 2024
Merged via the queue into ClickHouse:master with commit ca04d37 Oct 10, 2024
@robot-clickhouse robot-clickhouse added the pr-synced-to-cloud The PR is synced to the cloud repo label Oct 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pr-feature Pull request with new product feature pr-synced-to-cloud The PR is synced to the cloud repo

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Support JSON serialization to a string in Native format

5 participants