Skip to content

keywords: add 16 missing non-reserved keywords - #23911

Open
saryn17 wants to merge 3 commits into
pingcap:masterfrom
saryn17:keywords/add-missing-unreserved-keywords
Open

saryn17 wants to merge 3 commits into
pingcap:masterfrom
saryn17:keywords/add-missing-unreserved-keywords

Conversation

@saryn17

@saryn17 saryn17 commented Sep 20, 2026 •

Copy link
Copy Markdown

What is changed, added, or deleted? (Required)

Add the ALERT, ASYNC, AUTO, COMPARE, COMPLETE, DELTA, FAST, IMMEDIATE, MATERIALIZED, OPERATE, OUTPUT, PLACE, RESULT, RETURN, TRANSITIONS, and VIEWS non-reserved keywords to keywords.md so it matches the TiDB master parser. All 16 are alternatives of the UnReservedKeyword rule in pkg/parser/parser.y, and scripts/check-keywords.py passes against the master parser with them added.

This PR first added seven of them. Later runs of the weekly check reported the other nine.

Fixes #24661. This PR also closes #24604, closes #24546, closes #24478, closes #24430, closes #24150, closes #23974, closes #23915, closes #23846, closes #23750, and closes #23670. They are earlier runs of the same weekly check, and each reports a subset of these 16 keywords.

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.

  • master (the latest development version)
  • v9.0 (TiDB 9.0 versions)
  • v8.5 (TiDB 8.5 versions)
  • v8.1 (TiDB 8.1 versions)
  • v7.5 (TiDB 7.5 versions)
  • v7.1 (TiDB 7.1 versions)
  • v6.5 (TiDB 6.5 versions)

None of the 16 keywords is in the release-8.5 parser, and the weekly check reports that branch as passing, so I didn't add a cherry-pick label.

What is the related PR or file link(s)?

AI agent involvement

  • The changes in this PR were primarily made by an AI agent on behalf of the PR author.

Do your changes match any of the following descriptions?

  • Delete files
  • Change aliases
  • Need modification after applied to another branch
  • Might cause conflicts after applied to another branch

Summary by CodeRabbit

  • Documentation
    • Updated the TiDB keyword reference with 16 additional keywords: ALERT, ASYNC, AUTO, COMPARE, COMPLETE, DELTA, FAST, IMMEDIATE, MATERIALIZED, OPERATE, OUTPUT, PLACE, RESULT, RETURN, TRANSITIONS, and VIEWS.
    • Listed the keywords without reserved-word markers.

Add the seven UnReservedKeyword tokens that scripts/check-keywords.py
reports as missing on master: ALERT, AUTO, FAST, IMMEDIATE, MATERIALIZED,
OPERATE, and TRANSITIONS.

Each entry is inserted in its alphabetical position and left unmarked,
since all seven are alternatives of the UnReservedKeyword rule in
pkg/parser/parser.y.
@ti-chi-bot

ti-chi-bot Bot commented Sep 20, 2026

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign breezewish for approval. For more information see the Code Review Process.
Please ensure that each of them provides their approval before proceeding.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@ti-chi-bot ti-chi-bot Bot added contribution This PR is from a community contributor. first-time-contributor Indicates that the PR was contributed by an external member and is a first-time contributor. labels Sep 20, 2026
@ti-chi-bot

ti-chi-bot Bot commented Sep 20, 2026

Copy link
Copy Markdown

Hi @sary8. Thanks for your PR.

I'm waiting for a pingcap member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

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.

@ti-chi-bot ti-chi-bot Bot added needs-ok-to-test Indicates a PR created by contributors and need ORG member send '/ok-to-test' to start testing. missing-translation-status This PR does not have translation status info. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Sep 20, 2026
@coderabbitai

coderabbitai Bot commented Sep 20, 2026 •

Copy link
Copy Markdown

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

keywords.md adds 16 entries to the keyword list. No reserved-word markers are added.

Changes: Keyword documentation

Layer / File(s) Summary
Add keyword entries
keywords.md
Adds ALERT, ASYNC, AUTO, COMPARE, COMPLETE, DELTA, FAST, IMMEDIATE, MATERIALIZED, OPERATE, OUTPUT, PLACE, RESULT, RETURN, TRANSITIONS, and VIEWS to the keyword list without reserved-word markers.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Other · Severity of issue fixed: Low

Possibly related issues

  • pingcap/docs#24546 — Reports missing keywords that this change adds.
  • pingcap/docs#24661 — Reports several missing keywords that this change adds.
  • pingcap/docs#24604 — Reports missing keywords that this change adds.

