docs icon indicating copy to clipboard operation
docs copied to clipboard

Published 20 hours ago • verified publisher icon pingcap

Document ADMIN commands

Open wwar opened this issue 4 years ago • 8 comments

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.

In the statement reference, admin is documented all as one command: https://pingcap.com/docs/stable/sql-statements/sql-statement-admin/

  1. Describe your suggestion or addition.

These should be documented individually:

ADMIN CANCEL DDL
ADMIN CHECK [TABLE|INDEX]
ADMIN CHECKSUM TABLE
ADMIN PLUGINS
ADMIN RECOVER INDEX
ADMIN RELOAD
ADMIN REPAIR TABLE
ADMIN SHOW DDL
  1. Provide some reference materials (documents, websites, etc) if you could.

wwar avatar May 29 '20 04:05 wwar

@crazycs520 PTAL, thanks

toutdesuite avatar May 29 '20 06:05 toutdesuite

Here is a more up to date list of all the admin commands:

ADMIN CANCEL DDL
ADMIN CAPTURE BINDINGS
ADMIN CHECK [TABLE|INDEX]
ADMIN CHECKSUM TABLE
ADMIN EVOLVE BINDINGS
ADMIN FLUSH BINDINGS
ADMIN PLUGINS
ADMIN RECOVER INDEX
ADMIN RELOAD
ADMIN RELOAD BINDINGS
ADMIN REPAIR TABLE
ADMIN SHOW DDL
ADMIN SHOW SLOW

ghost avatar Jul 08 '20 03:07 ghost

My plan is to break this up into smaller PRs:

First PR:

ADMIN CANCEL DDL
ADMIN CHECK [TABLE|INDEX]
ADMIN CHECKSUM TABLE
ADMIN SHOW DDL

Second:

ADMIN CAPTURE BINDINGS
ADMIN EVOLVE BINDINGS
ADMIN FLUSH BINDINGS
ADMIN RELOAD BINDINGS

Third:

ADMIN PLUGINS
ADMIN SHOW SLOW

Fourth:

ADMIN RECOVER INDEX
ADMIN RELOAD
ADMIN REPAIR TABLE

ghost avatar Aug 09 '20 22:08 ghost

This issue is stale because it has been open for 60 days with no activity. If no comment has been made and the lifecycle/stale label is not removed, this issue will be closed in 15 days.

github-actions[bot] avatar Nov 04 '20 00:11 github-actions[bot]

This issue is stale because it has been open for 60 days with no activity. If no comment has been made and the lifecycle/stale label is not removed, this issue will be closed in 15 days.

github-actions[bot] avatar Feb 01 '21 00:02 github-actions[bot]

This issue will be closed because it has been stale for 15 days with no activity. If you still have any question about this issue, feel free to reopen it or create a new one.

github-actions[bot] avatar Feb 17 '21 00:02 github-actions[bot]

Reopen this issue. Many of these commands are still not documented.

kolbe avatar Aug 17 '22 05:08 kolbe

@TomShawn PTAL

  • [x] ADMIN CANCEL DDL
  • [x] ADMIN CAPTURE BINDINGS https://docs.pingcap.com/tidb/dev/sql-statement-admin#admin-bindings-related-statement
  • [x] ADMIN CHECK [TABLE|INDEX]
  • [x] ADMIN CLEANUP
  • [x] ADMIN CHECKSUM TABLE
  • [x] ADMIN EVOLVE BINDINGS https://docs.pingcap.com/tidb/dev/sql-statement-admin#admin-bindings-related-statement
  • [x] ADMIN FLUSH BINDINGS https://docs.pingcap.com/tidb/dev/sql-statement-admin#admin-bindings-related-statement
  • [x] ADMIN PLUGINS https://docs.pingcap.com/tidb/dev/sql-statement-admin#admin-plugins-related-statement
  • [x] ADMIN REPAIR TABLE https://docs.pingcap.com/tidb/dev/sql-statement-admin#admin-repair-statement
  • [ ] ADMIN RECOVER INDEX
  • [x] ADMIN RELOAD https://docs.pingcap.com/tidb/dev/sql-statement-admin#admin-reload-statement
  • [x] ADMIN RELOAD BINDINGS https://docs.pingcap.com/tidb/dev/sql-statement-admin#admin-bindings-related-statement
  • [x] ADMIN REPAIR TABLE https://docs.pingcap.com/tidb/dev/sql-statement-admin#admin-repair-statement
  • [x] ADMIN SHOW DDL
  • [x] ADMIN SHOW SLOW https://docs.pingcap.com/tidb/dev/identify-slow-queries#admin-show-slow-command
  • [x] ADMIN SHOW TELEMETRY

Oreoxmt avatar Aug 17 '22 06:08 Oreoxmt

@kolbe @Oreoxmt ADMIN CLEANUP and ADMIN RECOVER have been documented. Till now, all ADMIN commands claimed missing are documented properly. ADMIN CLEANUP INDEX ADMIN RECOVER INDEX

shichun-0415 avatar Mar 08 '23 06:03 shichun-0415