docs: update forcReadConfig paras#34741
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the TDengine documentation to reflect the removal/deprecation of the forceReadConfig mechanism and the shift toward SQL (ALTER) as the supported way to change configuration after startup (notably starting in 3.4.0.0).
Changes:
- Update the Chinese training FAQ entry about config changes not taking effect after restart.
- Remove
forceReadConfigfrom the zh/en “config scope comparison” tables. - Update zh/en
taosddocs to stateforceReadConfigis removed/deprecated and adjust supported version notes.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/zh/27-train-faq/01-faq.md | Revises FAQ explanation for config changes not applying after restart |
| docs/zh/14-reference/01-components/08-config-scope.md | Removes forceReadConfig row from scope comparison table |
| docs/zh/14-reference/01-components/01-taosd.md | Adds note about removal; marks forceReadConfig as deprecated in 3.4.0.0 |
| docs/en/14-reference/01-components/08-config-scope.md | Removes forceReadConfig row from scope comparison table |
| docs/en/14-reference/01-components/01-taosd.md | Adds note about removal; bounds forceReadConfig supported versions in table |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - 最小值：0 | ||
| - 最大值：1 | ||
| - 参数类型：局部配置参数 | ||
| - 动态修改：不支持 | ||
| - 支持版本：v3.3.5.0 引入 | ||
| - 支持版本：v3.3.5.0 引入，v3.4.0.0 废弃 |
There was a problem hiding this comment.
forceReadConfig 已标注“v3.4.0.0 废弃”，但参数说明仍在描述 0/1 决定是否使用配置文件中的局部配置参数，容易让读者误以为 3.4+ 仍可通过该参数生效。建议在该参数说明中补充：3.4.0.0 起该参数已移除/被忽略（无效），仅适用于 3.3.5.0~3.3.x。
| Additional Notes: | ||
|
|
||
| 1. Method to modify global configuration parameters via SQL: `alter all dnodes 'parameter_name' 'parameter_value';`, Whether the modifications take effect immediately, please refer to the "Dynamic Modification" description for each parameter. | ||
| 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. To modify local configuration parameters via taos.cfg configuration file, set the `forceReadConfig` parameter to 1 and restart for changes to take effect. | ||
| 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. |
There was a problem hiding this comment.
The note says configuration is not loaded from the configuration file except on first startup, but the table above still lists “Modify via taos.cfg configuration file” as a general method for local parameters. Please reconcile these statements (e.g., clarify “taos.cfg is only used for initial bootstrap in 3.4.0.0+” or remove the config-file method from the table for current versions). Also, docs/en/27-train-faq/index.md still instructs users to set forceReadConfig 1, which contradicts this removal and should be updated for 3.4.0.0+.
| 1. Method to modify global configuration parameters via SQL: `alter all dnodes 'parameter_name' 'parameter_value';`, Whether the modifications take effect immediately, please refer to the "Dynamic Modification" description for each parameter. | ||
| 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. To modify local configuration parameters via taos.cfg configuration file, set the `forceReadConfig` parameter to 1 and restart for changes to take effect. | ||
| 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. |
There was a problem hiding this comment.
Grammar: “From 3.4.0.0, … Except for the first startup …” is awkward English. Consider “Starting from 3.4.0.0, … Except on the first startup, …” (or “After the first startup, …”).
| 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. Starting from version 3.4.0.0, to prevent configuration file tampering, the `forceReadConfig` parameter has been removed. After the first startup, configuration will no longer be loaded from the configuration file. |
| 1. 通过 SQL 修改全局配置参数命令：`alter all dnodes ‘参数名’ ‘参数值’;`，修改后是否立即生效请参考各参数**动态修改**说明。 | ||
| 2. 通过 SQL 修改局部配置参数命令，`alter dnode <dnode_id> ‘参数名’ ‘参数值’;`，修改后是否立即生效请参考各参数**动态修改**说明。 | ||
| 3. 通过 taos.cfg 配置文件修改局部配置参数，修改后需把 `forceReadConfig` 参数设为 1 并重启后方可生效。 | ||
| 3. 自 3.4.0.0 起，为防止配置文件被篡改，我们取消了 `forceReadConfig` 参数；除首次启动外，不再从配置文件中加载配置项。 |
There was a problem hiding this comment.
这里说明 3.4.0.0 起“除首次启动外，不再从配置文件中加载配置项”，但上方“局部配置参数”的“修改方法”仍写包含“通过 taos.cfg 配置文件修改”。两处表述存在冲突，建议在表格/补充说明中明确：配置文件仅用于首次启动初始化，后续修改需要通过 ALTER（或删除表格中的配置文件修改方式）。
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| | **调试相关** | | | | ||
| | enableCoreFile | both | crash 时是否生成 core 文件 | | ||
| | configDir | both | 配置文件所在目录 | | ||
| | forceReadConfig | taosd | 是否使用持久化的局部配置参数 | | ||
| | scriptDir | both | 测试工具的脚本目录 | | ||
| | assert | both | 断言控制开关 | |
There was a problem hiding this comment.
这里从作用范围对比表中移除了 forceReadConfig，但在同目录的 taosd 参考里该参数仍被记录（并标注 v3.4.0.0 废弃）。如果文档仍需要覆盖 3.3.5.x～3.3.x 的版本，这会造成跨文档不一致。建议要么在本表中保留 forceReadConfig 并注明支持版本区间，要么在本页增加说明明确该参数已在 3.4.0.0 移除/废弃以及为何不再列出。
| | **Debugging Related** | | | | ||
| | enableCoreFile | both | Whether to generate a core file when crashing | | ||
| | configDir | both | Directory where the configuration files are located | | ||
| | forceReadConfig | taosd | Whether to force reading configuration from file | | ||
| | scriptDir | both | Directory for internal test tool scripts | | ||
| | assert | both | Assertion control switch | |
There was a problem hiding this comment.
This scope comparison table removes forceReadConfig, but the taosd reference in the same docs section still documents the parameter (with a version range ending before 3.4.0.0). If the docs still cover pre-3.4 releases, this creates cross-page inconsistency. Consider either keeping forceReadConfig here with its supported version range, or adding an explicit note that it was removed/deprecated in 3.4.0.0 and therefore omitted from the scope table.
| 问题描述： | ||
| TDengine TSDB 3.3.5.0 及以上的版本，有些用户可能会遇到一个问题：我在 `taos.cfg` 中修改了某个配置参数，但是重启后发现并没有生效，查看日志也找不到任何报错。 | ||
| TDengine TSDB 3.4.0.0 及以上的版本，有些用户可能会遇到一个问题：我在 `taos.cfg` 中修改了某个配置参数，但是重启后发现并没有生效，查看日志也找不到任何报错。 | ||
|
|
||
| 问题原因： | ||
| 这是由于 TDengine TSDB 3.3.5.0 及以上的版本支持将动态修改的配置参数持久化，也就是您通过 `ALTER` 动态修改的参数，重启后仍然生效。所以 TDengine TSDB 3.3.5.0 及以上的版本在重启时会默认从 `dataDir` 中加载除了 `dataDir` 之外的的配置参数，而不会使用 `taos.cfg` 中的配置参数。 | ||
|
|
||
| 问题解决： | ||
| 如果您了解了配置参数持久化的功能，仍然希望重启后从配置文件中加载配置参数，可以通过在配置文件中增加 `forceReadConfig 1` 这将会使 TDengine TSDB 强制从配置文件中读取配置参数。 | ||
| 这是由于 TDengine TSDB 3.4.0.0 及以上版本，为了进一步提升 TDengine TSDB 的安全等级，防止恶意篡改配置文件，TDengine TSDB 禁止通过修改配置文件来改变配置参数，请您使用 ALTER 命令，通过 SQL 的方式修改配置参数的值。 |
There was a problem hiding this comment.
该条目把“解决办法（请使用 ALTER 通过 SQL 修改）”写进了“问题原因”段落里，而且表述为“禁止通过修改配置文件来改变配置参数”会让人理解为任何情况下都不会读取配置文件；但 taosd 参考里同时提到“除首次启动外不再从配置文件加载”。建议：新增/恢复“问题解决”小节并将 ALTER 的指引移入其中，同时在原因里明确限定为“除首次启动外/重启后不会从配置文件加载”，避免与其它文档表述冲突。
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 for TDengine TSDB to reflect significant changes in how configuration parameters are handled from version 3.4.0.0 onwards. The primary goal is to enhance security by preventing configuration file tampering, which led to the removal of the 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
|
![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 across several files to reflect the removal of the forceReadConfig parameter and the new configuration loading behavior from version 3.4.0.0 onwards. The changes accurately communicate that configuration files will no longer be loaded after the first startup to prevent tampering, and users should use ALTER commands for parameter modification. The updates are consistent in both English and Chinese documentation, ensuring clarity and correctness regarding this significant change in TDengine's configuration management.
Note: Security Review has been skipped due to the limited scope of the PR.
guanshengliang
changed the title
Description
Issue(s)
Checklist
Please check the items in the checklist if applicable.