Skip to content

Commit 1733797

Browse files
authored
tikv: add command line flag --config-info (#9777)
1 parent 3625073 commit 1733797

1 file changed

Lines changed: 25 additions & 0 deletions

File tree

command-line-flags-for-tikv-configuration.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,31 @@ TiKV supports some readable unit conversions for command line parameters.
5050
- Default: `0` (unlimited)
5151
- PD uses this flag to determine how to balance the TiKV servers. (Tip: you can use 10GB instead of 1073741824)
5252

53+
## `--config-info <FORMAT>`
54+
55+
- When this flag is used, available configuration values are listed according to `FORMAT` and then exit.
56+
- Value option for `FORMAT`: `json`. Currently, only JSON format is supported.
57+
- Only the configuration name (Name), default value (DefaultValue) and current value (ValueInFile) are listed in the output JSON. If the `-C` or `--config` is specified, the current value and the default value of configuration items in the file are listed together, and other items without `-C` or `--config` specified only have default values. The following is an example:
58+
59+
```json
60+
{
61+
"Component": "TiKV Server",
62+
"Version": "6.2.0",
63+
"Parameters": [
64+
{
65+
"Name": "log-level",
66+
"DefaultValue": "info",
67+
"ValueInFile": "warn"
68+
},
69+
{
70+
"Name": "log-file",
71+
"DefaultValue": ""
72+
},
73+
...
74+
]
75+
}
76+
```
77+
5378
## `--data-dir`
5479

5580
- The path to the data directory

0 commit comments

Comments
 (0)