Skip to content
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.

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

Allow users to specify a custom range for the range filter when using parallel replicas with dynamic shards #64604

Conversation

josh-hildred
Copy link
Contributor

@josh-hildred josh-hildred commented May 29, 2024

Allow users to specify a custom range for the range filter when using parallel replicas with dynamic shards. This change is particular useful when the custom key expression involves the primary key and relevant values of the primary key are known to be uniformly distributed over some range. For example, if a query is of the form WHERE k >= k1 and k <= k2 and has parallel_replicas_custom_key = 'k' with parallel_replicas_custom_key_filter_type = 'range' by setting parallel_replicas_custom_key_range_lower=k1 and parallel_replicas_custom_key_range_upper=k2, we are able to better parallelize this query over the replicas. This is because when an upper bound k1 and lower bound k2 are provided, we can split processing based on the range [k1, k2] rather than [0, INT_MAX] (I.E the custom key only needs to be uniformly distributed over the range [k1, k2] rather than on [0, INT_MAX]). Furthermore, if k is the primary key we also get better primary index usage leading to less "double loading" data at replicas.

Note: This setting will not cause any additional data to be filtered during query processing, rather it changes the points at which the range filter breaks up the range [0, INT_MAX] when parallelizing the query.

Changelog category (leave one):

  • Improvement

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

Add settings parallel_replicas_custom_key_range_lower and parallel_replicas_custom_key_range_upper to control how parallel replicas with dynamic shards parallelizes queries when using a range filter.

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

NOTE: If your merge the PR with modified CI you MUST KNOW what you are doing
NOTE: Checked options will be applied if set before CI RunConfig/PrepareRunConfig step

  • Allow: Integration Tests
  • Allow: Stateless tests
  • Allow: Stateful tests
  • Allow: Unit tests
  • Allow: Performance tests
  • Allow: All with aarch64
  • Allow: All with ASAN
  • Allow: All with TSAN
  • Allow: All with Analyzer
  • Allow: All with Azure
  • Allow: Add your option here

  • Exclude: Fast test
  • Exclude: Integration Tests
  • Exclude: Stateless tests
  • Exclude: Stateful tests
  • Exclude: Performance tests
  • Exclude: All with ASAN
  • Exclude: All with TSAN
  • Exclude: All with MSAN
  • Exclude: All with UBSAN
  • Exclude: All with Coverage
  • Exclude: All with Aarch64

  • do not test (only style check)
  • disable merge-commit (no merge from master before tests)
  • disable CI cache (job reuse)
  • allow: batch 1 for multi-batch jobs
  • allow: batch 2
  • allow: batch 3
  • allow: batch 4, 5 and 6

@alexey-milovidov alexey-milovidov added the can be tested Allows running workflows for external contributors label May 29, 2024
@robot-ch-test-poll3 robot-ch-test-poll3 added the pr-improvement Pull request with some product improvements label May 29, 2024
@robot-ch-test-poll3
Copy link
Contributor

robot-ch-test-poll3 commented May 29, 2024

This is an automated comment for commit 2129401 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
CI runningA meta-check that indicates the running CI. Normally, it's in success or pending state. The failed status indicates some problems with the PR❌ failure
Performance ComparisonMeasure changes in query performance. The performance test report is described in detail here. In square brackets are the optional part/total tests❌ failure
Stateless testsRuns stateless functional tests for ClickHouse binaries built in various configurations -- release, debug, with sanitizers, etc❌ failure
Stress testRuns stateless functional tests concurrently from several clients to detect concurrency-related errors❌ failure
Successful checks
Check nameDescriptionStatus
A SyncIf it fails, ask a maintainer for help✅ success
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
ClickBenchRuns [ClickBench](https://github.com/ClickHouse/ClickBench/) with instant-attach table✅ success
ClickHouse build checkBuilds ClickHouse in various configurations for use in further steps. You have to fix the builds that fail. Build logs often has enough information to fix the error, but you might have to reproduce the failure locally. The cmake options can be found in the build log, grepping for cmake. Use these options and follow the general build process✅ 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
Mergeable CheckChecks if all other necessary checks are successful✅ success
PR CheckChecks correctness of the PR's body✅ success
Stateful testsRuns stateful functional tests for ClickHouse binaries built in various configurations -- release, debug, with sanitizers, etc✅ 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

@antonio2368 antonio2368 self-assigned this Jun 3, 2024
docs/en/operations/settings/settings.md Show resolved Hide resolved
src/Core/Settings.h Outdated Show resolved Hide resolved
src/Interpreters/getCustomKeyFilterForParallelReplicas.cpp Outdated Show resolved Hide resolved
docs/en/operations/settings/settings.md Outdated Show resolved Hide resolved
src/Core/Settings.h Outdated Show resolved Hide resolved
src/Core/SettingsChangesHistory.h Outdated Show resolved Hide resolved
src/Interpreters/getCustomKeyFilterForParallelReplicas.cpp Outdated Show resolved Hide resolved
@josh-hildred josh-hildred force-pushed the parallel_replicas_custom_key_range_min_max_setting branch from 8162ee4 to b5815ec Compare June 6, 2024 12:25
@josh-hildred josh-hildred force-pushed the parallel_replicas_custom_key_range_min_max_setting branch from b5815ec to 76db904 Compare June 6, 2024 12:28
@antonio2368 antonio2368 added this pull request to the merge queue Jun 7, 2024
@josh-hildred
Copy link
Contributor Author

Thank you for working with me on this one @antonio2368!

Merged via the queue into ClickHouse:master with commit b1d6c73 Jun 7, 2024
240 of 247 checks passed
@antonio2368
Copy link
Member

@josh-hildred thanks for the contribution, please continue pushing good PRs 🙂

@robot-ch-test-poll robot-ch-test-poll added the pr-synced-to-cloud The PR is synced to the cloud repo label Jun 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
can be tested Allows running workflows for external contributors pr-improvement Pull request with some product improvements 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.

5 participants