Suggested reviewers: qiancai

Merge Risk: Minimal · up to 98fc4

This documentation-only change adds missing non-reserved keywords to the keyword list. It has no runtime impact and no actionable merge-blocking risk.

Pre-merge checks: Passed 4

Check name Status Explanation
Title check Passed The title names the main change: adding 16 missing non-reserved keywords to keywords.md. The raw summary confirms the file adds 16 keywords, so the title matches the changeset.
Linked Issues check Passed The reviewed head adds all seven keywords required by [#23846], [#23750], and [#23670]: ALERT, AUTO, FAST, IMMEDIATE, MATERIALIZED, OPERATE, and TRANSITIONS. Each entry is in alphabetical order in key…
Out of Scope Changes check Passed The only changed file is keywords.md, with +16/-0 lines. Nine additions are not named in the PR description or in the linked issues: ASYNC, COMPARE, COMPLETE, DELTA, OUTPUT, PLACE, RESULT, RETURN, and…
Description check Passed The description follows the TiDB documentation template. It fills in the required 'What is changed, added, or deleted?' section with the 16 keywords added to keywords.md, the reason (matching the TiDB…
Full details: Linked Issues check

Explanation

The reviewed head adds all seven keywords required by [#23846], [#23750], and [#23670]: ALERT, AUTO, FAST, IMMEDIATE, MATERIALIZED, OPERATE, and TRANSITIONS. Each entry is in alphabetical order in keywords.md and has no reserved marker. The diff against the merge base confirms each entry. The objectives require no automated test changes; the check is a doc-to-parser comparison. The release-8.5 branch is reported as passing and needs no change. Parser membership of the seven keywords was taken from the linked issue reports and the PR description. I did not inspect pkg/parser/parser.y directly.

Full details: Out of Scope Changes check

Explanation

The only changed file is keywords.md, with +16/-0 lines. Nine additions are not named in the PR description or in the linked issues: ASYNC, COMPARE, COMPLETE, DELTA, OUTPUT, PLACE, RESULT, RETURN, and VIEWS. These come from a later commit. They are the same kind of change as the required seven: a keywords.md entry for the weekly check. The linked issue fix text says to update keywords.md to match the current TiDB parser keywords, which covers them. No source, release-branch, or unrelated documentation change is present. The PR description lists only seven keywords, so the description is out of date with the diff. I did not verify the nine keywords against pkg/parser/parser.y.

Full details: Description check

Explanation

The description follows the TiDB documentation template. It fills in the required 'What is changed, added, or deleted?' section with the 16 keywords added to keywords.md, the reason (matching the TiDB master parser), and the verification (scripts/check-keywords.py passes). It also fills in the required version section by ticking master, explains why no release branch is ticked, and links related code PRs and issues. The AI agent and 'Do your changes match' checkboxes are left unticked, which is acceptable. The first-time contributor checklist is removed or omitted, which the template permits. Only minor gaps remain, such as the 'This PR is translated from' field being left blank, which is non-critical.

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.

Share

Recent review info

Run configuration

  • Source mode: Auto
  • Repository: pingcap/docs
  • Branch: master
  • File: .coderabbit.yaml
  • Commit: 0696463
  • Layers: Repository YAML
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: ad5e15ae-f5f0-46c2-b40a-40b1a34a1cad
Commits

Reviewing files that changed from the base of the PR and between 4f01f16 and 98fc43a.

Files selected for processing: 1

  • keywords.md

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 3 remain after this review.

Add ASYNC, COMPARE, COMPLETE, DELTA, OUTPUT, PLACE, RESULT, RETURN, and
VIEWS. The weekly keyword check now reports these nine UnReservedKeyword
tokens as missing on master, in addition to the seven from the previous
commit.

Each entry is inserted in its alphabetical position without the (R)
marker, since all nine are alternatives of the UnReservedKeyword rule in
pkg/parser/parser.y.
@ti-chi-bot ti-chi-bot Bot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Nov 12, 2026
@saryn17 saryn17 changed the title keywords: add seven missing non-reserved keywords keywords: add 16 missing non-reserved keywords Nov 12, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

contribution This PR is from a community contributor. first-time-contributor Indicates that the PR was contributed by an external member and is a first-time contributor. missing-translation-status This PR does not have translation status info. needs-ok-to-test Indicates a PR created by contributors and need ORG member send '/ok-to-test' to start testing. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.

Projects

None yet

1 participant