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
Conversation
This file contains 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
This comment was marked as resolved.
This comment was marked as resolved.
alexey-milovidov
added
the
can be tested
Allows running workflows for external contributors
label
Oct 14, 2023
robot-clickhouse
added
the
pr-improvement
Pull request with some product improvements
label
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
|
rschu1ze
changed the title
Replace setting density with max_rows_in postings_list for inverted index
Inverted index: Replace setting density with Oct 16, 2023
max_rows_in_postings_list
rschu1ze
reviewed
Oct 16, 2023
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
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.
The current implementation of creating inverted index uses index type
inverted(tokenizer, density)
in whichdensity
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 givenmax_rows_per_postings_list
(assuming it is not 0)inverted(ngrams, 0)
: No limitation of maximum rowsinverted(ngram)
: uses a default maximum rows which is 64K.Changelog category (leave one):
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 parametermax_rows_per_postings_list
(default: 64k) is introduced which directly controls the maximum allowed number of row ids in a postings list.