distribute-table: support to scatter the region distribution of the given table and engine #19534

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Merged

ti-chi-bot merged 32 commits into pingcap:master from bufferflies:distribute_table

Sep 8, 2025

Contributor

bufferflies commented Jan 13, 2025 •

edited

Loading

First-time contributors' checklist

I've signed Contributor License Agreement that's required for repo owners to accept my contribution.

What is changed, added or deleted? (Required)

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

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

This PR is translated from:
Other reference link(s):

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


          add distribute table fd

ca62ac6

Signed-off-by: 童剑 <[email protected]>

ti-chi-bot bot added missing-translation-status size/M labels

qiancai requested a review from niubell

January 13, 2025 08:48

qiancai self-assigned this

qiancai added v9.0-beta.1 translation/doing labels

ti-chi-bot bot removed the missing-translation-status label

qiancai reviewed

View reviewed changes

sql-statements/sql_statement_distribute_table.md Outdated

    
            @@ -0,0 +1,84 @@
          
              ---

              title: distribute table 使用文档

              aliases: ['/docs-cn/dev/sql-statements/sql-statement-distribute-table/','/docs-cn/dev/reference/sql/statements/distribute-table/']

Collaborator

qiancai Jan 26, 2025 •

edited

Loading

新增文档不需要 aliases

Suggested change

      
            aliases: ['/docs-cn/dev/sql-statements/sql-statement-distribute-table/','/docs-cn/dev/reference/sql/statements/distribute-table/']

Contributor Author

bufferflies Feb 6, 2025

done

qiancai reviewed

View reviewed changes

sql-statements/sql_statement_distribute_table.md Outdated

    
              summary: TiDB 中的 distribute table 功能可以解决表中 region 分布不均衡问题。通过重新调整 table 中的 region 的分布，可以让指定 table 下的 region 按照一定的策略进行均衡。重新分配可以指定不同的存储引擎，比如 TIFLASH 和 TIKV。同时也可以指定不同的 raft role，比如 learner，leader，voter。

              ---

              # Distribute Table 使用文档

Collaborator

qiancai Jan 26, 2025

Suggested change

      
            # Distribute Table 使用文档
          
            # DISTRIBUTE TABLE

Contributor Author

bufferflies Feb 6, 2025

done

qiancai reviewed

View reviewed changes

sql-statements/sql_statement_distribute_table.md Outdated Show resolved Hide resolved

qiancai reviewed

View reviewed changes

sql-statements/sql_statement_distribute_table.md Outdated

    
              +---------+------------+----------------+----------+------------+-------------------+--------------------+-----------------+------------------+

              ### Distribute Table Region

Collaborator

qiancai Jan 26, 2025

“### Distribute Table Region” 里面目前没有内容，请看看是需要删除还是添加

Contributor Author

bufferflies Feb 6, 2025

删除了


          address comment

a4fc306

Signed-off-by: 童剑 <[email protected]>

qiancai reviewed

View reviewed changes

sql-statements/sql_statement_distribute_table.md Outdated

Comment on lines 2 to 7

    
              title: distribute table 使用文档

              summary: TiDB 中的 distribute table 功能可以解决表中 region 分布不均衡问题。通过重新调整 table 中的 region 的分布，可以让指定 table 下的 region 按照一定的策略进行均衡。重新分配可以指定不同的存储引擎，比如 TIFLASH 和 TIKV。同时也可以指定不同的 raft role，比如 learner，leader，voter。

              ---

              # DISTRIBUTE TABLE 使用文档

              `DISTRIBUTE TABLE` 用于对指定表范围内的 region 进行重新打散调度， 使其按照表纬度进行均衡分布，防止个别 region 集中在少数的 TIFLASH 和 TIKV。

Collaborator

qiancai Feb 6, 2025

Suggested change

      
            title: distribute table 使用文档
          
            summary: TiDB 中的 distribute table 功能可以解决表中 region 分布不均衡问题。通过重新调整 table 中的 region 的分布，可以让指定 table 下的 region 按照一定的策略进行均衡。重新分配可以指定不同的存储引擎，比如 TIFLASH 和 TIKV。同时也可以指定不同的 raft role，比如 learner，leader，voter。
          
            ---
          
            # DISTRIBUTE TABLE 使用文档
          
            `DISTRIBUTE TABLE` 用于对指定表范围内的 region 进行重新打散调度， 使其按照表纬度进行均衡分布，防止个别 region 集中在少数的 TIFLASH 和 TIKV。
          
            title: DISTRIBUTE TABLE
          
            summary: 介绍 TiDB 数据库中 DISTRIBUTE TABLE 的使用概况。
          
            ---
          
            # DISTRIBUTE TABLE
          
            `DISTRIBUTE TABLE` 语句用于对指定表的 Region 进行重新打散和调度，以实现表维度的均衡分布。执行该语句可以防止个别 Region 集中在少数 TiFlash 或 TiKV 节点上，从而解决表中 Region 分布不均衡的问题。

