Skip to content

fix SplitTokenExtractor::nextInStringLike skipping tokens#72264

Closed
ozcelgozde wants to merge 5 commits intoClickHouse:masterfrom
ozcelgozde:gozde/fix_SplitTokenExtractor
Closed

fix SplitTokenExtractor::nextInStringLike skipping tokens#72264
ozcelgozde wants to merge 5 commits intoClickHouse:masterfrom
ozcelgozde:gozde/fix_SplitTokenExtractor

Conversation

@ozcelgozde
Copy link
Copy Markdown

@ozcelgozde ozcelgozde commented Nov 22, 2024

We are using a lot of like searches with tokenbf index and I was noticing the performance was really bad. After looking through the code and also seeing a few more issues opened here, I noticed SplitTokenExtractor::nextInStringLike skips some crucial tokens. For example if i do a search like this: body like '%test%', test as a token is completely skipped and this becomes a full db scan. Also other issues: 72065 and 68985. Not sure how to proceed from here so some feedback would be appreciated.

Changelog category (leave one):

  • Bug Fix (user-visible misbehavior in an official stable release)

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

Refactored token extraction logic to ensure valid tokens are not prematurely reset by wildcards (% or _)

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

@CLAassistant
Copy link
Copy Markdown

CLAassistant commented Nov 22, 2024

CLA assistant check
All committers have signed the CLA.

@robot-clickhouse robot-clickhouse added the pr-bugfix Pull request with bugfix, not backported by default label Nov 22, 2024
@nikitamikhaylov nikitamikhaylov added the can be tested Allows running workflows for external contributors label Dec 19, 2024
@robot-clickhouse-ci-1
Copy link
Copy Markdown
Contributor

robot-clickhouse-ci-1 commented Dec 19, 2024

This is an automated comment for commit 2864374 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
Bugfix validationChecks that either a new test (functional or integration) or there some changed tests that fail with the binary built on master branch❌ failure
Integration testsThe integration tests report. In parenthesis the package type is given, and in square brackets are the optional part/total tests❌ 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
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
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

@nikitamikhaylov
Copy link
Copy Markdown
Member

nikitamikhaylov commented Dec 19, 2024

@ozcelgozde A test would be very appreciated. But also these extractors available as functions and I don't see a problem here:

» clickhouse
ClickHouse local version 25.1.1.1.

:) select tokens('%test%')

SELECT tokens('%test%')

Query id: 4586894c-9bd4-4748-b312-a4b35a0522d0

   ┌─tokens('%test%')─┐
1. │ ['test']         │
   └──────────────────┘

1 row in set. Elapsed: 0.002 sec.

And the tests have failed...

@ozcelgozde
Copy link
Copy Markdown
Author

ozcelgozde commented Dec 27, 2024

@nikitamikhaylov hey thanks for the reply. This case only happens during bloom filter (tokenbf_v1) index calculation so regular tokens function is not hitting that. I see the tests related to that areas are failing so I will take a look at them.
First failing test is inserting strings like:

hhhhhhhhhhhhhhhhhhhhhhhhhxxxxxxxxxxxxxxxxxxxxxxxxxxxxyyyyyyyyyyyyyyyyyyyyyyyyyy1342957354
hhhhhhhhhhhhhhhhhhhhhhhhhxxxxxxxxxxxxxxxxxxxxxxxxxxxxyyyyyyyyyyyyyyyyyyyyyyyyyy3487425490

then tries to do token search with like '%x%' but since tokens('hhhhhhhhhhhhhhhhhhhhhhhhhxxxxxxxxxxxxxxxxxxxxxxxxxxxxyyyyyyyyyyyyyyyyyyyyyyyyyy1342957354
') does not divide this long string and its a single token, then

SELECT COUNT() FROM indexed_table WHERE log_message like '%x%';

this not returning any value is valid wdyt?

Before this PR this statement:

like '%x%'

was skipping x as a token thats why tests were returning all 1000 values

@alexey-milovidov
Copy link
Copy Markdown
Member

@ozcelgozde Check the tests.

@alexey-milovidov alexey-milovidov self-assigned this Jan 2, 2025
@clickhouse-gh
Copy link
Copy Markdown
Contributor

clickhouse-gh bot commented Feb 4, 2025

Dear @alexey-milovidov, this PR hasn't been updated for a while. You will be unassigned. Will you continue working on it? If so, please feel free to reassign yourself.

@EmeraldShift
Copy link
Copy Markdown
Contributor

SELECT COUNT() FROM indexed_table WHERE log_message like '%x%'; 

this not returning any value is valid wdyt?

This sounds invalid to me. LIKE is a substring search, not a token search, so I would expect 'axe' LIKE '%x%' to return 1. If the skip index were used to filter only granules with a standalone x token, it would incorrectly skip granules containing x as part of a larger token.

In your original example, a search LIKE '%test%' matches a value like the tests are passing, but restricting only to granules containing token test would skip it incorrectly.

Recently I think there is a new function hasToken that should more accurately map to the queries it sounds like you're expecting.

@alexey-milovidov
Copy link
Copy Markdown
Member

@EmeraldShift, yes, exactly! And we introduced these new functions recently.

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-bugfix Pull request with bugfix, not backported by default

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants