Repository navigation
tiflash: document the TIFLASH_LM_FILTER optimizer hint - #24547
windtalker wants to merge 2 commits into
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
|
No actionable comments were generated in the recent review.
|
| Layer / File(s) | Summary |
|---|---|
Hint syntax and behavior optimizer-hints.md, tiflash/tiflash-late-materialization.md |
Documents how the hint selects filters by referenced columns, affects cost-based selection, and handles prerequisites, limitations, and unmatched parameters. Includes usage examples and EXPLAIN guidance. |
Priority:
Estimated code review effort: 1 (Trivial) | ~5 minutes
Change: Other
Suggested reviewers: qiancai
Merge Risk: 
Minimal · up to 184b3
-
The documentation-only change is mergeable pending normal documentation checks.
Pre-merge checks: 
5
-
Full details: Description check
-
Explanation
The description explains the documentation changes, affected TiDB version, related PRs and issue, AI involvement, validation results, and version-specific considerations. The required sections are present and sufficiently complete.
Full details: Docstring Coverage
-
Explanation
No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (2 skipped: 2 unsupported.)
-
Finishing Touches
-
🧪 Generate unit tests (beta)
-
- Create a new PR
-
- Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
Comment @coderabbitai help to get the list of available commands.
|
@qw4990: adding LGTM is restricted to approvers and reviewers in OWNERS files. DetailsIn response to this: Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
What is changed, added, or deleted? (Required)
Document the
TIFLASH_LM_FILTERoptimizer hint so users can choose which TiFlash filter conditions participate in late materialization. Add syntax, query-block forms, column-matching rules, prerequisites, limitations, and usage examples that show how to verify the filter split withEXPLAIN.The source code PR is still open and has no release milestone. An HTML TODO marks the introduction version for confirmation before merging.
Validation:
git diff --checkpassed.Which TiDB version(s) do your changes apply to? (Required)
Tips for choosing the affected version(s):
By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.
For details, see tips for choosing the affected versions.
What is the related PR or file link(s)?
AI agent involvement
Do your changes match any of the following descriptions?
Summary by CodeRabbit
TIFLASH_LM_FILTERoptimizer hint, including how to select filters by referenced columns and what happens to conditions that do not match.EXPLAIN.