Skip to content
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

Jump to bottom

tikv: add command line flag --config-info #9777

Merged
merged 2 commits into from
Aug 5, 2022
Merged

tikv: add command line flag --config-info #9777

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ffcf9db
add the --config-info
Oreoxmt Aug 1, 2022
5b9e43e
Apply suggestions from code review
Oreoxmt Aug 4, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
25 changes: 25 additions & 0 deletions command-line-flags-for-tikv-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,31 @@ TiKV supports some readable unit conversions for command line parameters.
- Default: `0` (unlimited)
- PD uses this flag to determine how to balance the TiKV servers. (Tip: you can use 10GB instead of 1073741824)

## `--config-info <FORMAT>`

- List available configuration values according to `FORMAT` and then exit.
Oreoxmt marked this conversation as resolved.
Show resolved Hide resolved
- Value options for `FORMAT`: `json`. Currently, only JSON format is supported.
Oreoxmt marked this conversation as resolved.
Show resolved Hide resolved
- Only the configuration name (Name), default value (DefaultValue) and current value (ValueInFile) is 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 only have default values. The following is an example:
Oreoxmt marked this conversation as resolved.
Show resolved Hide resolved

```json
{
"Component": "TiKV Server",
"Version": "6.2.0",
"Parameters": [
{
"Name": "log-level",
"DefaultValue": "info",
"ValueInFile": "warn"
},
{
"Name": "log-file",
"DefaultValue": ""
},
...
]
}
```

## `--data-dir`

- The path to the data directory
Expand Down