Skip to content

slow-query: document prewrite and commit backoff type columns - #21967

Draft
jiong-nba wants to merge 4 commits into
pingcap:masterfrom
jiong-nba:translate/codex/slow-query-backoff-types-docs
Draft

jiong-nba wants to merge 4 commits into
pingcap:masterfrom
jiong-nba:translate/codex/slow-query-backoff-types-docs

Conversation

@jiong-nba

@jiong-nba jiong-nba commented Oct 8, 2026 •

Copy link
Copy Markdown

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

Document Prewrite_Backoff_types and Commit_Backoff_types from TiDB #70833 in the system-table reference and slow-query examples. The existing Backoff_types column reads only the original log field, preserving its value (including empty strings and []); it returns '' when that field is absent. The raw slow log format is unchanged, and direct-file tools need separate support for phase fields.

Describe phase coverage, missing values, bracketed list format and duplicates. Coprocessor types remain in Backoff_Detail. New columns are appended after Query; SELECT * changes shape, and new-column cluster queries require all queried nodes to support the schema during rolling upgrades.

Draft dependency: merge after pingcap/tidb#70833. The first released version and release-branch backports remain unconfirmed; master only. English and Chinese use the same rules, column order and SQL examples.

Validation: targeted Markdown lint and internal links passed. English and Chinese changes were checked for matching field behavior, column order, and SQL examples. A real local PD/TiKV v8.5.7 cluster with TiDB 067c50bd46 (before this feature) and 97a61122cc verified both reader directions, explicit old/new projections and SELECT *. SQL/Go model/CSV and Python JSON/CSV/SQLite TEXT preserved 1452/1332-character phase values. Dashboard phase integration is tracked in pingcap/tidb-dashboard#1950; representative API and ui-v2 detail fixtures were verified. Other historical schema combinations, deployed raw-file pipelines and production throughput remain unverified.

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

@jiong-nba jiong-nba added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. translation/from-docs This PR is translated from a PR in pingcap/docs. labels Oct 8, 2026
@ti-chi-bot

ti-chi-bot Bot commented Oct 8, 2026

Copy link
Copy Markdown

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@ti-chi-bot ti-chi-bot Bot added the first-time-contributor Indicates that the PR was contributed by an external member and is a first-time contributor. label Oct 8, 2026
@ti-chi-bot

ti-chi-bot Bot commented Oct 8, 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 overvenus 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

@coderabbitai

coderabbitai Bot commented Oct 8, 2026 •

Copy link
Copy Markdown
Contributor

Important

Draft PR not reviewed

Draft PRs are not automatically reviewed by default.

  • Trigger a manual review

To automatically review draft PRs, update your CodeRabbit configuration:

reviews:
  auto_review:
    drafts: true
  • 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

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

@ti-chi-bot ti-chi-bot Bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Oct 8, 2026
TiDB #70833 收敛为仅新增 PREWRITE_BACKOFF_TYPES 与 COMMIT_BACKOFF_TYPES
两列;撤销 COP_BACKOFF_TYPES。相应移除该列的表结构输出、列说明与
按 cop 类型筛选的示例,改为按事务 backoff 类型筛选的示例,并说明
coprocessor 阶段类型仍可通过 Backoff_Detail 查看。
@jiong-nba

Copy link
Copy Markdown
Author

对齐 pingcap/tidb#70833 的 L1 范围:仅新增 PREWRITE_BACKOFF_TYPES 与 COMMIT_BACKOFF_TYPES,撤销 COP_BACKOFF_TYPES。本次修订从表结构输出与列说明中移除该列,将按 cop 类型筛选的示例改为按事务 backoff 类型筛选,并说明 coprocessor 阶段类型仍可通过 Backoff_Detail 查看。

Signed-off-by: jiong-nba <jiongnba@gmail.com>
@jiong-nba jiong-nba changed the title slow-query: document phase-specific backoff type columns slow-query: document phase types and historical summary fallback Oct 9, 2026
Signed-off-by: jiong-nba <jiongnba@gmail.com>
@jiong-nba jiong-nba changed the title slow-query: document phase types and historical summary fallback slow-query: document prewrite and commit backoff type columns Oct 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. first-time-contributor Indicates that the PR was contributed by an external member and is a first-time contributor. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. translation/from-docs This PR is translated from a PR in pingcap/docs.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant