docs: update config-file behavior after 3.4.0.0.#34747
Conversation
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request updates the documentation to reflect a significant change in how TDengine handles configuration parameters starting from version 3.4.0.0. To improve security and prevent unauthorized modifications, the system will no longer load configuration from Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Changelog
Activity
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Pull request overview
Updates documentation to reflect TDengine 3.4.0.0+ behavior around configuration persistence/security, emphasizing SQL (ALTER) as the supported way to change configuration after initial startup.
Changes:
- Clarifies in taosd reference docs (EN/ZH) that
forceReadConfigis removed and config file isn’t reloaded after first startup; recommends usingALTER. - Simplifies/merges the EN training FAQ entry about config-file edits not taking effect, aligning it to 3.4.0.0+.
- Minor formatting/content tweaks in the affected docs.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| docs/zh/14-reference/01-components/01-taosd.md | Adds guidance to use ALTER for config changes after initial startup; contains a punctuation typo and needs clarification vs. “taos.cfg can modify local params”. |
| docs/en/14-reference/01-components/01-taosd.md | Adds ALTER guidance; wording should be clarified to avoid conflicting with the “local params via taos.cfg” table entry. |
| docs/en/27-train-faq/index.md | Rewrites/condenses FAQ about config edits not taking effect; current wording is overly absolute vs. taosd reference behavior. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| 1. 通过 SQL 修改全局配置参数命令：`alter all dnodes ‘参数名’ ‘参数值’;`，修改后是否立即生效请参考各参数**动态修改**说明。 | ||
| 2. 通过 SQL 修改局部配置参数命令，`alter dnode <dnode_id> ‘参数名’ ‘参数值’;`，修改后是否立即生效请参考各参数**动态修改**说明。 | ||
| 3. 自 3.4.0.0 起，为防止配置文件被篡改，我们取消了 `forceReadConfig` 参数；除首次启动外，不再从配置文件中加载配置项。 | ||
| 3. 自 3.4.0.0 起，为防止配置文件被篡改，我们取消了 `forceReadConfig` 参数；除首次启动外，不再从配置文件中加载配置项，如果需要修改配置参数，请您使用 ALTER 命令，通过 SQL 的方式修改配置参数的值。。 |
There was a problem hiding this comment.
This sentence ends with a duplicated Chinese full stop (。。). Please remove the extra punctuation and ensure the sentence terminator is consistent with surrounding text.
| 3. 自 3.4.0.0 起，为防止配置文件被篡改，我们取消了 `forceReadConfig` 参数；除首次启动外，不再从配置文件中加载配置项，如果需要修改配置参数，请您使用 ALTER 命令，通过 SQL 的方式修改配置参数的值。。 | |
| 3. 自 3.4.0.0 起，为防止配置文件被篡改，我们取消了 `forceReadConfig` 参数；除首次启动外，不再从配置文件中加载配置项，如果需要修改配置参数，请您使用 ALTER 命令，通过 SQL 的方式修改配置参数的值。 |
| #### Problem Reason | ||
|
|
||
| This is because TDengine versions 3.3.5.0 and above support persisting dynamically modified configuration parameters. This means that parameters you change dynamically using the `ALTER` command will remain effective even after a restart. Therefore, when restarting, TDengine versions 3.3.5.0 and above will, by default, load configuration parameters (except for `dataDir` itself) from the `dataDir`, rather than using the parameters configured in `taos.cfg`. | ||
| In TDengine TSDB 3.4.0.0 and later, to improve security and prevent configuration file tampering, configuration can no longer be changed by editing the configuration file. Use the `ALTER` command and change parameter values via SQL instead. |
There was a problem hiding this comment.
The statement "configuration can no longer be changed by editing the configuration file" is too absolute and conflicts with the taosd reference that says the config file is still read on first startup (and that local parameters can be set via taos.cfg). Please clarify the scope (e.g., changes in taos.cfg only take effect on first startup / when no persisted config exists; afterwards use ALTER).
| In TDengine TSDB 3.4.0.0 and later, to improve security and prevent configuration file tampering, configuration can no longer be changed by editing the configuration file. Use the `ALTER` command and change parameter values via SQL instead. | |
| In TDengine TSDB 3.4.0.0 and later, to improve security and prevent configuration file tampering, most cluster configuration parameters are no longer updated by editing `taos.cfg` after the configuration has been persisted. The configuration file is read on first startup (or when no persisted configuration exists), and some local parameters can still be set there, but subsequent changes to configuration parameters must be made with the `ALTER` command via SQL. |
| 2. Method to modify local configuration parameters via SQL: `alter dnode <dnode_id> 'parameter_name' 'parameter_value';`, Whether the modifications take effect immediately, please refer to the "Dynamic Modification" description for each parameter. | ||
| 3. From 3.4.0.0, to prevent configuration file tampering, the `forceReadConfig` parameter has been removed. Except for the first startup, configuration will not be loaded from the configuration file. | ||
| 3. From 3.4.0.0, to prevent configuration file tampering, the `forceReadConfig` parameter has been removed. Except for the first startup, configuration items will not be loaded from the configuration file. If you need to modify configuration parameters, use the `ALTER` command and modify them via SQL. |
There was a problem hiding this comment.
This note says taosd won’t load configuration items from taos.cfg except on the first startup, but the table above still states local parameters can be modified via taos.cfg (without any version caveat). Please clarify one/both places so readers understand that editing taos.cfg only takes effect on first startup (or when no persisted config exists), and afterwards changes should be done via ALTER.
| 1. 通过 SQL 修改全局配置参数命令：`alter all dnodes ‘参数名’ ‘参数值’;`，修改后是否立即生效请参考各参数**动态修改**说明。 | ||
| 2. 通过 SQL 修改局部配置参数命令，`alter dnode <dnode_id> ‘参数名’ ‘参数值’;`，修改后是否立即生效请参考各参数**动态修改**说明。 | ||
| 3. 自 3.4.0.0 起，为防止配置文件被篡改，我们取消了 `forceReadConfig` 参数；除首次启动外，不再从配置文件中加载配置项。 | ||
| 3. 自 3.4.0.0 起，为防止配置文件被篡改，我们取消了 `forceReadConfig` 参数；除首次启动外，不再从配置文件中加载配置项，如果需要修改配置参数，请您使用 ALTER 命令，通过 SQL 的方式修改配置参数的值。。 |
There was a problem hiding this comment.
这里写到“除首次启动外，不再从配置文件中加载配置项”，但上面的表格仍写着“局部配置参数…可通过 taos.cfg 配置文件修改”。建议在此处或表格中补充版本/适用场景说明（例如：仅首次启动/无持久化配置时读取 taos.cfg；后续需通过 ALTER 通过 SQL 修改），避免读者误解修改 taos.cfg 重启即可生效。
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the documentation to reflect changes in configuration file behavior from version 3.4.0.0. The forceReadConfig parameter is removed, and configuration changes must now be made via SQL. The changes in the English documentation and FAQ are clear and accurate. I've found a minor typo in the Chinese documentation and provided a suggestion to fix it.
Note: Security Review has been skipped due to the limited scope of the PR.
| 1. 通过 SQL 修改全局配置参数命令：`alter all dnodes ‘参数名’ ‘参数值’;`，修改后是否立即生效请参考各参数**动态修改**说明。 | ||
| 2. 通过 SQL 修改局部配置参数命令，`alter dnode <dnode_id> ‘参数名’ ‘参数值’;`，修改后是否立即生效请参考各参数**动态修改**说明。 | ||
| 3. 自 3.4.0.0 起，为防止配置文件被篡改，我们取消了 `forceReadConfig` 参数；除首次启动外，不再从配置文件中加载配置项。 | ||
| 3. 自 3.4.0.0 起，为防止配置文件被篡改，我们取消了 `forceReadConfig` 参数；除首次启动外，不再从配置文件中加载配置项，如果需要修改配置参数，请您使用 ALTER 命令，通过 SQL 的方式修改配置参数的值。。 |
There was a problem hiding this comment.
There's a typo at the end of this line. The double period 。。 should be a single period 。.
| 3. 自 3.4.0.0 起，为防止配置文件被篡改，我们取消了 `forceReadConfig` 参数；除首次启动外，不再从配置文件中加载配置项，如果需要修改配置参数，请您使用 ALTER 命令，通过 SQL 的方式修改配置参数的值。。 | |
| 3. 自 3.4.0.0 起，为防止配置文件被篡改，我们取消了 `forceReadConfig` 参数；除首次启动外，不再从配置文件中加载配置项，如果需要修改配置参数，请您使用 ALTER 命令，通过 SQL 的方式修改配置参数的值。 |
Description
Issue(s)
Checklist
Please check the items in the checklist if applicable.