diff --git a/tools/tikv-control.md b/tools/tikv-control.md index f9d8e6857f84f..86464b64c5b0e 100644 --- a/tools/tikv-control.md +++ b/tools/tikv-control.md @@ -160,4 +160,18 @@ $ tikv-ctl --db /path/to/tikv/db bad-regions all regions are healthy ``` -If the command is successfully executed, it prints the above information. If the command fails, it prints the list of bad Regions. Currently, the errors that can be detected include the mismatches between `last index`, `commit index` and `apply index`, and the loss of Raft log. Other conditions like the damage of snapshot files still need further support. \ No newline at end of file +If the command is successfully executed, it prints the above information. If the command fails, it prints the list of bad Regions. Currently, the errors that can be detected include the mismatches between `last index`, `commit index` and `apply index`, and the loss of Raft log. Other conditions like the damage of snapshot files still need further support. + +### View Region properties + +- To view in local the properties of Region 2 on the TiKV instance that is deployed in `/path/to/tikv`: + + ```bash + $ tikv-ctl --db /path/to/tikv/data/db region-properties -r 2 + ``` + +- To view online the properties of Region 2 on the TiKV instance that is running on `127.0.0.1:20160`: + + ```bash + $ tikv-ctl --host 127.0.0.1:20160 region-properties -r 2 + ``` \ No newline at end of file