This is an automated email from the ASF dual-hosted git repository.
zhangliang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/shardingsphere.git
The following commit(s) were added to refs/heads/master by this push:
new 2f442d546cb Update mode.en.md (#19339)
2f442d546cb is described below
commit 2f442d546cbbeef515ca06ff04fc2c5805dae47a
Author: Swastika Gupta <[email protected]>
AuthorDate: Tue Jul 19 08:23:40 2022 +0530
Update mode.en.md (#19339)
---
docs/document/content/dev-manual/mode.en.md | 74 ++++++++++++++++++-----------
1 file changed, 47 insertions(+), 27 deletions(-)
diff --git a/docs/document/content/dev-manual/mode.en.md
b/docs/document/content/dev-manual/mode.en.md
index d3e10c1b774..b7db5729285 100644
--- a/docs/document/content/dev-manual/mode.en.md
+++ b/docs/document/content/dev-manual/mode.en.md
@@ -5,38 +5,58 @@ weight = 1
chapter = true
+++
-## SPI Interface
+## StandalonePersistRepository
-| *SPI Name* | *Description* |
-| ----------------------------- | ----------------------- |
-| StandalonePersistRepository | Standalone mode configuration information
persistence |
-| ClusterPersistRepository | Cluster mode configuration information
persistence |
-| GovernanceWatcher | Governance listener |
+### Fully-qualified class name
-## Sample
+[`org.apache.shardingsphere.mode.repository.standalone.StandalonePersistRepository`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-mode/shardingsphere-mode-type/shardingsphere-standalone-mode/shardingsphere-standalone-mode-repository/shardingsphere-standalone-mode-repository-api/src/main/java/org/apache/shardingsphere/mode/repository/standalone/StandalonePersistRepository.java)
-### StandalonePersistRepository
+### Definition
-| *Implementation Class* | *Description* |
-| ----------------------------- | -------------------------- |
-| FileRepository | File-based persistence |
-| H2Repository | H2-based persistence |
+Standalone mode configuration information persistence definition
-### ClusterPersistRepository
+### Implementation classes
-| *Implementation Class* | *Description* |
-| ----------------------------- | ------------------------- |
-| CuratorZookeeperRepository | ZooKeeper-based persistence |
-| EtcdRepository | Etcd-based persistence |
+| *Configuration Type* | *Description* |
*Fully-qualified class name* |
+| -------------------- | ----------------------------------------- |
---------------------------- |
+| FileRepository | File-based persistence | [`..`]() |
+| H2 | H2-based persistence |
[`org.apache.shardingsphere.mode.repository.standalone.h2.H2Repository`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-mode/shardingsphere-mode-type/shardingsphere-standalone-mode/shardingsphere-standalone-mode-repository/shardingsphere-standalone-mode-repository-provider/shardingsphere-standalone-mode-repository-h2/src/main/java/org/apache/shardingsphere/mode/repository/standalone/h2/H2Repository.java)
|
-### GovernanceWatcher
+## ClusterPersistRepository
-| *Implementation Class* | *Description* |
-| ----------------------------- | ------------------ |
-| ComputeNodeStateChangedWatcher | Compute node state change listener |
-| DatabaseLockChangedWatcher | Database lock state change listener |
-| DistributedLockChangedWatcher | Distributed lock change listener |
-| GlobalRuleChangedWatcher | The global rule configuration change
listener |
-| MetaDataChangedWatcher | Metadata change listener |
-| PropertiesChangedWatcher | Property change listener |
-| StorageNodeStateChangedWatcher | Storage node state change listener |
+### Fully-qualified class name
+
+[`org.apache.shardingsphere.mode.repository.cluster.ClusterPersistRepository`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-mode/shardingsphere-mode-type/shardingsphere-cluster-mode/shardingsphere-cluster-mode-repository/shardingsphere-cluster-mode-repository-api/src/main/java/org/apache/shardingsphere/mode/repository/cluster/ClusterPersistRepository.java)
+
+### Definition
+
+Cluster mode configuration information persistence definition
+
+### Implementation classes
+
+| *Configuration Type* | *Description* |
*Fully-qualified class name* |
+| -------------------- | ----------------------------------------- |
---------------------------- |
+| ZooKeeper | ZooKeeper-based persistence |
[`org.apache.shardingsphere.mode.repository.cluster.zookeeper.CuratorZookeeperRepository`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-mode/shardingsphere-mode-type/shardingsphere-cluster-mode/shardingsphere-cluster-mode-repository/shardingsphere-cluster-mode-repository-provider/shardingsphere-cluster-mode-repository-zookeeper-curator/src/main/java/org/apache/shardingsphere/mode/repository/cluster/zookeeper/Curato
[...]
+| etcd | Etcd-based persistence |
[`org.apache.shardingsphere.mode.repository.cluster.etcd.EtcdRepository`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-mode/shardingsphere-mode-type/shardingsphere-cluster-mode/shardingsphere-cluster-mode-repository/shardingsphere-cluster-mode-repository-provider/shardingsphere-cluster-mode-repository-etcd/src/main/java/org/apache/shardingsphere/mode/repository/cluster/etcd/EtcdRepository.java)
|
+
+## GovernanceWatcher
+
+### Fully-qualified class name
+
+[`org.apache.shardingsphere.mode.manager.cluster.coordinator.registry.GovernanceWatcher`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-mode/shardingsphere-mode-type/shardingsphere-cluster-mode/shardingsphere-cluster-mode-core/src/main/java/org/apache/shardingsphere/mode/manager/cluster/coordinator/registry/GovernanceWatcher.java)
+
+### Definition
+
+Governance listener definition
+
+### Implementation classes
+
+| *Configuration Type* | *Description* |
*Fully-qualified class name* |
+| -------------------- | ----------------------------------------- |
---------------------------- |
+| Arrays.asList(Type.ADDED, Type.UPDATED, Type.DELETED) ,
Collections.singleton(ComputeNode.getComputeNodePath()) | Compute node state
change listener |
[`org.apache.shardingsphere.mode.manager.cluster.coordinator.registry.status.compute.watcher.ComputeNodeStateChangedWatcher`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-mode/shardingsphere-mode-type/shardingsphere-cluster-mode/shardingsphere-cluster-mode-core/src/main/java/org/apache/shardingsphere/mode/manager/c
[...]
+| Arrays.asList(Type.ADDED, Type.DELETED) ,
Collections.singleton(lockNode.getLocksNodePath()) | Database lock state
change listener |
[`org.apache.shardingsphere.mode.manager.cluster.coordinator.lock.database.watcher.DatabaseLockChangedWatcher`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-mode/shardingsphere-mode-type/shardingsphere-cluster-mode/shardingsphere-cluster-mode-core/src/main/java/org/apache/shardingsphere/mode/manager/cluster/coordinator/lock/data
[...]
+| Arrays.asList(Type.ADDED, Type.DELETED) ,
Collections.singleton(lockNode.getLocksNodePath()) | Distributed lock change
listener |
[`org.apache.shardingsphere.mode.manager.cluster.coordinator.lock.distributed.watcher.DistributedLockChangedWatcher`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-mode/shardingsphere-mode-type/shardingsphere-cluster-mode/shardingsphere-cluster-mode-core/src/main/java/org/apache/shardingsphere/mode/manager/cluster/coordinator/lock/
[...]
+| Collections.singleton(Type.UPDATED) ,
Collections.singleton(GlobalNode.getGlobalRuleNode()) | The global rule
configuration change listener |
[`org.apache.shardingsphere.mode.manager.cluster.coordinator.registry.config.watcher.GlobalRuleChangedWatcher`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-mode/shardingsphere-mode-type/shardingsphere-cluster-mode/shardingsphere-cluster-mode-core/src/main/java/org/apache/shardingsphere/mode/manager/cluster/coordinator/reg
[...]
+| Arrays.asList(Type.ADDED, Type.UPDATED, Type.DELETED) ,
Collections.singleton(DatabaseMetaDataNode.getMetaDataNodePath()) | Metadata
change listener |
[`org.apache.shardingsphere.mode.manager.cluster.coordinator.registry.metadata.watcher.MetaDataChangedWatcher`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-mode/shardingsphere-mode-type/shardingsphere-cluster-mode/shardingsphere-cluster-mode-core/src/main/java/org/apache/shardingsphere/mode/manager/cluster/c
[...]
+| Arrays.asList(Type.UPDATED, Type.ADDED) ,
Collections.singleton(GlobalNode.getPropsPath()) | Property change listener
|
[`org.apache.shardingsphere.mode.manager.cluster.coordinator.registry.config.watcher.PropertiesChangedWatcher`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-mode/shardingsphere-mode-type/shardingsphere-cluster-mode/shardingsphere-cluster-mode-core/src/main/java/org/apache/shardingsphere/mode/manager/cluster/coordinator/registry/config/wat
[...]
+| Arrays.asList(Type.ADDED, Type.UPDATED, Type.DELETED) ,
Collections.singletonList(StorageNode.getRootPath()) | Storage node state
change listener |
[`org.apache.shardingsphere.mode.manager.cluster.coordinator.registry.status.storage.watcher.StorageNodeStateChangedWatcher`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-mode/shardingsphere-mode-type/shardingsphere-cluster-mode/shardingsphere-cluster-mode-core/src/main/java/org/apache/shardingsphere/mode/manager/clus
[...]
