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.

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

ADMIN CHECKSUM TABLE command undocumented #956

Closed
morgo opened this issue Mar 17, 2019 · 4 comments
Closed

ADMIN CHECKSUM TABLE command undocumented #956

morgo opened this issue Mar 17, 2019 · 4 comments
Labels
help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.

Comments

@morgo
Copy link
Contributor

morgo commented Mar 17, 2019

Change Request

This repository is ONLY used to solve issues related to DOCS.
For other issues (related to TiDB, PD, etc), please move to other repositories.

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

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

The command added here is completely undocumented pingcap/tidb#6067

  1. Describe your suggestion or addition.

I expect there would be some documentation here: https://pingcap.com/docs/sql/admin/#admin-statement

  1. Provide some reference materials (documents, websites, etc) if you could.

As well as the commit referenced above, this command appears to be used by lightning.

@kennytm
Copy link
Contributor

kennytm commented Mar 19, 2019

@morgo In #663 the admin show slow statement was documented in sql/slow-query.md instead of sql/admin.md. Do you think it is better to document admin checksum table in tools/lightning/*?

Additionally there are several undocumented ADMIN statements like admin check table, admin check index, admin cleanup index etc (not related to Lightning).

@morgo
Copy link
Contributor Author

morgo commented Mar 19, 2019

@kennytm I think they should all be documented :-) There is no harm in mentioning them in both places.

@morgo
Copy link
Contributor Author

morgo commented Jun 25, 2019

ADMIN is now documented here:
https://pingcap.com/docs/v3.0/reference/sql/statements/admin/

It makes sense to break this into sub-statement documentation though.

@yikeke yikeke added the help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. label Jan 7, 2020
@ghost
Copy link

ghost commented Jul 7, 2020

I will close this and handle in #2639

@ghost ghost closed this as completed Jul 7, 2020
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.
Projects
None yet
Development

No branches or pull requests

3 participants