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

Inverted index: Replace setting density with max_rows_in_postings_list #55616

Merged
merged 2 commits into from Oct 17, 2023

Conversation

HarryLeeIBM
Copy link
Contributor

@HarryLeeIBM HarryLeeIBM commented Oct 13, 2023

The current implementation of creating inverted index uses index type inverted(tokenizer, density) in which density controls the size of postings lists for tokens. The original idea was to take the number of rows of the token exceeds the index_granularity * density as a judgement for the token's frequency. We found this setting is confusing to customers, and more importantly this turns out to be problematic since it causes lots of tokens skipping the postings list building and triggering full-scan during queries as a consequence since it is very easy to exceed this value when building posting lists.

The PR introduces a much more straight-forward way in which the second parameter of inverted(tokenizer, max_rows_per_postings_list) controls the maximum number of postings list. The following variants exist:

  • inverted(ngrams, max_rows_per_postings_list): Use given max_rows_per_postings_list (assuming it is not 0)
  • inverted(ngrams, 0): No limitation of maximum rows
  • inverted(ngram): uses a default maximum rows which is 64K.

Changelog category (leave one):

  • Improvement

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

Inverted indexes do not store tokens with too many matches (i.e. row ids in the posting list). This saves space and avoids ineffective index lookups when sequential scans would be equally fast or faster. The previous heuristics (density parameter passed to the index definition) that controlled when tokens would not be stored was too confusing for users. A much simpler heuristics based on parameter max_rows_per_postings_list (default: 64k) is introduced which directly controls the maximum allowed number of row ids in a postings list.

@HarryLeeIBM

This comment was marked as resolved.

@alexey-milovidov alexey-milovidov added the can be tested Allows running workflows for external contributors label Oct 14, 2023
@robot-clickhouse robot-clickhouse added the pr-improvement Pull request with some product improvements label Oct 14, 2023
@robot-clickhouse
Copy link
Member

robot-clickhouse commented Oct 14, 2023

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

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

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
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✅ 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 image for serversThe 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. Integrational 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
Mergeable CheckChecks if all other necessary checks are successful✅ 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
Push to DockerhubThe check for building and pushing the CI related docker images to docker hub✅ success
SQLTestThere's no description for the check yet, please add it to tests/ci/ci_config.py:CHECK_DESCRIPTIONS✅ success
SQLancerFuzzing tests that detect logical bugs with SQLancer tool✅ success
SqllogicRun clickhouse on the sqllogic test set against sqlite and checks that all statements are passed✅ success
Stateful testsRuns stateful functional tests for ClickHouse binaries built in various configurations -- release, debug, with sanitizers, etc✅ success
Stateless testsRuns stateless 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
Check nameDescriptionStatus
Integration testsThe integration tests report. In parenthesis the package type is given, and in square brackets are the optional part/total tests❌ failure

@rschu1ze rschu1ze self-assigned this Oct 16, 2023
@rschu1ze rschu1ze changed the title Replace setting density with max_rows_in postings_list for inverted index Inverted index: Replace setting density with max_rows_in_postings_list Oct 16, 2023
src/Interpreters/GinFilter.h Outdated Show resolved Hide resolved
src/Storages/MergeTree/MergeTreeIndexInverted.cpp Outdated Show resolved Hide resolved
src/Storages/MergeTree/MergeTreeIndexInverted.cpp Outdated Show resolved Hide resolved
src/Storages/MergeTree/MergeTreeIndexInverted.cpp Outdated Show resolved Hide resolved
src/Interpreters/GinFilter.cpp Outdated Show resolved Hide resolved
@rschu1ze rschu1ze merged commit 96a82df into ClickHouse:master Oct 17, 2023
281 of 282 checks passed
@HarryLeeIBM HarryLeeIBM deleted the hlee-fts-max-rows branch October 17, 2023 18:03
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants