Document tikv-ctl #691
Merged
Document tikv-ctl #691
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@lilin90 li PTAL |
lilin90
reviewed
Apr 25, 2018
tools/tikv-control.md
Outdated
| # TiKV Control 使用说明 | ||
|
|
||
| TiKV Control (tikv-ctl) 是随 TiKV 附带的一个简单的管理工具，以下简称 tikv-ctl。 | ||
| 在编译 tikv 时，tikv-ctl 命令也会同时被编译出来，而通过 ansible 部署的集群，在 |
There was a problem hiding this comment.
- tikv -> TiKV
- ansible -> Ansible
tools/tikv-control.md
Outdated
| AAFF | ||
| ``` | ||
|
|
||
| 注意在命令行上指定 `escaped` 形式的 key 时，需要用双引号引起来，否则 bash 会将 |
There was a problem hiding this comment.
Please add the "Note" format as below (> ****):
注意： 在命令行上指定
escaped形式的 key 时，需要用双引号引起来，否则 bash 会将反斜杠吃掉，从而得到错误的结果。
tools/tikv-control.md
Outdated
|
|
||
| # TiKV Control 使用说明 | ||
|
|
||
| TiKV Control (tikv-ctl) 是随 TiKV 附带的一个简单的管理工具，以下简称 tikv-ctl。 |
There was a problem hiding this comment.
For the text, usually, we use the default length of a line, because manually changing a line makes it inconvenient for format review (such as whitespaces). If possible, would you please update them? You can refer to other .md files.
tools/tikv-control.md
Outdated
| ### 查看 Raft 状态机的信息 | ||
| `raft` 子命令可以查看 Raft 状态机在某一时刻的状态，包括 **RegionLocalState**， | ||
| **RaftLocalState**， **RegionApplyState** 三个结构体，及某一条 log 对应的 Entries。 | ||
| 它有 `region` 和 `log` 两个子命令分别做这两件事。 |
There was a problem hiding this comment.
For the three lines above, pls delete the extra whitespaces between Chinese punctuation and English/special characters.
tools/tikv-control.md
Outdated
| 打印某个 key 的值需要用到 `print` 命令。示例从略。 | ||
|
|
||
| ### 手动 compact 数据 | ||
| `compact` 命令可以对 tikv 进行手动 compact。如果指定 `-from` 和 `--to` 选项，那么它们的参数 |
tools/tikv-control.md
Outdated
|
|
||
| ### 手动 compact 数据 | ||
| `compact` 命令可以对 tikv 进行手动 compact。如果指定 `-from` 和 `--to` 选项，那么它们的参数 | ||
| 也是 escaped raw key 形式的。`--db` 参数可以指定要 compact 的 Rocksdb，有 `kv` 和 `raft` |
tools/tikv-control.md
Outdated
| success! | ||
| ``` | ||
|
|
||
| 这个命令只支持本地模式。注意，`--pd/-p` 选项的参数指定 PD 的 endponits，他是没有 `http` 前缀的。 |
There was a problem hiding this comment.
- Add the "Note" format
- endponits -> endpoints
- 他 -> 它
tools/tikv-control.md
Outdated
| ### 打印 Raft 状态机出错的 Region | ||
| 前面 tombstone 命令可以将 Raft 状态机出错的 Region 设置为 Tombstone 状态，避免 TiKV 启动 | ||
| 时对它们进行检查。在运行那个命令之前，`bad-regions` 命令可以找出这些出错了的 Region，以便 | ||
| 我们可以多个工具组合起来进行自动话的处理。 |
tools/tikv-control.md
Outdated
| ``` | ||
|
|
||
| 命令执行成功会打印上面的信息，否则会打印出有错误的 Region 列表。目前可以检出的错误包括 | ||
| last index、commit index 和 apply index 之间的不匹配，以及 raft log 的丢失。其他一些情况， |
|
@siddontang PTAL |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR document tikv-ctl.