From 807b1ea8946408d7784e44c31fbc1f2ef59b0e7f Mon Sep 17 00:00:00 2001 From: glorv Date: Thu, 21 Jul 2022 12:16:11 +0800 Subject: [PATCH 1/4] add config-info --- command-line-flags-for-tikv-configuration.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/command-line-flags-for-tikv-configuration.md b/command-line-flags-for-tikv-configuration.md index 9975808c631b..ab359ace9d57 100644 --- a/command-line-flags-for-tikv-configuration.md +++ b/command-line-flags-for-tikv-configuration.md @@ -49,6 +49,12 @@ TiKV 的命令行参数支持一些可读性好的单位转换。 + 默认：0（无限） + PD 需要使用这个值来对整个集群做 balance 操作。（提示：你可以使用 10GB 来替代 10737418240，从而简化参数的传递）。 +## `--config-info ` + ++ 输出各个配置项的取值信息并退出 ++ 目前仅支持 JSON 格式的输出 ++ 目前仅支持输出每个配置项的名字(Name)、默认值(DefaultValue) 和当前配置值(ValueInFile)。当执行此命令时，若同时指定了 `-C` 或 `--config` 参数，则在对应的配置文件包含的配置项会同时输出 `当前配置值`，其他未指定的配置项仅输出默认值。 + ## `--data-dir` + TiKV 数据存储路径。 From cc71b4e1fb52e7cf25113b48b4f04d5011e88fce Mon Sep 17 00:00:00 2001 From: glorv Date: Mon, 25 Jul 2022 11:40:47 +0800 Subject: [PATCH 2/4] apply review comments --- command-line-flags-for-tikv-configuration.md | 24 +++++++++++++++++--- 1 file changed, 21 insertions(+), 3 deletions(-) diff --git a/command-line-flags-for-tikv-configuration.md b/command-line-flags-for-tikv-configuration.md index ab359ace9d57..3dd60e0375fa 100644 --- a/command-line-flags-for-tikv-configuration.md +++ b/command-line-flags-for-tikv-configuration.md @@ -51,9 +51,27 @@ TiKV 的命令行参数支持一些可读性好的单位转换。 ## `--config-info ` -+ 输出各个配置项的取值信息并退出 -+ 目前仅支持 JSON 格式的输出 -+ 目前仅支持输出每个配置项的名字(Name)、默认值(DefaultValue) 和当前配置值(ValueInFile)。当执行此命令时，若同时指定了 `-C` 或 `--config` 参数，则在对应的配置文件包含的配置项会同时输出 `当前配置值`，其他未指定的配置项仅输出默认值。 ++ 按照指定的 `FORMAT` 输出各个配置项的取值信息并退出。 ++ `FORMAT` 可选值：`json`。 ++ 目前仅支持以 JSON 格式输出每个配置项的名字 (Name)、默认值 (DefaultValue) 和当前配置值 (ValueInFile)。当执行此命令时，若同时指定了 `-C` 或 `--config` 参数，则在对应的配置文件包含的配置项会同时输出当前配置值，其他未指定的配置项仅输出默认值，示例如下： +```json +{ + "Component": "TiKV Server", + "Version": "6.2.0", + "Parameters": [ + { + "Name": "log-level", + "DefaultValue": "info", + "ValueInFile": "warn" + }, + { + "Name": "log-file", + "DefaultValue": "" + }, + ... + ] + } +``` ## `--data-dir` From 1b0b2254cc7ae539e8a41437b7605ee299ee5d60 Mon Sep 17 00:00:00 2001 From: glorv Date: Mon, 25 Jul 2022 19:40:19 +0800 Subject: [PATCH 3/4] fix blank --- command-line-flags-for-tikv-configuration.md | 1 + 1 file changed, 1 insertion(+) diff --git a/command-line-flags-for-tikv-configuration.md b/command-line-flags-for-tikv-configuration.md index 3dd60e0375fa..0f6cc9675127 100644 --- a/command-line-flags-for-tikv-configuration.md +++ b/command-line-flags-for-tikv-configuration.md @@ -54,6 +54,7 @@ TiKV 的命令行参数支持一些可读性好的单位转换。 + 按照指定的 `FORMAT` 输出各个配置项的取值信息并退出。 + `FORMAT` 可选值：`json`。 + 目前仅支持以 JSON 格式输出每个配置项的名字 (Name)、默认值 (DefaultValue) 和当前配置值 (ValueInFile)。当执行此命令时，若同时指定了 `-C` 或 `--config` 参数，则在对应的配置文件包含的配置项会同时输出当前配置值，其他未指定的配置项仅输出默认值，示例如下： + ```json { "Component": "TiKV Server", From dde30bf6d5066a9332a19950f2cd9a401c3ff1ae Mon Sep 17 00:00:00 2001 From: Aolin Date: Tue, 26 Jul 2022 18:41:33 +0800 Subject: [PATCH 4/4] Apply suggestions from code review Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com> --- command-line-flags-for-tikv-configuration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/command-line-flags-for-tikv-configuration.md b/command-line-flags-for-tikv-configuration.md index 0f6cc9675127..943fd39c8e5c 100644 --- a/command-line-flags-for-tikv-configuration.md +++ b/command-line-flags-for-tikv-configuration.md @@ -53,7 +53,7 @@ TiKV 的命令行参数支持一些可读性好的单位转换。 + 按照指定的 `FORMAT` 输出各个配置项的取值信息并退出。 + `FORMAT` 可选值：`json`。 -+ 目前仅支持以 JSON 格式输出每个配置项的名字 (Name)、默认值 (DefaultValue) 和当前配置值 (ValueInFile)。当执行此命令时，若同时指定了 `-C` 或 `--config` 参数，则在对应的配置文件包含的配置项会同时输出当前配置值，其他未指定的配置项仅输出默认值，示例如下： ++ 目前仅支持以 JSON 格式输出每个配置项的名字 (Name)、默认值 (DefaultValue) 和当前配置值 (ValueInFile)。当执行此命令时，若同时指定了 `-C` 或 `--config` 参数，则对应的配置文件包含的配置项会同时输出当前配置值和默认值，其他未指定的配置项仅输出默认值，示例如下： ```json {