Skip to content
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

system-databases: Refactor/Improve clarity #3178

Merged
merged 25 commits into from Jul 21, 2020
Merged

system-databases: Refactor/Improve clarity #3178

merged 25 commits into from Jul 21, 2020

Conversation

ghost
Copy link

@ghost ghost commented Jul 6, 2020 •
edited by ghost
Loading

What is changed, added or deleted? (Required)

Fixes #2642

There are actually quite a few issues with the current system tables documentation:

  • It organizes them into categories that don't match where they are in MySQL (System Databases section of manual is confusing #2642)
  • These are all called "system tables", but they have unique namespaces. It makes it confusing because it's quite possible that there could be a table of the same name in mysql.* and information_schema.* in future. Information_schema and metrics_schema would more correctly be called "system views", but I've not changed the navigation for now, as it was recently renamed from "System Databases". Information_schema also has meaning because it is an SQL standard. "system tables" is not.
  • Some information_schema tables have their own docs page. Others do not. I went with converting everything to one page per table for consistency. This makes it similar to the SQL Statements section, which is easy to follow.
  • Several of the example outputs have not been updated for recent TiDB versions.
  • Several of the example outputs do not match the commands (i.e. command= DESC, output = show create table)
  • In the main information schema page: https://docs.pingcap.com/tidb/v4.0/system-table-information-schema -- several of the example tables are repeated. See for example "SLOW_QUERY table" and "ANALYZE_STATUS table" -- but there are several others such as the tikv_* and tidb_* tables (!!)
  • The heading indent level was inconsistent on the main i_s page.
  • The "TiDB system tables" page makes it hard to follow that this is the MySQL schema. It should say it contains both stuff for MySQL and TiDB

I have also removed the "category" metadata of these files, since this is being deprecated.

Which TiDB version(s) do your changes apply to? (Required)

  • master (the latest development version)
  • v4.0 (TiDB 4.0 versions)
  • v3.1 (TiDB 3.1 versions)
  • v3.0 (TiDB 3.0 versions)
  • v2.1 (TiDB 2.1 versions)

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

Fixes #2642

@ghost ghost changed the title Refactor/Improve clarity of system databases system-databases: Refactor/Improve clarity of system databases Jul 7, 2020
@ghost ghost changed the title system-databases: Refactor/Improve clarity of system databases system-databases: Refactor/Improve clarity Jul 7, 2020
@ghost ghost marked this pull request as ready for review July 7, 2020 00:52
@ghost ghost requested a review from crazycs520 July 7, 2020 00:55
@ghost ghost added the size/large Changes of a large size. label Jul 7, 2020
@yikeke yikeke added needs-cherry-pick-4.0 translation/welcome Waits for a contributor to translate this PR and create a PR to the pingcap/docs-cn repository. status/PTAL This PR is ready for reviewing. labels Jul 7, 2020
zz-jason
zz-jason reviewed Jul 7, 2020
View reviewed changes
information-schema.md Outdated Show resolved Hide resolved
@yikeke yikeke added the requires-version-specific-changes After cherry-picked, the cherry-picked PR requires further changes. label Jul 8, 2020
@ti-srebot
Copy link
Contributor

@zz-jason, @lonng, @kissmydb, @crazycs520, @lilin90, @yikeke, PTAL.

@ti-srebot
Copy link
Contributor

@zz-jason, @lonng, @kissmydb, @crazycs520, @lilin90, @yikeke, PTAL.

1 similar comment
@ti-srebot
Copy link
Contributor

@zz-jason, @lonng, @kissmydb, @crazycs520, @lilin90, @yikeke, PTAL.

@yikeke yikeke added translation/doing This PR's assignee is translating this PR. and removed translation/welcome Waits for a contributor to translate this PR and create a PR to the pingcap/docs-cn repository. labels Jul 20, 2020
@yikeke yikeke self-assigned this Jul 20, 2020
@yikeke
Copy link
Contributor

yikeke commented Jul 20, 2020

@zz-jason and @kissmydb said they will take a last look tomorrow. This PR is expected to be merged soon. FYI. @nullnotnil

Null not nil and others added 3 commits July 20, 2020 12:38
kissmydb
kissmydb approved these changes Jul 21, 2020
View reviewed changes
Copy link
Contributor

@kissmydb kissmydb left a comment

Choose a reason for hiding this comment

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

LGTM

@ti-srebot ti-srebot added the status/LGT1 Indicates that a PR has LGTM 1. label Jul 21, 2020
yikeke
yikeke approved these changes Jul 21, 2020
View reviewed changes
Copy link
Contributor

@yikeke yikeke left a comment

Choose a reason for hiding this comment

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

LGTM

@ti-srebot ti-srebot added status/LGT2 Indicates that a PR has LGTM 2. and removed status/LGT1 Indicates that a PR has LGTM 1. labels Jul 21, 2020
@yikeke yikeke merged commit c713607 into pingcap:master Jul 21, 2020
ti-srebot pushed a commit to ti-srebot/docs that referenced this pull request Jul 21, 2020
@ti-srebot
cherry pick pingcap#3178 to release-4.0
60e5f92 
Signed-off-by: ti-srebot <ti-srebot@pingcap.com>
@ti-srebot ti-srebot mentioned this pull request Jul 21, 2020
Merged
5 tasks
@ti-srebot
Copy link
Contributor

cherry pick to release-4.0 in PR #3353

yikeke added a commit that referenced this pull request Jul 21, 2020
@ti-srebot @yikeke
system-databases: Refactor/Improve clarity (#3178) (#3353)
00729ba 
* cherry pick #3178 to release-4.0

Signed-off-by: ti-srebot <ti-srebot@pingcap.com>

* remove 2 files

* fix conflicts

* Apply suggestions from code review

* Update information-schema-cluster-config.md

* Delete system-table-sql-diagnosis.md

Co-authored-by: Null not nil <67764674+nullnotnil@users.noreply.github.com>
Co-authored-by: yikeke <yikeke@pingcap.com>
Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>
This was referenced Jul 29, 2020
Merged
Merged
@yikeke yikeke added translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. and removed translation/doing This PR's assignee is translating this PR. labels Jul 31, 2020
This was referenced Aug 3, 2020
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@crazycs520 crazycs520 Awaiting requested review from crazycs520

@lilin90 lilin90 Awaiting requested review from lilin90

Assignees

@yikeke yikeke

Labels
requires-version-specific-changes After cherry-picked, the cherry-picked PR requires further changes. size/large Changes of a large size. status/LGT2 Indicates that a PR has LGTM 2. status/PTAL This PR is ready for reviewing. translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

System Databases section of manual is confusing
4 participants
@ti-srebot @yikeke @zz-jason @kissmydb