Skip to content

reference: rename TiDB Controller to TiDB Control (#2304) #2311

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

Merged
merged 4 commits into from
May 12, 2020
Merged

reference: rename TiDB Controller to TiDB Control (#2304) #2311

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
05b7711
cherry pick #2304 to release-2.1
TomShawn Apr 16, 2020
92063f3
resolve conflict
TomShawn May 12, 2020
28b8c1c
Update tidb-control.md
TomShawn May 12, 2020
65a80cc
Merge branch 'release-2.1' into release-2.1-25fc1ef9b8fa
ran-huang May 12, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions reference/tools/tidb-control.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
---
title: TiDB Controller User Guide
summary: Use TiDB Controller to obtain TiDB status information for debugging.
title: TiDB Control User Guide
summary: Use TiDB Control to obtain TiDB status information for debugging.
category: reference
---

# TiDB Controller User Guide
# TiDB Control User Guide

TiDB Controller is a command line tool of TiDB, usually used to obtain the status information of TiDB for debugging.
TiDB Control is a command line tool of TiDB, usually used to obtain the status information of TiDB for debugging.

## Compile from source code

- Compilation environment requirement: [Go](https://golang.org/) Version 1.7 or later
- Compilation procedures: Go to the root directory of the [TiDB Controller project](https://github.com/pingcap/tidb-ctl), use the `make` command to compile, and generate `tidb-ctl`.
- Compilation procedures: Go to the root directory of the [TiDB Control project](https://github.com/pingcap/tidb-ctl), use the `make` command to compile, and generate `tidb-ctl`.
- Compilation documentation: you can find the help files in the `doc` directory; if the help files are lost or you want to update them, use the `make doc` command to generate the help files.

## Usage introduction
Expand All @@ -32,7 +32,9 @@ Usage example: `tidb-ctl schema in mysql -n db`

### Get help

Use `tidb-ctl -h/--help` to get the help information. `tidb-ctl` consists of multiple layers of commands. You can use `-h/--help` to get the help information of `tidb-ctl` and all other subcommands.
Use `tidb-ctl -h/--help` to get usage information.

TiDB Control consists of multiple layers of commands. You can use `-h/--help` after each command/subcommand to get its respective usage information.

### Connect

Expand All @@ -42,7 +44,7 @@ tidb-ctl -H/--host {TiDB service address} -P/--port {TiDB service port}

If you do not add an address or a port, the default value is used. The default address is `127.0.0.1` (service address must be the IP address); the default port is `10080`. Connection options are top-level options and apply to all of the following commands.

Currently, TiDB Controller can obtain four categories of information using the following four commands:
Currently, TiDB Control can obtain four categories of information using the following four commands:

- `tidb-ctl mvcc`: MVCC information
- `tidb-ctl region`: Region information
Expand Down