Skip to content

doc(config): add schema.sync options #498

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

Draft
bitflicker64 wants to merge 2 commits into
base: master
Choose a base branch
from
+4 −0
Draft

doc(config): add schema.sync options #498

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c70ea8a
doc(config): add schema.sync options
bitflicker64 Sep 24, 2026
05437da
doc(config): state the rollout conditions of schema.sync
bitflicker64 Sep 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions content/cn/docs/config/config-option.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,8 @@ HStore 后端还会从图配置文件 `{graph-name}.properties` 中读取以下
| pd.peers | 127.0.0.1:8686 | The addresses of pd nodes, separated with commas. Only used by the hstore backend. |
| schema.illegal_name_regex | .*\s+$|~.* | The regex specified the illegal format for schema name. |
| schema.cache_capacity | 10000 | The max cache size(items) of schema cache. |
| schema.sync.enabled | true | Whether to write a per-graph schema version to PD on every schema change and check it periodically, so that a schema change made through another server clears this server's schema cache. Only for the hstore backend. Set false to keep the previous behavior: no version writes, no checks. The convergence bound holds only when every server of the graph runs a release with these options, with schema.sync.enabled=true, schema.sync.reconcile_interval above 0 and PD reachable. Older servers write no version for schema updates, so after a rolling upgrade make one schema change, or restart the servers, to reload every server's schema cache. |
| schema.sync.reconcile_interval | 10 | The interval in seconds to check the schema version of a graph in PD. A schema change made through another server is visible on this server within about this interval. 0 means never check: the version is still written for other servers, and a failed write is retried by the next schema change. |
| schema.init_template | | The template schema used to init graph. |
| schema.index_rebuild_using_pushdown | true | Whether to use pushdown when to create/rebuild index. |
| vertex.cache_type | l2 | The type of vertex cache, allowed values are [l1, l2]. |
Expand Down
2 changes: 2 additions & 0 deletions content/en/docs/config/config-option.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,8 @@ Basic Config Options and Backend Config Options correspond to configuration file
| pd.peers | 127.0.0.1:8686 | The addresses of pd nodes, separated with commas. Only used by the hstore backend. |
| schema.illegal_name_regex | .*\s+$|~.* | The regex specified the illegal format for schema name. |
| schema.cache_capacity | 10000 | The max cache size(items) of schema cache. |
| schema.sync.enabled | true | Whether to write a per-graph schema version to PD on every schema change and check it periodically, so that a schema change made through another server clears this server's schema cache. Only for the hstore backend. Set false to keep the previous behavior: no version writes, no checks. The convergence bound holds only when every server of the graph runs a release with these options, with schema.sync.enabled=true, schema.sync.reconcile_interval above 0 and PD reachable. Older servers write no version for schema updates, so after a rolling upgrade make one schema change, or restart the servers, to reload every server's schema cache. |

@bitflicker64 bitflicker64 Sep 24, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor: These two rows (and CN lines 137-138) give no release for the options. They exist only in apache/hugegraph#3237, which is still open; git grep schema.sync on apache/hugegraph master finds nothing, and master's <revision> is 1.7.0, the latest release. A 1.7.0 server that reads schema.sync.enabled=true only logs "The config option 'schema.sync.enabled' is redundant" (HugeConfig.java:113) and keeps the old behavior. So a reader running 1.7.0 with several HStore servers could take this page to mean schema caches already converge across servers. The same table already marks release-specific content with "For version 1.7.0+" in the backend row.

Requested change: add a short release note to both rows in EN and CN, for example "Available since the release that includes apache/hugegraph#3237" or the concrete version once it is known, and keep this PR unmerged until #3237 lands.

| schema.sync.reconcile_interval | 10 | The interval in seconds to check the schema version of a graph in PD. A schema change made through another server is visible on this server within about this interval. 0 means never check: the version is still written for other servers, and a failed write is retried by the next schema change. |
| schema.init_template | | The template schema used to init graph. |
| schema.index_rebuild_using_pushdown | true | Whether to use pushdown when to create/rebuild index. |
| vertex.cache_type | l2 | The type of vertex cache, allowed values are [l1, l2]. |
Expand Down
Loading