Collaborator

qiancai Feb 6, 2025

summary 里的内容不会显示到文档正文中，只是用于搜索引擎检索和显示

sql-statements/sql_statement_distribute_table.md Outdated

    
              ## 示例

              对表A 上的 tikv 上的 leader 重新进行均衡调度

Collaborator

qiancai Feb 6, 2025

Suggested change

      
            对表A 上的 tikv 上的 leader 重新进行均衡调度
          
            通过 `DISTRIBUTE TABLE` 语句重新调度表中的 Region 时，你可以根据需求指定存储引擎（如 TiFlash 或 TiKV）以及不同的 Raft 角色（如 learner、leader、voter）。
          
            对表 `t1` 在 TiKV 上的 leader 所在的 Region 重新进行均衡调度：

sql-statements/sql_statement_distribute_table.md Outdated Show resolved Hide resolved

sql-statements/sql_statement_distribute_table.md Outdated




		显示当前所有的调度任务

Collaborator

qiancai Feb 6, 2025

Suggested change

      
            显示当前所有的调度任务
          
            显示当前所有的调度任务：

sql-statements/sql_statement_distribute_table.md Outdated

    
              +---------+------------+------------+-----------------+------------+-----------+----------+-------------+---------------+

              显示当前表 t1 的 region 分布情况

Collaborator

qiancai Feb 6, 2025

Suggested change

      
            显示当前表 t1 的 region 分布情况
          
            显示表 `t1` 当前的 Region 分布情况：

sql-statements/sql_statement_distribute_table.md Outdated

    
              +---------+------------+------------+-----------------+------------+-----------+----------+-------------+---------------+

              | JOB_ID  |  DB_NAME   | TABLE_NAME | PARTITION_NAMES | ENGINE_TYPE | ROLE_TYPE | STATUS  | CREATE_USER | CREATE_TIME   |

              +---------+------------+------------+-----------------+------------+-----------+--------+---------------+---------------+

              |    1    |   db_1     |    t1      |                 | TIKV       | LEADER    | RUNNING  | ADMIN       |   20240712    |

Collaborator

qiancai Feb 6, 2025

Suggested change

      
            |    1    |   db_1     |    t1      |                 | TIKV       | LEADER    | RUNNING  | ADMIN       |   20240712    |
          
            |    1    |   db_1     |    t1      |                 | TIKV       | LEADER    | RUNNING  | ADMIN       | 20240712      |

sql-statements/sql_statement_distribute_table.md Outdated

Comment on lines 76 to 77

    
              Distribute Table 语句重新调度 table 下的 region 也会受到 PD 中热点调度器的影响。 同时该任务会在均衡后退出，退出后该表的分布可能会

              被被破坏。

Collaborator

qiancai Feb 6, 2025 •

edited

Loading

Suggested change

      
            Distribute Table 语句重新调度 table 下的 region 也会受到 PD 中热点调度器的影响。 同时该任务会在均衡后退出，退出后该表的分布可能会
          
            被被破坏。
          
            `DISTRIBUTE TABLE` 语句在重新调度表中的 Region 时，可能会受到 PD 热点调度器的影响。调度完成后，随着时间推移，表的 Region 分布可能再次失衡。

sql-statements/sql_statement_distribute_table.md Outdated Show resolved Hide resolved

ti-chi-bot bot added size/L and removed size/M labels


          address comment

c0b9415

Signed-off-by: 童剑 <[email protected]>

bufferflies force-pushed the distribute_table branch from 48d48ef to c0b9415 Compare

February 13, 2025 07:07


          add toc changes and anther two sql docs

e80d334

qiancai force-pushed the distribute_table branch from cce3206 to e80d334 Compare

February 20, 2025 07:58

qiancai reviewed

View reviewed changes

sql-statements/sql_statement-show-table-distribution.md Outdated Show resolved Hide resolved

qiancai reviewed

View reviewed changes

sql-statements/sql_statement_distribute_table.md Outdated Show resolved Hide resolved


          Apply suggestions from code review

1bdc893

qiancai mentioned this pull request

distribute-table: support to scatter the region distribution of the given table and engine pingcap/docs#20345

Merged

16 tasks


          update the file naming style to use hyphen

2bfb0e1

Oreoxmt approved these changes

View reviewed changes

sql-statements/sql-statement-distribute-table.md Outdated Show resolved Hide resolved

ti-chi-bot bot added the needs-1-more-lgtm label

bufferflies mentioned this pull request

parser: support the new sql to show table t1 distribution pingcap/tidb#59820

Merged

1 task

qiancai added translation/done and removed translation/doing labels

qiancai added 2 commits

June 30, 2025 15:56


          remove an empty line

4bcab8e


          add four comments about the support info

5673ec1

ti-chi-bot bot added size/XL and removed size/L labels

Oreoxmt approved these changes

View reviewed changes

sql-statements/sql-statement-distribute-table.md Outdated Show resolved Hide resolved

sql-statements/sql-statement-cancel-distribution-job.md Outdated Show resolved Hide resolved

sql-statements/sql-statement-cancel-distribution-job.md Outdated Show resolved Hide resolved

sql-statements/sql-statement-distribute-table.md Outdated Show resolved Hide resolved

sql-statements/sql-statement-distribute-table.md Outdated Show resolved Hide resolved

sql-statements/sql-statement-distribute-table.md Outdated Show resolved Hide resolved

sql-statements/sql-statement-distribute-table.md Show resolved Hide resolved

sql-statements/sql-statement-distribute-table.md Outdated Show resolved Hide resolved

qiancai and others added 3 commits

July 24, 2025 17:24


          Apply suggestions from code review

f5e6ffa

Co-authored-by: Aolin <[email protected]>


          use <span> to wrap the version support info

9bae0eb


          Merge branch 'distribute_table' of https://github.com/bufferflies/doc…

97fc420

…s-cn into pr/19534

github-actions bot pushed a commit to qiancai/pingcap-docsite-preview that referenced this pull request


          Preview PR pingcap/docs-cn#19534 and this preview is triggered from c…

249b2b2

…ommit pingcap/docs-cn@97fc420


          show the version span in the doc title

a27f6cd

ti-chi-bot bot added size/L and removed size/XL labels

github-actions bot pushed a commit to qiancai/pingcap-docsite-preview that referenced this pull request


          Preview PR pingcap/docs-cn#19534 and this preview is triggered from c…

f1628cb

…ommit pingcap/docs-cn@a27f6cd

Collaborator

qiancai commented Aug 20, 2025

/approve

ti-chi-bot bot commented Aug 20, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: qiancai

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

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [qiancai]

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 bot added the approved label

qiancai removed the approved label

ti-chi-bot bot added the approved label

ti-chi-bot bot commented Aug 26, 2025

@qiancai: You cannot manually add or delete the cherry pick approval state labels, only I and the tursted members have permission to do so. You can approve it in internal platform.

In response to removing label named approved.

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 ti-community-infra/tichi repository.

joey-yez approved these changes

View reviewed changes

ti-chi-bot bot commented Sep 4, 2025

@joey-yez: adding LGTM is restricted to approvers and reviewers in OWNERS files.

In 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.

niubell approved these changes

View reviewed changes

Contributor

niubell left a comment

LGTM

ti-chi-bot bot commented Sep 8, 2025

@niubell: adding LGTM is restricted to approvers and reviewers in OWNERS files.

In response to this:

LGTM

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.

qiancai removed the do-not-merge/hold label

ti-chi-bot bot merged commit 988f395 into pingcap:master

7 checks passed

qiancai added the needs-cherry-pick-release-8.5 label

ti-chi-bot pushed a commit to ti-chi-bot/docs-cn that referenced this pull request


          distribute-table: support to scatter the region distribution of the g…

ba10b7a

…iven table and engine (pingcap#19534)

Member

ti-chi-bot commented Oct 11, 2025

In response to a cherrypick label: new pull request created to branch release-8.5: #20985.

This was referenced Oct 11, 2025

Do not merge until v8.5.4: distribute-table: support to scatter the region distribution of the given table and engine (#19534) #20985

Open

Do not merge until v8.5.4: distribute-table: support to scatter the region distribution of the given table and engine (#20345) pingcap/docs#21883

Open

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved lgtm needs-cherry-pick-release-8.5 size/L translation/done v9.0-beta.2