pingcap / pingcap/docs

Add column descriptions for INFORMATION_SCHEMA.PARTITIONS

Open
#17,533 3 comments 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.
    https://docs.pingcap.com/tidb/stable/information-schema-partitions only shows the table and its columns, not what the columns mean.

  2. Describe your suggestion or addition.
    For each column describe the content, I was recently asked for how to get the partition limits/values for RANGE partitioning :) Which is in PARTITION_DESCRIPTION
    Similar to how https://docs.pingcap.com/tidb/stable/information-schema-columns is documented

  3. Provide some reference materials (such as documents and websites) if you could.
    https://dev.mysql.com/doc/refman/8.0/en/information-schema-partitions-table.html

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 existing INFORMATION_SCHEMA.PARTITIONS documentation page and compare its structure with the INFORMATION_SCHEMA.COLUMNS page. Use the linked MySQL reference for column meanings, and finish when every PARTITIONS column has a clear description, including PARTITION_DESCRIPTION and its partition limits or values.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.