pingcap / pingcap/docs

Add Partition Management as Physical DDL statements

Open
#19,410 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
617
Forks
724
Avg merge
2d 10h
Merged PRs (30d)
223

Description

Change Request

Please answer the following questions before submitting your issue. Thanks!

  1. Describe what you find is inappropriate or missing in the existing docs.

in https://docs.pingcap.com/tidb/stable/ddl-introduction paragraph "Physical DDL statements" it says:
"Currently, physical DDL statements only include ADD INDEX and lossy column type changes", but Partition management statements like ALTER TABLE t REORGANIZE PARTITION ..., ALTER TABLE t PARTITION BY ... and ALTER TABLE t REMOVE PARTITIONING should also be considered as physical DDL statements, since they will both copy data to new partitions as well as recreate indexes. In addition, if using Global Indexes with partitioned tables, also DROP/TRUNCATE PARTITION will become Physical DDLs.

  1. Describe your suggestion or addition.
    "Currently, physical DDL statements include ADD INDEX, some partitioning management statements and lossy column type changes"

  2. Provide some reference materials (such as documents and websites) if you could.
    https://docs.pingcap.com/tidb/stable/ddl-introduction
    https://docs.pingcap.com/tidb/stable/partitioned-table#reorganize-partitions
    https://docs.pingcap.com/tidb/stable/partitioned-table#manage-hash-and-key-partitions
    https://docs.pingcap.com/tidb/stable/partitioned-table#convert-a-partitioned-table-to-a-non-partitioned-table
    https://docs.pingcap.com/tidb/stable/partitioned-table#partition-an-existing-table
    https://docs.pingcap.com/tidb/dev/partitioned-table#global-indexes

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the “Physical DDL statements” paragraph in the linked ddl-introduction documentation and compare its wording with the referenced partitioned-table sections, including Global Indexes. Update the statement list to cover the applicable partition-management operations and verify that the resulting documentation accurately reflects when they copy data or recreate indexes.

Written by the indexing model from the issue text.

Assessment

Tech stack
sql
Domain
databases, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.