Skip to content

Add docs about tidb_columnar_storage_enabled - #21910

Open
JaySon-Huang wants to merge 1 commit into
masterfrom
jayson/add_columnar_storage_enabled
Open

Add docs about tidb_columnar_storage_enabled#21910
JaySon-Huang wants to merge 1 commit into
masterfrom
jayson/add_columnar_storage_enabled

Conversation

@JaySon-Huang

@JaySon-Huang JaySon-Huang commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

First-time contributors' checklist

What is changed, added or deleted? (Required)

Add a new global variable tidb_columnar_storage_enabled that is introduced by pingcap/tidb#70524

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 (in Chinese).

  • 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)

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

  • 文档
    • 新增 tidb_columnar_storage_enabled 系统变量说明,涵盖默认值、引入版本及对 TiFlash/列存相关 DDL 的影响。
    • 补充系统变量索引及相关参考链接。
    • 更新 TiFlash 副本构建指南,说明变量关闭时的操作限制,以及清理副本操作仍可执行。

Signed-off-by: JaySon-Huang <tshent@qq.com>
@ti-chi-bot

ti-chi-bot Bot commented Sep 1, 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 lilin90 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 missing-translation-status This PR does not have translation status info. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Sep 1, 2026
@coderabbitai

coderabbitai Bot commented Sep 1, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

Changes

列存存储开关文档

Layer / File(s) Summary
系统变量说明与使用指引
system-variables.md, system-variable-reference.md, tiflash/create-tiflash-replicas.md
新增 tidb_columnar_storage_enabled 的属性、默认值和控制规则。补充该变量对 TiFlash 副本相关 DDL 的限制,以及 SET TIFLASH REPLICA 0 始终可用的说明。

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

Merge Risk: 🔵 Low · up to 7920a

The documentation may imply that this setting applies to all storage architectures and that tenants can change it directly, which could lead to incorrect configuration guidance. The PR is otherwise mergeable with explicit owner follow-up to clarify applicability and TiDB X permissions.

Suggested reviewers: qiancai, ti-chi-bot, lilin90, oreoxmt

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description check ✅ Passed PR 描述包含模板要求的主要部分,说明了变更内容、适用版本、相关 Issue、AI 参与情况及其他变更类型。内容与文档变更目标一致,但“Add a new global variable”应更准确地表述为“Add documentation for the new global variable”。
Title check ✅ Passed 标题简洁明确,准确概括了为 tidb_columnar_storage_enabled 添加文档这一主要变更。
Docstring Coverage ✅ Passed 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…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
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. (3 skipped: 3 unsupported.)

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch jayson/add_columnar_storage_enabled

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

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2


ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Team

Run ID: 73d5b5fd-02fa-4453-a3f3-c639c00db783

📥 Commits

Reviewing files that changed from the base of the PR and between abe71f2 and 7920a33.

📒 Files selected for processing (3)
  • system-variable-reference.md
  • system-variables.md
  • tiflash/create-tiflash-replicas.md

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

Comment thread system-variables.md
Comment on lines +1582 to +1584
- 作用域:GLOBAL
- 是否持久化到集群:是
- 是否受 Hint [SET_VAR](/optimizer-hints.md#set_varvar_namevar_value) 控制:否

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🗄️ Data Integrity & Integration | 🟡 Minor | ⚡ Quick win

说明 TiDB X 中的设置入口和权限。

当前内容只说明变量可以使用 GLOBAL 作用域持久化。TiDB X 中该变量由控制面设置,租户不应直接执行 SET GLOBAL 修改。请补充这一限制,并区分自建集群的权限行为。 (github.com)

可直接提交的替换文本
 - 作用域:GLOBAL
 - 是否持久化到集群:是
 - 是否受 Hint [SET_VAR](/optimizer-hints.md#set_varvar_namevar_value) 控制:否
+ - 在 TiDB X 中,该变量由控制面设置,租户不应直接执行 `SET GLOBAL` 修改;自建集群可按权限修改。

As per path instructions:对 **/*.md 文件,能够安全替换连续行时必须提供精确的可提交替换文本。

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- 作用域:GLOBAL
- 是否持久化到集群:是
- 是否受 Hint [SET_VAR](/optimizer-hints.md#set_varvar_namevar_value) 控制:否
- 作用域:GLOBAL
- 是否持久化到集群:是
- 是否受 Hint [SET_VAR](/optimizer-hints.md#set_varvar_namevar_value) 控制:否
- 在 TiDB X 中,该变量由控制面设置,租户不应直接执行 `SET GLOBAL` 修改;自建集群可按权限修改。

Sources: Path instructions, MCP tools

Comment thread system-variables.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

missing-translation-status This PR does not have translation status info. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant