Skip to content

reference: rename TiDB Controller to TiDB Control (#2747) #2779

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 2 commits into from
Apr 16, 2020
Merged

reference: rename TiDB Controller to TiDB Control (#2747) #2779

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d7cbf9f
cherry pick #2747 to release-2.1
jackysp Apr 16, 2020
2b8025b
resolve conflicts
jackysp Apr 16, 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
2 changes: 1 addition & 1 deletion TOC.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -286,7 +286,7 @@
- [PD Control](/reference/tools/pd-control.md)
- [PD Recover](/reference/tools/pd-recover.md)
- [TiKV Control](/reference/tools/tikv-control.md)
- [TiDB Controller](/reference/tools/tidb-control.md)
- [TiDB Control](/reference/tools/tidb-control.md)
- [工具下载](/reference/tools/download.md)
+ 常见问题 (FAQ)
- [TiDB FAQ](/faq/tidb.md)
Expand Down
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,19 @@
---
title: TiDB Controller 使用说明
title: TiDB Control 使用说明
category: reference
---

# TiDB Controller 使用说明
# TiDB Control 使用说明

TiDB Controller 是 TiDB 的命令行工具，用于获取 TiDB 状态信息，多用于调试。
TiDB Control 是 TiDB 的命令行工具，用于获取 TiDB 状态信息，多用于调试。

## 源码编译

- 编译环境要求：[Go](https://golang.org/) Version 1.7 以上。
- 编译步骤：在 [TiDB Controller 项目](https://github.com/pingcap/tidb-ctl)根目录，使用 `make` 命令进行编译，生成 tidb-ctl。
- 编译文档：帮助文档在 doc 文件夹下，如丢失或需要更新，可通过 `make doc` 命令生成帮助文档。
编译环境要求：[Go](https://golang.org/) Version 1.7 以上

编译步骤：在 [TiDB Control 项目](https://github.com/pingcap/tidb-ctl)根目录，使用 `make` 命令进行编译，生成 tidb-ctl。

编译文档：帮助文档在 doc 文件夹下，如丢失或需要更新，可通过 `make doc` 命令生成帮助文档。

## 使用介绍

Expand All @@ -35,7 +37,7 @@ TiDB Controller 是 TiDB 的命令行工具，用于获取 TiDB 状态信息，

如不添加地址和端口将使用默认值，默认的地址是 127.0.0.1 (服务地址只能使用 IP 地址)，默认的端口是 10080。**连接选项是顶级选项，适用于以下所有命令。**

目前，TiDB Controller 可以获取四类信息，分别通过以下四个命令获得：
目前，TiDB Control 包含以下子命令，各个子命令的具体用法可以使用 `tidb-ctl SUBCOMMAND --help` 获取使用帮助：

* `tidb-ctl mvcc` - MVCC 信息
* `tidb-ctl region` - Region 信息
Expand Down