From c70ea8a9ece8ad085ed884f8578c4ca5fb857458 Mon Sep 17 00:00:00 2001 From: Himanshu Verma Date: Thu, 24 Sep 2026 17:58:45 +0530 Subject: [PATCH 1/2] doc(config): add schema.sync options Document schema.sync.enabled and schema.sync.reconcile_interval, added by apache/hugegraph#3237, in the EN and CN config option pages. --- content/cn/docs/config/config-option.md | 2 ++ content/en/docs/config/config-option.md | 2 ++ 2 files changed, 4 insertions(+) diff --git a/content/cn/docs/config/config-option.md b/content/cn/docs/config/config-option.md index e8b03cef72..e24353850d 100644 --- a/content/cn/docs/config/config-option.md +++ b/content/cn/docs/config/config-option.md @@ -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. | +| 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]. | diff --git a/content/en/docs/config/config-option.md b/content/en/docs/config/config-option.md index fa43f13e53..c03e9bfd99 100644 --- a/content/en/docs/config/config-option.md +++ b/content/en/docs/config/config-option.md @@ -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. | +| 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]. | From 05437da0921ff25cca486e56bf6116317bbd2ba6 Mon Sep 17 00:00:00 2001 From: Himanshu Verma Date: Thu, 24 Sep 2026 19:10:31 +0530 Subject: [PATCH 2/2] doc(config): state the rollout conditions of schema.sync Per review on apache/hugegraph#3237: the convergence bound needs every server on a release with these options, sync enabled, polling on and PD reachable, and a schema change or restart after a rolling upgrade. --- content/cn/docs/config/config-option.md | 2 +- content/en/docs/config/config-option.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/content/cn/docs/config/config-option.md b/content/cn/docs/config/config-option.md index e24353850d..2a23334891 100644 --- a/content/cn/docs/config/config-option.md +++ b/content/cn/docs/config/config-option.md @@ -134,7 +134,7 @@ 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. | +| 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. | diff --git a/content/en/docs/config/config-option.md b/content/en/docs/config/config-option.md index c03e9bfd99..36fba23eaa 100644 --- a/content/en/docs/config/config-option.md +++ b/content/en/docs/config/config-option.md @@ -135,7 +135,7 @@ 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. | +| 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. |