Doc: Add pg-controldata documentation #228
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,31 @@ | ||||||||||
| --- | ||||||||||
| title: pg_controldata | ||||||||||
| --- | ||||||||||
|
|
||||||||||
| # pg_controldata | ||||||||||
|
|
||||||||||
| Displays control information of a PostgreSQL database cluster. | ||||||||||
|
|
||||||||||
| Only the user who initialized the cluster and has read access to the data directory can run the utility. The access restriction ensures the integrity and security of the sensitive control information. | ||||||||||
|
Contributor
There was a problem hiding this comment. To improve the readability.
Suggested change
|
||||||||||
|
|
||||||||||
| ## Synopsis | ||||||||||
|
Contributor
There was a problem hiding this comment. For better markdown writing style, it is recommended to reserve a blank line between the paragraph and the preceding title, in case that consecutive lines are rendered as one line.
Suggested change
|
||||||||||
| ``` | ||||||||||
| pg_controldata [option] [[ -D | --pgdata ]datadir] | ||||||||||
| ``` | ||||||||||
|
|
||||||||||
| ## Description | ||||||||||
| The `pg_controldata` utility serves a crucial role in PostgreSQL database administration by revealing control information related to a PostgreSQL database cluster. The information includes details initialized during the initdb process, such as the catalog version, write-ahead logging and checkpoint processing. It's important to note that the information is cluster-wide, and not specific to any individual database within the cluster. | ||||||||||
|
|
||||||||||
| ## Options | ||||||||||
| The `pg_controldata` utility supports the following options. | ||||||||||
| | Option | Description | | ||||||||||
| | ------------ | ------------------- | | ||||||||||
| | `-V` and `--version` | Print the `pg_controldata` version and exit. | | ||||||||||
| | `-?` and `--help` | Output a list of all supported arguments. It enables users to use the utility effectively. | | ||||||||||
|
Contributor
There was a problem hiding this comment. Keep a consistent style with your first sentence of the document.
Suggested change
|
||||||||||
|
|
||||||||||
| ## Environment variables | ||||||||||
| The `pg_controldata` utility supports the following environment variables. | ||||||||||
| | Variable | Description | | ||||||||||
| | ------------ | ------------------- | | ||||||||||
| | `-PGDATA` | The default location of data directory. You can specify the data directory on the command line, or use the environment variable `PGDATA`. | | ||||||||||
| | `-PG_COLOR` | Determine whether to use color in diagnostic messages. The available values are `always`, `auto` and `never`. Setting the value to `always` ensures that diagnostic messages are always presented in color, which enhances readability and visual identification of important information. Setting the value to `auto` enables color-coding based on the capabilities of the output terminal.Setting the value to `never` disables the usage of color entirely. | | ||||||||||
|
Contributor
There was a problem hiding this comment.
Suggested change
|
||||||||||
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,30 @@ | ||||||
| --- | ||||||
| title: pg_controldata | ||||||
| --- | ||||||
|
|
||||||
| # pg_controldata | ||||||
| 显示PostgreSQL数据库集群的控制信息。 | ||||||
|
Contributor
There was a problem hiding this comment. Please keep a consistent style of whether to reserve a space between an English character and a Chinese character throughout the document. |
||||||
|
|
||||||
| 只有初始化集群且对数据目录有读取权限的用户才能运行此实用工具。这种访问限制确保了敏感控制信息的完整性和安全性。 | ||||||
|
Contributor
There was a problem hiding this comment. To improve the "translationese" a bit.
Suggested change
|
||||||
|
|
||||||
| ## 命令概要 | ||||||
| ``` | ||||||
| pg_controldata [option] [[ -D | --pgdata ]datadir] | ||||||
| ``` | ||||||
|
|
||||||
| ## 描述 | ||||||
| `pg_controldata`实用工具在 PostgreSQL 数据库管理中发挥着关键作用，它展示了与 PostgreSQL 数据库集群相关的控制信息。这些信息包含 initdb 过程中初始化的详细内容（例如目录版本），预写式日志记录以及检查点处理等。这些信息是集群范围的，并非集群内的某个数据库的。 | ||||||
|
|
||||||
| ## 命令行选项说明 | ||||||
| `pg_controldata` 实用工具支持以下命令行选项。 | ||||||
| | 命令行选项 | 作用 | | ||||||
| | ------------ | ------------------- | | ||||||
| | `-V` 和 `--version` | 输出`pg_controldata`版本号并退出。 | | ||||||
| | `-?` 和 `--help` | 输出所有参数列表。这些参数帮助用户使用该实用工具。 | | ||||||
|
|
||||||
| ## 环境变量 | ||||||
| `pg_controldata` 实用工具支持以下环境变量。 | ||||||
| | 环境变量 | 作用 | | ||||||
| | ------------ | ------------------- | | ||||||
| | `-PGDATA` | 数据目录的默认位置。可以用命令行或环境变量`PGDATA` 指定数据目录。 | | ||||||
| | `-PG_COLOR` | 该变量决定是否在诊断消息中使用颜色。可用值有 `always（始终）`, `auto（自动）` 和 `never（从不）`。将值设置为 `always（始终）` 可确保诊断消息始终以彩色显示，这样可以提高可读性并从视觉上识别重要信息。将值设置为 `auto（自动）` 可根据输出终端的功能进行颜色编码。将值设置为 `never（从不）`则完全禁用颜色。 | | ||||||
|
Contributor
There was a problem hiding this comment. The Chinese explanations along with the parentheses are not part of the variable values themselves; please write them separately.
Suggested change
|
||||||
This file contains hidden or 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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's OK to use the original PostgreSQL document but it would be better to use the right product name and complete the sentence.