Skip to content

system-databases: Refactor/Improve clarity (#3178)#3353

Merged
yikeke merged 6 commits into
pingcap:release-4.0from
ti-srebot:release-4.0-c71360707064
Jul 21, 2020
Merged

system-databases: Refactor/Improve clarity (#3178)#3353
yikeke merged 6 commits into
pingcap:release-4.0from
ti-srebot:release-4.0-c71360707064

Conversation

@ti-srebot
Copy link
Copy Markdown
Contributor

cherry-pick #3178 to release-4.0


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

Signed-off-by: ti-srebot <ti-srebot@pingcap.com>
@ti-srebot ti-srebot added size/large Changes of a large size. status/PTAL This PR is ready for reviewing. type/cherry-pick-for-release-4.0 This PR is cherry-picked to release-4.0 from a source PR. requires-version-specific-changes After cherry-picked, the cherry-picked PR requires further changes. labels Jul 21, 2020
@ti-srebot ti-srebot assigned ghost Jul 21, 2020
Comment thread information-schema/information-schema-metrics-tables.md Outdated
Comment thread information-schema.md Outdated
Copy link
Copy Markdown
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 the status/LGT1 Indicates that a PR has LGTM 1. label Jul 21, 2020
@yikeke yikeke merged commit 00729ba into pingcap:release-4.0 Jul 21, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

requires-version-specific-changes After cherry-picked, the cherry-picked PR requires further changes. size/large Changes of a large size. status/LGT1 Indicates that a PR has LGTM 1. status/PTAL This PR is ready for reviewing. type/cherry-pick-for-release-4.0 This PR is cherry-picked to release-4.0 from a source PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants