This is an automated email from the ASF dual-hosted git repository.
duanzhengqiang 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 3403c7049cc Update agent and config document for dev-manual (#19238)
3403c7049cc is described below
commit 3403c7049cc3f08de7053290affa4887bfe39d97
Author: Liang Zhang <[email protected]>
AuthorDate: Fri Jul 15 18:03:32 2022 +0800
Update agent and config document for dev-manual (#19238)
* Update agent document
* Update config document
* Update agent document
* Update config document
* Update agent document
* Update config document
---
docs/document/content/dev-manual/agent.cn.md | 71 +++++++-----
docs/document/content/dev-manual/agent.en.md | 58 ++++++----
.../content/dev-manual/configuration.cn.md | 128 ++++++++++++---------
.../content/dev-manual/configuration.en.md | 128 ++++++++++++---------
4 files changed, 223 insertions(+), 162 deletions(-)
diff --git a/docs/document/content/dev-manual/agent.cn.md
b/docs/document/content/dev-manual/agent.cn.md
index 41c88e9b48a..7593c86fb0f 100644
--- a/docs/document/content/dev-manual/agent.cn.md
+++ b/docs/document/content/dev-manual/agent.cn.md
@@ -5,33 +5,44 @@ weight = 14
chapter = true
+++
-## SPI 接口
-
-| *SPI 名称* | *详细说明* |
-|---------------- |------------ |
-| PluginDefinitionService | Agent 插件定义 |
-| PluginBootService | 插件启动服务定义 |
-
-## 示例
-### PluginDefinitionService
-
-| *已知实现类* | *详细说明* |
-|-------------------------------- |----------------------- |
-| PrometheusPluginDefinitionService | Prometheus plugin |
-| BaseLoggingPluginDefinitionService | Logging plugin |
-| JaegerPluginDefinitionService | Jaeger plugin |
-| OpenTelemetryTracingPluginDefinitionService | OpenTelemetryTracing plugin
|
-| OpenTracingPluginDefinitionService | OpenTracing plugin |
-| ZipkinPluginDefinitionService | Zipkin plugin |
-
-
-### PluginBootService
-
-| *已知实现类* | *详细说明* |
-|-------------------------------- |----------------------- |
-| PrometheusPluginBootService | Prometheus plugin 启动类 |
-| BaseLoggingPluginBootService | Logging plugin 启动类 |
-| JaegerTracingPluginBootService | Jaeger plugin 启动类 |
-| OpenTelemetryTracingPluginBootService | OpenTelemetryTracing plugin 启动类 |
-| OpenTracingPluginBootService | OpenTracing plugin 启动类 |
-| ZipkinTracingPluginBootService | Zipkin plugin 启动类 |
+## PluginBootService
+
+### 全限定类名
+
+[`org.apache.shardingsphere.agent.spi.boot.PluginBootService`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-agent/shardingsphere-agent-api/src/main/java/org/apache/shardingsphere/agent/spi/boot/PluginBootService.java)
+
+### 定义
+
+插件启动服务定义接口
+
+### 已知实现
+
+| *配置标识* | *详细说明* | *全限定类名* |
+| ------------- | --------------------------------- | ---------- |
+| Prometheus | Prometheus plugin 启动类 |
[`org.apache.shardingsphere.agent.metrics.prometheus.service.PrometheusPluginBootService`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-agent/shardingsphere-agent-plugins/shardingsphere-agent-plugin-metrics/shardingsphere-agent-metrics-prometheus/src/main/java/org/apache/shardingsphere/agent/metrics/prometheus/service/PrometheusPluginBootService.java)
|
+| Logging | Logging plugin 启动类 |
[`org.apache.shardingsphere.agent.plugin.logging.base.service.BaseLoggingPluginBootService`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-agent/shardingsphere-agent-plugins/shardingsphere-agent-plugin-logging/shardingsphere-agent-logging-base/src/main/java/org/apache/shardingsphere/agent/plugin/logging/base/service/BaseLoggingPluginBootService.java)
|
+| Jaeger | Jaeger plugin 启动类 |
[`org.apache.shardingsphere.agent.plugin.tracing.jaeger.service.JaegerTracingPluginBootService`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-agent/shardingsphere-agent-plugins/shardingsphere-agent-plugin-tracing/shardingsphere-agent-tracing-jaeger/src/main/java/org/apache/shardingsphere/agent/plugin/tracing/jaeger/service/JaegerTracingPluginBootService.java)
|
+| OpenTelemetry | OpenTelemetryTracing plugin 启动类 |
[`org.apache.shardingsphere.agent.plugin.tracing.opentelemetry.service.OpenTelemetryTracingPluginBootService`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-agent/shardingsphere-agent-plugins/shardingsphere-agent-plugin-tracing/shardingsphere-agent-tracing-opentelemetry/src/main/java/org/apache/shardingsphere/agent/plugin/tracing/opentelemetry/service/OpenTelemetryTracingPluginBootService.java)
|
+| OpenTracing | OpenTracing plugin 启动类 |
[`org.apache.shardingsphere.agent.plugin.tracing.opentracing.service.OpenTracingPluginBootService`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-agent/shardingsphere-agent-plugins/shardingsphere-agent-plugin-tracing/shardingsphere-agent-tracing-opentracing/src/main/java/org/apache/shardingsphere/agent/plugin/tracing/opentracing/service/OpenTracingPluginBootService.java)
|
+| Zipkin | Zipkin plugin 启动类 |
[`org.apache.shardingsphere.agent.plugin.tracing.zipkin.service.ZipkinTracingPluginBootService`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-agent/shardingsphere-agent-plugins/shardingsphere-agent-plugin-tracing/shardingsphere-agent-tracing-zipkin/src/main/java/org/apache/shardingsphere/agent/plugin/tracing/zipkin/service/ZipkinTracingPluginBootService.java)
|
+
+## PluginDefinitionService
+
+### 全限定类名
+
+[`org.apache.shardingsphere.agent.spi.definition.PluginDefinitionService`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-agent/shardingsphere-agent-api/src/main/java/org/apache/shardingsphere/agent/spi/definition/PluginDefinitionService.java)
+
+### 定义
+
+探针插件定义服务接口
+
+### 已知实现
+
+| *配置标识* | *详细说明* | *全限定类名* |
+| ------------- | --------------------------- | ---------- |
+| Prometheus | Prometheus 插件定义 |
[`org.apache.shardingsphere.agent.metrics.prometheus.definition.PrometheusPluginDefinitionService`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-agent/shardingsphere-agent-plugins/shardingsphere-agent-plugin-metrics/shardingsphere-agent-metrics-prometheus/src/main/java/org/apache/shardingsphere/agent/metrics/prometheus/definition/PrometheusPluginDefinitionService.java)
|
+| Logging | Logging 插件定义 |
[`org.apache.shardingsphere.agent.plugin.logging.base.definition.BaseLoggingPluginDefinitionService`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-agent/shardingsphere-agent-plugins/shardingsphere-agent-plugin-logging/shardingsphere-agent-logging-base/src/main/java/org/apache/shardingsphere/agent/plugin/logging/base/definition/BaseLoggingPluginDefinitionService.java)
|
+| Jaeger | Jaeger 插件定义 |
[`org.apache.shardingsphere.agent.plugin.tracing.jaeger.definition.JaegerPluginDefinitionService`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-agent/shardingsphere-agent-plugins/shardingsphere-agent-plugin-tracing/shardingsphere-agent-tracing-jaeger/src/main/java/org/apache/shardingsphere/agent/plugin/tracing/jaeger/definition/JaegerPluginDefinitionService.java)
|
+| OpenTelemetry | OpenTelemetryTracing 插件定义 |
[`org.apache.shardingsphere.agent.plugin.tracing.opentelemetry.definition.OpenTelemetryTracingPluginDefinitionService`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-agent/shardingsphere-agent-plugins/shardingsphere-agent-plugin-tracing/shardingsphere-agent-tracing-opentelemetry/src/main/java/org/apache/shardingsphere/agent/plugin/tracing/opentelemetry/definition/OpenTelemetryTracingPluginDefinitionService.java)
|
+| OpenTracing | OpenTracing 插件定义 |
[`org.apache.shardingsphere.agent.plugin.tracing.opentracing.definition.OpenTracingPluginDefinitionService`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-agent/shardingsphere-agent-plugins/shardingsphere-agent-plugin-tracing/shardingsphere-agent-tracing-opentracing/src/main/java/org/apache/shardingsphere/agent/plugin/tracing/opentracing/definition/OpenTracingPluginDefinitionService.java)
|
+| Zipkin | Zipkin 插件定义 |
[`org.apache.shardingsphere.agent.plugin.tracing.zipkin.definition.ZipkinPluginDefinitionService`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-agent/shardingsphere-agent-plugins/shardingsphere-agent-plugin-tracing/shardingsphere-agent-tracing-zipkin/src/main/java/org/apache/shardingsphere/agent/plugin/tracing/zipkin/definition/ZipkinPluginDefinitionService.java)
|
diff --git a/docs/document/content/dev-manual/agent.en.md
b/docs/document/content/dev-manual/agent.en.md
index 21054d9f8e2..8a9168542e4 100644
--- a/docs/document/content/dev-manual/agent.en.md
+++ b/docs/document/content/dev-manual/agent.en.md
@@ -5,34 +5,44 @@ weight = 14
chapter = true
+++
-## SPI Interface
+## PluginBootService
-| *SPI Name* | *Description* |
-|---------------- |------------ |
-| PluginDefinitionService | Agent plugin definition |
-| PluginBootService | Plugin startup service definition |
+### Fully-qualified class name
-## Sample
-### PluginDefinitionService
+[`org.apache.shardingsphere.agent.spi.boot.PluginBootService`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-agent/shardingsphere-agent-api/src/main/java/org/apache/shardingsphere/agent/spi/boot/PluginBootService.java)
-| *Implementation Class* | *Description* |
-|-------------------------------- |----------------------- |
-| PrometheusPluginDefinitionService | Prometheus plugin |
-| BaseLoggingPluginDefinitionService | Logging plugin |
-| JaegerPluginDefinitionService | Jaeger plugin |
-| OpenTelemetryTracingPluginDefinitionService | OpenTelemetryTracing plugin
|
-| OpenTracingPluginDefinitionService | OpenTracing plugin |
-| ZipkinPluginDefinitionService | Zipkin plugin |
+### Definition
+Plugin startup service definition
-### PluginBootService
+### Implementation classes
+| *Configuration Type* | *Description* |
*Fully-qualified class name* |
+| -------------------- | ----------------------------------------- |
---------------------------- |
+| Prometheus | Prometheus plugin startup class |
[`org.apache.shardingsphere.agent.metrics.prometheus.service.PrometheusPluginBootService`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-agent/shardingsphere-agent-plugins/shardingsphere-agent-plugin-metrics/shardingsphere-agent-metrics-prometheus/src/main/java/org/apache/shardingsphere/agent/metrics/prometheus/service/PrometheusPluginBootService.java)
|
+| Logging | Logging plugin startup class |
[`org.apache.shardingsphere.agent.plugin.logging.base.service.BaseLoggingPluginBootService`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-agent/shardingsphere-agent-plugins/shardingsphere-agent-plugin-logging/shardingsphere-agent-logging-base/src/main/java/org/apache/shardingsphere/agent/plugin/logging/base/service/BaseLoggingPluginBootService.java)
|
+| Jaeger | Jaeger plugin startup class |
[`org.apache.shardingsphere.agent.plugin.tracing.jaeger.service.JaegerTracingPluginBootService`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-agent/shardingsphere-agent-plugins/shardingsphere-agent-plugin-tracing/shardingsphere-agent-tracing-jaeger/src/main/java/org/apache/shardingsphere/agent/plugin/tracing/jaeger/service/JaegerTracingPluginBootService.java)
|
+| OpenTelemetry | OpenTelemetryTracing plugin startup class |
[`org.apache.shardingsphere.agent.plugin.tracing.opentelemetry.service.OpenTelemetryTracingPluginBootService`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-agent/shardingsphere-agent-plugins/shardingsphere-agent-plugin-tracing/shardingsphere-agent-tracing-opentelemetry/src/main/java/org/apache/shardingsphere/agent/plugin/tracing/opentelemetry/service/OpenTelemetryTracingPluginBootService.java)
|
+| OpenTracing | OpenTracing plugin startup class |
[`org.apache.shardingsphere.agent.plugin.tracing.opentracing.service.OpenTracingPluginBootService`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-agent/shardingsphere-agent-plugins/shardingsphere-agent-plugin-tracing/shardingsphere-agent-tracing-opentracing/src/main/java/org/apache/shardingsphere/agent/plugin/tracing/opentracing/service/OpenTracingPluginBootService.java)
|
+| Zipkin | Zipkin plugin startup class |
[`org.apache.shardingsphere.agent.plugin.tracing.zipkin.service.ZipkinTracingPluginBootService`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-agent/shardingsphere-agent-plugins/shardingsphere-agent-plugin-tracing/shardingsphere-agent-tracing-zipkin/src/main/java/org/apache/shardingsphere/agent/plugin/tracing/zipkin/service/ZipkinTracingPluginBootService.java)
|
-| *Implementation Class* | *Description* |
-|-------------------------------- |---------------- |
-| PrometheusPluginBootService | Prometheus plugin startup class |
-| BaseLoggingPluginBootService | Logging plugin startup class |
-| JaegerTracingPluginBootService | Jaeger plugin startup class |
-| OpenTelemetryTracingPluginBootService | OpenTelemetryTracing plugin startup
class |
-| OpenTracingPluginBootService | OpenTracing plugin startup class |
-| ZipkinTracingPluginBootService | Zipkin plugin startup class |
+## PluginDefinitionService
+
+### Fully-qualified class name
+
+[`org.apache.shardingsphere.agent.spi.definition.PluginDefinitionService`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-agent/shardingsphere-agent-api/src/main/java/org/apache/shardingsphere/agent/spi/definition/PluginDefinitionService.java)
+
+### Definition
+
+Agent plugin definition
+
+### Implementation classes
+
+| *Configuration Type* | *Description* |
*Fully-qualified class name* |
+| -------------------- |--------------------------------------- |
---------------------------- |
+| Prometheus | Prometheus plugin definition |
[`org.apache.shardingsphere.agent.metrics.prometheus.definition.PrometheusPluginDefinitionService`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-agent/shardingsphere-agent-plugins/shardingsphere-agent-plugin-metrics/shardingsphere-agent-metrics-prometheus/src/main/java/org/apache/shardingsphere/agent/metrics/prometheus/definition/PrometheusPluginDefinitionService.java)
|
+| Logging | Logging plugin definition |
[`org.apache.shardingsphere.agent.plugin.logging.base.definition.BaseLoggingPluginDefinitionService`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-agent/shardingsphere-agent-plugins/shardingsphere-agent-plugin-logging/shardingsphere-agent-logging-base/src/main/java/org/apache/shardingsphere/agent/plugin/logging/base/definition/BaseLoggingPluginDefinitionService.java)
|
+| Jaeger | Jaeger plugin definition |
[`org.apache.shardingsphere.agent.plugin.tracing.jaeger.definition.JaegerPluginDefinitionService`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-agent/shardingsphere-agent-plugins/shardingsphere-agent-plugin-tracing/shardingsphere-agent-tracing-jaeger/src/main/java/org/apache/shardingsphere/agent/plugin/tracing/jaeger/definition/JaegerPluginDefinitionService.java)
|
+| OpenTelemetry | OpenTelemetryTracing plugin definition |
[`org.apache.shardingsphere.agent.plugin.tracing.opentelemetry.definition.OpenTelemetryTracingPluginDefinitionService`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-agent/shardingsphere-agent-plugins/shardingsphere-agent-plugin-tracing/shardingsphere-agent-tracing-opentelemetry/src/main/java/org/apache/shardingsphere/agent/plugin/tracing/opentelemetry/definition/OpenTelemetryTracingPluginDefinitionSe
[...]
+| OpenTracing | OpenTracing plugin definition |
[`org.apache.shardingsphere.agent.plugin.tracing.opentracing.definition.OpenTracingPluginDefinitionService`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-agent/shardingsphere-agent-plugins/shardingsphere-agent-plugin-tracing/shardingsphere-agent-tracing-opentracing/src/main/java/org/apache/shardingsphere/agent/plugin/tracing/opentracing/definition/OpenTracingPluginDefinitionService.java)
|
+| Zipkin | Zipkin plugin definition |
[`org.apache.shardingsphere.agent.plugin.tracing.zipkin.definition.ZipkinPluginDefinitionService`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-agent/shardingsphere-agent-plugins/shardingsphere-agent-plugin-tracing/shardingsphere-agent-tracing-zipkin/src/main/java/org/apache/shardingsphere/agent/plugin/tracing/zipkin/definition/ZipkinPluginDefinitionService.java)
|
diff --git a/docs/document/content/dev-manual/configuration.cn.md
b/docs/document/content/dev-manual/configuration.cn.md
index 28b16677ca4..57179e10c9f 100644
--- a/docs/document/content/dev-manual/configuration.cn.md
+++ b/docs/document/content/dev-manual/configuration.cn.md
@@ -5,57 +5,77 @@ weight = 2
chapter = true
+++
-## SPI 接口
-
-| *SPI 名称* | *详细说明*
|
-| ---------------------------------------------- |
----------------------------------------------- |
-| RuleBuilder | 用于将用户配置转化为规则对象
|
-| YamlRuleConfigurationSwapper | 用于将 YAML 配置转化为标准用户配置
|
-| ShardingSphereYamlConstruct | 用于将定制化对象和 YAML 相互转化
|
-
-## 示例
-
-### RuleBuilder
-
-| *已知实现类* | *详细说明*
|
-|------------------------------------------------|-------------------------------|
-| AlgorithmProvidedReadwriteSplittingRuleBuilder | 用于将基于算法的读写分离用户配置转化为读写分离规则对象
|
-| AlgorithmProvidedDatabaseDiscoveryRuleBuilder |
用于将基于算法的数据库发现用户配置转化为数据库发现规则对象 |
-| AlgorithmProvidedShardingRuleBuilder | 用于将基于算法的分片用户配置转化为分片规则对象
|
-| AlgorithmProvidedEncryptRuleBuilder | 用于将基于算法的加密用户配置转化为加密规则对象
|
-| AlgorithmProvidedShadowRuleBuilder | 用于将基于算法的影子库用户配置转化为影子库规则对象
|
-| ReadwriteSplittingRuleBuilder | 用于将读写分离用户配置转化为读写分离规则对象
|
-| DatabaseDiscoveryRuleBuilder | 用于将数据库发现用户配置转化为数据库发现规则对象
|
-| SingleTableRuleBuilder | 用于将单表用户配置转化为单表规则对象
|
-| AuthorityRuleBuilder | 用于将权限用户配置转化为权限规则对象
|
-| ShardingRuleBuilder | 用于将分片用户配置转化为分片规则对象
|
-| EncryptRuleBuilder | 用于将加密用户配置转化为加密规则对象
|
-| ShadowRuleBuilder | 用于将影子库用户配置转化为影子库规则对象
|
-| TransactionRuleBuilder | 用于将事务用户配置转化为事务规则对象
|
-| SQLParserRuleBuilder | 用于将 SQL 解析用户配置转化为 SQL
解析规则对象 |
-
-### YamlRuleConfigurationSwapper
-| *已知实现类* | *详细说明*
|
-| ---------------------------------------------------------------
|-----------------------------------|
-| ReadwriteSplittingRuleAlgorithmProviderConfigurationYamlSwapper |
用于将基于算法的读写分离配置转化为读写分离标准配置 |
-| DatabaseDiscoveryRuleAlgorithmProviderConfigurationYamlSwapper |
用于将基于算法的数据库发现配置转化为数据库发现标准配置 |
-| ShardingRuleAlgorithmProviderConfigurationYamlSwapper |
用于将基于算法的分片配置转化为分片标准配置 |
-| EncryptRuleAlgorithmProviderConfigurationYamlSwapper |
用于将基于算法的加密配置转化为加密标准配置 |
-| ShadowRuleAlgorithmProviderConfigurationYamlSwapper |
用于将基于算法的影子库配置转化为影子库标准配置 |
-| ReadwriteSplittingRuleConfigurationYamlSwapper | 用于将读写分离的
YAML 配置转化为读写分离标准配置 |
-| DatabaseDiscoveryRuleConfigurationYamlSwapper | 用于将数据库发现的
YAML 配置转化为数据库发现标准配置 |
-| AuthorityRuleConfigurationYamlSwapper | 用于将权限规则的
YAML 配置转化为权限规则标准配置 |
-| ShardingRuleConfigurationYamlSwapper | 用于将分片的
YAML 配置转化为分片标准配置 |
-| EncryptRuleConfigurationYamlSwapper | 用于将加密的
YAML 配置转化为加密标准配置 |
-| ShadowRuleConfigurationYamlSwapper | 用于将影子库的
YAML 配置转化为影子库标准配置 |
-| TransactionRuleConfigurationYamlSwapper | 用于将事务的
YAML 配置转化为事务标准配置 |
-| SingleTableRuleConfigurationYamlSwapper | 用于将单表的
YAML 配置转化为单表标准配置 |
-| SQLParserRuleConfigurationYamlSwapper | 用于将 SQL
解析的 YAML 配置转化为 SQL 解析标准配置 |
-| SQLTranslatorRuleConfigurationYamlSwapper | 用于将 SQL
转换的 YAML 配置转化为 SQL 转换标准配置 |
-| SQLTranslatorRuleConfigurationYamlSwapper | 用于将 SQL
转换的 YAML 配置转化为 SQL 转换标准配置 |
-
-### ShardingSphereYamlConstruct
-
-| *已知实现类* | *详细说明* |
-| ---------------------------------------------- |
------------------------------- |
-| NoneShardingStrategyConfigurationYamlConstruct | 用于将不分片策略对象和 YAML 相互转化 |
+## RuleBuilder
+
+### 全限定类名
+
+[`org.apache.shardingsphere.infra.rule.builder.RuleBuilder`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-infra/shardingsphere-infra-common/src/main/java/org/apache/shardingsphere/infra/rule/builder/RuleBuilder.java)
+
+### 定义
+
+用于将用户配置转化为规则对象的接口
+
+### 已知实现
+
+| *配置标识* | *详细说明*
| *全限定类名* |
+| -------------------------------------------- |
---------------------------------------------- | ---------- |
+| AuthorityRuleConfiguration | 用于将权限用户配置转化为权限规则对象
|
[`org.apache.shardingsphere.authority.rule.builder.AuthorityRuleBuilder`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-kernel/shardingsphere-authority/shardingsphere-authority-core/src/main/java/org/apache/shardingsphere/authority/rule/builder/AuthorityRuleBuilder.java)
|
+| SQLParserRuleConfiguration | 用于将 SQL 解析用户配置转化为 SQL 解析规则对象
|
[`org.apache.shardingsphere.parser.rule.builder.SQLParserRuleBuilder`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-kernel/shardingsphere-parser/shardingsphere-parser-core/src/main/java/org/apache/shardingsphere/parser/rule/builder/SQLParserRuleBuilder.java)
|
+| TransactionRuleConfiguration | 用于将事务用户配置转化为事务规则对象
|
[`org.apache.shardingsphere.transaction.rule.builder.TransactionRuleBuilder`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-kernel/shardingsphere-transaction/shardingsphere-transaction-core/src/main/java/org/apache/shardingsphere/transaction/rule/builder/TransactionRuleBuilder.java)
|
+| SingleTableRuleConfiguration | 用于将单表用户配置转化为单表规则对象
|
[`org.apache.shardingsphere.singletable.rule.builder.SingleTableRuleBuilder`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-kernel/shardingsphere-single-table/shardingsphere-single-table-core/src/main/java/org/apache/shardingsphere/singletable/rule/builder/SingleTableRuleBuilder.java)
|
+| ShardingRuleConfiguration | 用于将分片用户配置转化为分片规则对象
|
[`org.apache.shardingsphere.sharding.rule.builder.ShardingRuleBuilder`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-features/shardingsphere-sharding/shardingsphere-sharding-core/src/main/java/org/apache/shardingsphere/sharding/rule/builder/ShardingRuleBuilder.java)
|
+| AlgorithmProvidedShardingRuleConfiguration | 用于将基于算法的分片用户配置转化为分片规则对象
|
[`org.apache.shardingsphere.sharding.rule.builder.AlgorithmProvidedShardingRuleBuilder`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-features/shardingsphere-sharding/shardingsphere-sharding-core/src/main/java/org/apache/shardingsphere/sharding/rule/builder/AlgorithmProvidedShardingRuleBuilder.java)
|
+| ReadwriteSplittingRuleConfiguration | 用于将读写分离用户配置转化为读写分离规则对象
|
[`org.apache.shardingsphere.readwritesplitting.rule.builder.ReadwriteSplittingRuleBuilder`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-features/shardingsphere-readwrite-splitting/shardingsphere-readwrite-splitting-core/src/main/java/org/apache/shardingsphere/readwritesplitting/rule/builder/ReadwriteSplittingRuleBuilder.java)
|
+| AlgorithmReadwriteSplittingRuleConfiguration | 用于将基于算法的读写分离用户配置转化为读写分离规则对象
|
[`org.apache.shardingsphere.readwritesplitting.rule.builder.AlgorithmProvidedReadwriteSplittingRuleBuilder`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-features/shardingsphere-readwrite-splitting/shardingsphere-readwrite-splitting-core/src/main/java/org/apache/shardingsphere/readwritesplitting/rule/builder/AlgorithmProvidedReadwriteSplittingRuleBuilder.java)
|
+| DatabaseDiscoveryRuleConfiguration | 用于将数据库发现用户配置转化为数据库发现规则对象
|
[`org.apache.shardingsphere.dbdiscovery.rule.builder.DatabaseDiscoveryRuleBuilder`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-features/shardingsphere-db-discovery/shardingsphere-db-discovery-core/src/main/java/org/apache/shardingsphere/dbdiscovery/rule/builder/DatabaseDiscoveryRuleBuilder.java)
|
+| AlgorithmDatabaseDiscoveryRuleConfiguration | 用于将基于算法的数据库发现用户配置转化为数据库发现规则对象
|
[`org.apache.shardingsphere.dbdiscovery.rule.builder.AlgorithmProvidedDatabaseDiscoveryRuleBuilder`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-features/shardingsphere-db-discovery/shardingsphere-db-discovery-core/src/main/java/org/apache/shardingsphere/dbdiscovery/rule/builder/AlgorithmProvidedDatabaseDiscoveryRuleBuilder.java)
|
+| EncryptRuleConfiguration | 用于将加密用户配置转化为加密规则对象
|
[`org.apache.shardingsphere.encrypt.rule.builder.EncryptRuleBuilder`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-features/shardingsphere-encrypt/shardingsphere-encrypt-core/src/main/java/org/apache/shardingsphere/encrypt/rule/builder/EncryptRuleBuilder.java)
|
+| AlgorithmEncryptRuleConfiguration | 用于将基于算法的加密用户配置转化为加密规则对象
|
[`org.apache.shardingsphere.encrypt.rule.builder.AlgorithmProvidedEncryptRuleBuilder`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-features/shardingsphere-encrypt/shardingsphere-encrypt-core/src/main/java/org/apache/shardingsphere/encrypt/rule/builder/AlgorithmProvidedEncryptRuleBuilder.java)
|
+| ShadowRuleConfiguration | 用于将影子库用户配置转化为影子库规则对象
|
[`org.apache.shardingsphere.shadow.rule.builder.ShadowRuleBuilder`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-features/shardingsphere-shadow/shardingsphere-shadow-core/src/main/java/org/apache/shardingsphere/shadow/rule/builder/ShadowRuleBuilder.java)
|
+| AlgorithmShadowRuleConfiguration | 用于将基于算法的影子库用户配置转化为影子库规则对象
|
[`org.apache.shardingsphere.shadow.rule.builder.AlgorithmProvidedShadowRuleBuilder`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-features/shardingsphere-shadow/shardingsphere-shadow-core/src/main/java/org/apache/shardingsphere/shadow/rule/builder/AlgorithmProvidedShadowRuleBuilder.java)
|
+
+## YamlRuleConfigurationSwapper
+
+### 全限定类名
+
+[`org.apache.shardingsphere.infra.yaml.config.swapper.YamlRuleConfigurationSwapper`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-infra/shardingsphere-infra-common/src/main/java/org/apache/shardingsphere/infra/yaml/config/swapper/YamlRuleConfigurationSwapper.java)
+
+### 定义
+
+用于将 YAML 配置转化为标准用户配置
+
+### 已知实现
+
+| *配置标识* | *详细说明* | *全限定类名* |
+| ------------------- | -------------------------------------------- |
----------- |
+| AUTHORITY | 用于将权限规则的 YAML 配置转化为权限规则标准配置 |
[`org.apache.shardingsphere.authority.yaml.swapper.AuthorityRuleConfigurationYamlSwapper`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-kernel/shardingsphere-authority/shardingsphere-authority-core/src/main/java/org/apache/shardingsphere/authority/yaml/swapper/AuthorityRuleConfigurationYamlSwapper.java)
|
+| SQL_PARSER | 用于将 SQL 解析的 YAML 配置转化为 SQL 解析标准配置 |
[`org.apache.shardingsphere.parser.yaml.swapper.SQLParserRuleConfigurationYamlSwapper`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-kernel/shardingsphere-parser/shardingsphere-parser-core/src/main/java/org/apache/shardingsphere/parser/yaml/swapper/SQLParserRuleConfigurationYamlSwapper.java)
|
+| TRANSACTION | 用于将事务的 YAML 配置转化为事务标准配置 |
[`org.apache.shardingsphere.transaction.yaml.swapper.TransactionRuleConfigurationYamlSwapper`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-kernel/shardingsphere-transaction/shardingsphere-transaction-core/src/main/java/org/apache/shardingsphere/transaction/yaml/swapper/TransactionRuleConfigurationYamlSwapper.java)
|
+| SINGLE | 用于将单表的 YAML 配置转化为单表标准配置 |
[`org.apache.shardingsphere.singletable.yaml.config.swapper.SingleTableRuleConfigurationYamlSwapper`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-kernel/shardingsphere-single-table/shardingsphere-single-table-core/src/main/java/org/apache/shardingsphere/singletable/yaml/config/swapper/SingleTableRuleConfigurationYamlSwapper.java)
|
+| SHARDING | 用于将分片的 YAML 配置转化为分片标准配置 |
[`org.apache.shardingsphere.sharding.yaml.swapper.ShardingRuleConfigurationYamlSwapper`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-features/shardingsphere-sharding/shardingsphere-sharding-core/src/main/java/org/apache/shardingsphere/sharding/yaml/swapper/ShardingRuleConfigurationYamlSwapper.java)
|
+| SHARDING | 用于将基于算法的分片配置转化为分片标准配置 |
[`org.apache.shardingsphere.sharding.yaml.swapper.ShardingRuleAlgorithmProviderConfigurationYamlSwapper`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-features/shardingsphere-sharding/shardingsphere-sharding-core/src/main/java/org/apache/shardingsphere/sharding/yaml/swapper/ShardingRuleAlgorithmProviderConfigurationYamlSwapper.java)
|
+| READWRITE_SPLITTING | 用于将读写分离的 YAML 配置转化为读写分离标准配置 |
[`org.apache.shardingsphere.readwritesplitting.yaml.swapper.ReadwriteSplittingRuleConfigurationYamlSwapper`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-features/shardingsphere-readwrite-splitting/shardingsphere-readwrite-splitting-core/src/main/java/org/apache/shardingsphere/readwritesplitting/yaml/swapper/ReadwriteSplittingRuleConfigurationYamlSwapper.java)
|
+| READWRITE_SPLITTING | 用于将基于算法的读写分离配置转化为读写分离标准配置 |
[`org.apache.shardingsphere.readwritesplitting.yaml.swapper.ReadwriteSplittingRuleAlgorithmProviderConfigurationYamlSwapper`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-features/shardingsphere-readwrite-splitting/shardingsphere-readwrite-splitting-core/src/main/java/org/apache/shardingsphere/readwritesplitting/yaml/swapper/ReadwriteSplittingRuleAlgorithmProviderConfigurationYamlSwapper.java)
|
+| DB_DISCOVERY | 用于将数据库发现的 YAML 配置转化为数据库发现标准配置 |
[`org.apache.shardingsphere.dbdiscovery.yaml.swapper.DatabaseDiscoveryRuleConfigurationYamlSwapper`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-features/shardingsphere-db-discovery/shardingsphere-db-discovery-core/src/main/java/org/apache/shardingsphere/dbdiscovery/yaml/swapper/DatabaseDiscoveryRuleConfigurationYamlSwapper.java)
|
+| DB_DISCOVERY | 用于将基于算法的数据库发现配置转化为数据库发现标准配置 |
[`org.apache.shardingsphere.dbdiscovery.yaml.swapper.DatabaseDiscoveryRuleAlgorithmProviderConfigurationYamlSwapper`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-features/shardingsphere-db-discovery/shardingsphere-db-discovery-core/src/main/java/org/apache/shardingsphere/dbdiscovery/yaml/swapper/DatabaseDiscoveryRuleAlgorithmProviderConfigurationYamlSwapper.java)
|
+| ENCRYPT | 用于将加密的 YAML 配置转化为加密标准配置 |
[`org.apache.shardingsphere.encrypt.yaml.swapper.EncryptRuleConfigurationYamlSwapper`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-features/shardingsphere-encrypt/shardingsphere-encrypt-core/src/main/java/org/apache/shardingsphere/encrypt/yaml/swapper/EncryptRuleConfigurationYamlSwapper.java)
|
+| ENCRYPT | 用于将基于算法的加密配置转化为加密标准配置 |
[`org.apache.shardingsphere.encrypt.yaml.swapper.EncryptRuleAlgorithmProviderConfigurationYamlSwapper`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-features/shardingsphere-encrypt/shardingsphere-encrypt-core/src/main/java/org/apache/shardingsphere/encrypt/yaml/swapper/EncryptRuleAlgorithmProviderConfigurationYamlSwapper.java)
|
+| SHADOW | 用于将影子库的 YAML 配置转化为影子库标准配置 |
[`org.apache.shardingsphere.shadow.yaml.swapper.ShadowRuleConfigurationYamlSwapper`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-features/shardingsphere-shadow/shardingsphere-shadow-core/src/main/java/org/apache/shardingsphere/shadow/yaml/swapper/ShadowRuleConfigurationYamlSwapper.java)
|
+| SHADOW | 用于将基于算法的影子库配置转化为影子库标准配置 |
[`org.apache.shardingsphere.shadow.yaml.swapper.ShadowRuleAlgorithmProviderConfigurationYamlSwapper`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-features/shardingsphere-shadow/shardingsphere-shadow-core/src/main/java/org/apache/shardingsphere/shadow/yaml/swapper/ShadowRuleAlgorithmProviderConfigurationYamlSwapper.java)
|
+| SQL_TRANSLATOR | 用于将 SQL 转换的 YAML 配置转化为 SQL 转换标准配置 |
[`org.apache.shardingsphere.sqltranslator.yaml.swapper.SQLTranslatorRuleConfigurationYamlSwapper`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-kernel/shardingsphere-sql-translator/shardingsphere-sql-translator-core/src/main/java/org/apache/shardingsphere/sqltranslator/yaml/swapper/SQLTranslatorRuleConfigurationYamlSwapper.java)
|
+
+## ShardingSphereYamlConstruct
+
+### 全限定类名
+
+[`org.apache.shardingsphere.infra.yaml.engine.constructor.ShardingSphereYamlConstruct`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-infra/shardingsphere-infra-common/src/main/java/org/apache/shardingsphere/infra/yaml/engine/constructor/ShardingSphereYamlConstruct.java)
+
+### 定义
+
+用于将定制化对象和 YAML 相互转化
+
+### 已知实现
+
+| *配置标识* | *详细说明* | *全限定类名*
|
+| ------------------------------------- | ------------------------------- |
---------- |
+| YamlNoneShardingStrategyConfiguration | 用于将不分片策略对象和 YAML 相互转化 |
[`org.apache.shardingsphere.sharding.yaml.engine.construct.NoneShardingStrategyConfigurationYamlConstruct`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-features/shardingsphere-sharding/shardingsphere-sharding-core/src/main/java/org/apache/shardingsphere/sharding/yaml/engine/construct/NoneShardingStrategyConfigurationYamlConstruct.java)
|
diff --git a/docs/document/content/dev-manual/configuration.en.md
b/docs/document/content/dev-manual/configuration.en.md
index 051ca76f2d5..85e0f5d5d2a 100644
--- a/docs/document/content/dev-manual/configuration.en.md
+++ b/docs/document/content/dev-manual/configuration.en.md
@@ -5,57 +5,77 @@ weight = 2
chapter = true
+++
-## SPI Interface
-
-| *SPI Name* | *Description*
|
-| ---------------------------------------------- |
----------------------------------------------- |
-| RuleBuilder | Used to convert user
configurations into rule objects |
-| YamlRuleConfigurationSwapper | Used to convert YAML
configuration to standard user configuration |
-| ShardingSphereYamlConstruct | Used to convert custom
objects and YAML to and from each other |
-
-## Sample
-
-### RuleBuilder
-
-| *Implementation Class* |
*Description* |
-|------------------------------------------------|-------------------------------|
-| AlgorithmProvidedReadwriteSplittingRuleBuilder | Used to convert
algorithm-based read-write splitting user configuration into read-write
splitting rule objects |
-| AlgorithmProvidedDatabaseDiscoveryRuleBuilder | Used to convert
algorithm-based database discovery user configuration into database discovery
rule objects |
-| AlgorithmProvidedShardingRuleBuilder | Used to convert
algorithm-based sharding user configuration into sharding rule objects |
-| AlgorithmProvidedEncryptRuleBuilder | Used to convert
algorithm-based encryption user configuration into encryption rule objects
|
-| AlgorithmProvidedShadowRuleBuilder | Used to convert
algorithm-based shadow database user configuration into shadow database rule
objects |
-| ReadwriteSplittingRuleBuilder | Used to convert read-write
splitting user configuration into read-write splitting rule objects |
-| DatabaseDiscoveryRuleBuilder | Used to convert database
discovery user configuration into database discovery rule objects |
-| SingleTableRuleBuilder | Used to convert
single-table user configuration into a single-table rule objects |
-| AuthorityRuleBuilder | Used to convert authority
user configuration into authority rule objects |
-| ShardingRuleBuilder | Used to convert sharding
user configuration into sharding rule objects |
-| EncryptRuleBuilder | Used to convert encrypted
user configuration into encryption rule objects |
-| ShadowRuleBuilder | Used to convert shadow
database user configuration into shadow database rule objects |
-| TransactionRuleBuilder | Used to convert transaction
user configuration into transaction rule objects |
-| SQLParserRuleBuilder | Used to convert SQL parser
user configuration into SQL parser rule objects |
-
-### YamlRuleConfigurationSwapper
-| *Implementation Class*
| *Description* |
-| ---------------------------------------------------------------
|-----------------------------------|
-| ReadwriteSplittingRuleAlgorithmProviderConfigurationYamlSwapper | Used to
convert algorithm-based read-write splitting configuration into read-write
splitting standard configuration |
-| DatabaseDiscoveryRuleAlgorithmProviderConfigurationYamlSwapper | Used to
convert algorithm-based database discovery configuration into database
discovery standard configuration |
-| ShardingRuleAlgorithmProviderConfigurationYamlSwapper | Used to
convert algorithm-based sharding configuration into sharding standard
configuration |
-| EncryptRuleAlgorithmProviderConfigurationYamlSwapper | Used to
convert algorithm-based encryption configuration into encryption standard
configuration |
-| ShadowRuleAlgorithmProviderConfigurationYamlSwapper | Used to
convert algorithm-based shadow database configuration into shadow database
standard configuration |
-| ReadwriteSplittingRuleConfigurationYamlSwapper | Used to
convert the YAML configuration of read-write splitting into the standard
configuration of read-write splitting |
-| DatabaseDiscoveryRuleConfigurationYamlSwapper | Used to
convert the YAML configuration of database discovery into the standard
configuration of database discovery |
-| AuthorityRuleConfigurationYamlSwapper | Used to
convert the YAML configuration of authority rules into standard configuration
of authority rules |
-| ShardingRuleConfigurationYamlSwapper | Used to
convert the YAML configuration of the sharding into the standard configuration
of the sharding |
-| EncryptRuleConfigurationYamlSwapper | Used to
convert encrypted YAML configuration into encrypted standard configuration
|
-| ShadowRuleConfigurationYamlSwapper | Used to
convert the YAML configuration of the shadow database into the standard
configuration of the shadow database |
-| TransactionRuleConfigurationYamlSwapper | Used to
convert the YAML configuration of the transaction into the standard
configuration of the transaction |
-| SingleTableRuleConfigurationYamlSwapper | Used to
convert the YAML configuration of the single table into the standard
configuration of the single table |
-| SQLParserRuleConfigurationYamlSwapper | Used to
convert the YAML configuration of the SQL parser into the standard
configuration of the SQL parser |
-| SQLTranslatorRuleConfigurationYamlSwapper | Used to
convert the YAML configuration of the SQL transformation to the SQL
transformation standard configuration |
-
-
-### ShardingSphereYamlConstruct
-
-| *Implementation Class* | *Description*
|
-| ---------------------------------------------- |
------------------------------- |
-| NoneShardingStrategyConfigurationYamlConstruct | Used to convert
non-sharding policy objects and YAML to and from each other |
+## RuleBuilder
+
+### Fully-qualified class name
+
+[`org.apache.shardingsphere.infra.rule.builder.RuleBuilder`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-infra/shardingsphere-infra-common/src/main/java/org/apache/shardingsphere/infra/rule/builder/RuleBuilder.java)
+
+### Definition
+
+Used to convert user configurations into rule objects
+
+### Implementation classes
+
+| *Configuration Type* | *Description*
| *Fully-qualified class name* |
+| --------------------------------------------------- |
--------------------------------------------------------------------------------------------------------------
| ---------------------------- |
+| AuthorityRuleConfiguration | Used to convert
authority user configuration into authority rule objects
|
[`org.apache.shardingsphere.authority.rule.builder.AuthorityRuleBuilder`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-kernel/shardingsphere-authority/shardingsphere-authority-core/src/main/java/org/apache/shardingsphere/authority/rule/builder/AuthorityRuleBuilder.java)
|
+| SQLParserRuleConfiguration | Used to convert SQL
parser user configuration into SQL parser rule objects
|
[`org.apache.shardingsphere.parser.rule.builder.SQLParserRuleBuilder`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-kernel/shardingsphere-parser/shardingsphere-parser-core/src/main/java/org/apache/shardingsphere/parser/rule/builder/SQLParserRuleBuilder.java)
|
+| TransactionRuleConfiguration | Used to convert
transaction user configuration into transaction rule objects
|
[`org.apache.shardingsphere.transaction.rule.builder.TransactionRuleBuilder`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-kernel/shardingsphere-transaction/shardingsphere-transaction-core/src/main/java/org/apache/shardingsphere/transaction/rule/builder/TransactionRuleBuilder.java)
|
+| SingleTableRuleConfiguration | Used to convert
single-table user configuration into a single-table rule objects
|
[`org.apache.shardingsphere.singletable.rule.builder.SingleTableRuleBuilder`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-kernel/shardingsphere-single-table/shardingsphere-single-table-core/src/main/java/org/apache/shardingsphere/singletable/rule/builder/SingleTableRuleBuilder.java)
|
+| ShardingRuleConfiguration | Used to convert
sharding user configuration into sharding rule objects
|
[`org.apache.shardingsphere.sharding.rule.builder.ShardingRuleBuilder`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-features/shardingsphere-sharding/shardingsphere-sharding-core/src/main/java/org/apache/shardingsphere/sharding/rule/builder/ShardingRuleBuilder.java)
|
+| AlgorithmShardingRuleConfiguration | Used to convert
algorithm-based sharding user configuration into sharding rule objects
|
[`org.apache.shardingsphere.sharding.rule.builder.AlgorithmProvidedShardingRuleBuilder`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-features/shardingsphere-sharding/shardingsphere-sharding-core/src/main/java/org/apache/shardingsphere/sharding/rule/builder/AlgorithmProvidedShardingRuleBuilder.java)
|
+| ReadwriteSplittingRuleConfiguration | Used to convert
read-write splitting user configuration into read-write splitting rule objects
|
[`org.apache.shardingsphere.readwritesplitting.rule.builder.ReadwriteSplittingRuleBuilder`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-features/shardingsphere-readwrite-splitting/shardingsphere-readwrite-splitting-core/src/main/java/org/apache/shardingsphere/readwritesplitting/rule/builder/Readwri
[...]
+| AlgorithmReadwriteSplittingRuleConfiguration | Used to convert
algorithm-based read-write splitting user configuration into read-write
splitting rule objects |
[`org.apache.shardingsphere.readwritesplitting.rule.builder.AlgorithmProvidedReadwriteSplittingRuleBuilder`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-features/shardingsphere-readwrite-splitting/shardingsphere-readwrite-splitting-core/src/main/java/org/apache/shardingsphere/readwritesplitting/rul
[...]
+| DatabaseDiscoveryRuleConfiguration | Used to convert
database discovery user configuration into database discovery rule objects
|
[`org.apache.shardingsphere.dbdiscovery.rule.builder.DatabaseDiscoveryRuleBuilder`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-features/shardingsphere-db-discovery/shardingsphere-db-discovery-core/src/main/java/org/apache/shardingsphere/dbdiscovery/rule/builder/DatabaseDiscoveryRuleBuilder.java)
|
+| AlgorithmProvidedDatabaseDiscoveryRuleConfiguration | Used to convert
algorithm-based database discovery user configuration into database discovery
rule objects |
[`org.apache.shardingsphere.dbdiscovery.rule.builder.AlgorithmProvidedDatabaseDiscoveryRuleBuilder`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-features/shardingsphere-db-discovery/shardingsphere-db-discovery-core/src/main/java/org/apache/shardingsphere/dbdiscovery/rule/builder/AlgorithmProvidedDa
[...]
+| EncryptRuleConfiguration | Used to convert
encrypted user configuration into encryption rule objects
|
[`org.apache.shardingsphere.encrypt.rule.builder.EncryptRuleBuilder`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-features/shardingsphere-encrypt/shardingsphere-encrypt-core/src/main/java/org/apache/shardingsphere/encrypt/rule/builder/EncryptRuleBuilder.java)
|
+| AlgorithmProvidedEncryptRuleConfiguration | Used to convert
algorithm-based encryption user configuration into encryption rule objects
|
[`org.apache.shardingsphere.encrypt.rule.builder.AlgorithmProvidedEncryptRuleBuilder`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-features/shardingsphere-encrypt/shardingsphere-encrypt-core/src/main/java/org/apache/shardingsphere/encrypt/rule/builder/AlgorithmProvidedEncryptRuleBuilder.java)
|
+| ShadowRuleConfiguration | Used to convert shadow
database user configuration into shadow database rule objects
|
[`org.apache.shardingsphere.shadow.rule.builder.ShadowRuleBuilder`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-features/shardingsphere-shadow/shardingsphere-shadow-core/src/main/java/org/apache/shardingsphere/shadow/rule/builder/ShadowRuleBuilder.java)
|
+| AlgorithmProvidedShadowRuleConfiguration | Used to convert
algorithm-based shadow database user configuration into shadow database rule
objects |
[`org.apache.shardingsphere.shadow.rule.builder.AlgorithmProvidedShadowRuleBuilder`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-features/shardingsphere-shadow/shardingsphere-shadow-core/src/main/java/org/apache/shardingsphere/shadow/rule/builder/AlgorithmProvidedShadowRuleBuilder.java)
|
+
+## YamlRuleConfigurationSwapper
+
+### Fully-qualified class name
+
+[`org.apache.shardingsphere.infra.yaml.config.swapper.YamlRuleConfigurationSwapper`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-infra/shardingsphere-infra-common/src/main/java/org/apache/shardingsphere/infra/yaml/config/swapper/YamlRuleConfigurationSwapper.java)
+
+### Definition
+
+Used to convert YAML configuration to standard user configuration
+
+### Implementation classes
+
+| *Configuration Type* | *Description*
|
*Fully-qualified class name* |
+| -------------------- |
----------------------------------------------------------------------------------------------------------------------
| ---------------------------- |
+| AUTHORITY | Used to convert the YAML configuration of authority
rules into standard configuration of authority rules |
[`org.apache.shardingsphere.authority.yaml.swapper.AuthorityRuleConfigurationYamlSwapper`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-kernel/shardingsphere-authority/shardingsphere-authority-core/src/main/java/org/apache/shardingsphere/authority/yaml/swapper/AuthorityRuleConfigurationYamlSwapper.java)
|
+| SQL_PARSER | Used to convert the YAML configuration of the SQL
parser into the standard configuration of the SQL parser |
[`org.apache.shardingsphere.parser.yaml.swapper.SQLParserRuleConfigurationYamlSwapper`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-kernel/shardingsphere-parser/shardingsphere-parser-core/src/main/java/org/apache/shardingsphere/parser/yaml/swapper/SQLParserRuleConfigurationYamlSwapper.java)
|
+| TRANSACTION | Used to convert the YAML configuration of the
transaction into the standard configuration of the transaction |
[`org.apache.shardingsphere.transaction.yaml.swapper.TransactionRuleConfigurationYamlSwapper`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-kernel/shardingsphere-transaction/shardingsphere-transaction-core/src/main/java/org/apache/shardingsphere/transaction/yaml/swapper/TransactionRuleConfigurationYamlSwapper.java)
|
+| SINGLE | Used to convert the YAML configuration of the single
table into the standard configuration of the single table |
[`org.apache.shardingsphere.singletable.yaml.config.swapper.SingleTableRuleConfigurationYamlSwapper`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-kernel/shardingsphere-single-table/shardingsphere-single-table-core/src/main/java/org/apache/shardingsphere/singletable/yaml/config/swapper/SingleTableRuleConfigurationYamlSwap
[...]
+| SHARDING | Used to convert the YAML configuration of the
sharding into the standard configuration of the sharding |
[`org.apache.shardingsphere.sharding.yaml.swapper.ShardingRuleConfigurationYamlSwapper`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-features/shardingsphere-sharding/shardingsphere-sharding-core/src/main/java/org/apache/shardingsphere/sharding/yaml/swapper/ShardingRuleConfigurationYamlSwapper.java)
|
+| SHARDING | Used to convert algorithm-based sharding
configuration into sharding standard configuration |
[`org.apache.shardingsphere.sharding.yaml.swapper.ShardingRuleAlgorithmProviderConfigurationYamlSwapper`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-features/shardingsphere-sharding/shardingsphere-sharding-core/src/main/java/org/apache/shardingsphere/sharding/yaml/swapper/ShardingRuleAlgorithmProviderConfigurationYamlSw
[...]
+| READWRITE_SPLITTING | Used to convert the YAML configuration of read-write
splitting into the standard configuration of read-write splitting |
[`org.apache.shardingsphere.readwritesplitting.yaml.swapper.ReadwriteSplittingRuleConfigurationYamlSwapper`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-features/shardingsphere-readwrite-splitting/shardingsphere-readwrite-splitting-core/src/main/java/org/apache/shardingsphere/readwritesplitting/yaml/swapper/ReadwriteSpli
[...]
+| READWRITE_SPLITTING | Used to convert algorithm-based read-write splitting
configuration into read-write splitting standard configuration |
[`org.apache.shardingsphere.readwritesplitting.yaml.swapper.ReadwriteSplittingRuleAlgorithmProviderConfigurationYamlSwapper`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-features/shardingsphere-readwrite-splitting/shardingsphere-readwrite-splitting-core/src/main/java/org/apache/shardingsphere/readwritesplitting/yaml/swap
[...]
+| DB_DISCOVERY | Used to convert the YAML configuration of database
discovery into the standard configuration of database discovery |
[`org.apache.shardingsphere.dbdiscovery.yaml.swapper.DatabaseDiscoveryRuleConfigurationYamlSwapper`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-features/shardingsphere-db-discovery/shardingsphere-db-discovery-core/src/main/java/org/apache/shardingsphere/dbdiscovery/yaml/swapper/DatabaseDiscoveryRuleConfigurationYamlSwap
[...]
+| DB_DISCOVERY | Used to convert algorithm-based database discovery
configuration into database discovery standard configuration |
[`org.apache.shardingsphere.dbdiscovery.yaml.swapper.DatabaseDiscoveryRuleAlgorithmProviderConfigurationYamlSwapper`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-features/shardingsphere-db-discovery/shardingsphere-db-discovery-core/src/main/java/org/apache/shardingsphere/dbdiscovery/yaml/swapper/DatabaseDiscoveryRuleAlgo
[...]
+| ENCRYPT | Used to convert encrypted YAML configuration into
encrypted standard configuration |
[`org.apache.shardingsphere.encrypt.yaml.swapper.EncryptRuleConfigurationYamlSwapper`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-features/shardingsphere-encrypt/shardingsphere-encrypt-core/src/main/java/org/apache/shardingsphere/encrypt/yaml/swapper/EncryptRuleConfigurationYamlSwapper.java)
|
+| ENCRYPT | Used to convert algorithm-based encryption
configuration into encryption standard configuration |
[`org.apache.shardingsphere.encrypt.yaml.swapper.EncryptRuleAlgorithmProviderConfigurationYamlSwapper`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-features/shardingsphere-encrypt/shardingsphere-encrypt-core/src/main/java/org/apache/shardingsphere/encrypt/yaml/swapper/EncryptRuleAlgorithmProviderConfigurationYamlSwapper.java)
|
+| SHADOW | Used to convert the YAML configuration of the shadow
database into the standard configuration of the shadow database |
[`org.apache.shardingsphere.shadow.yaml.swapper.ShadowRuleConfigurationYamlSwapper`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-features/shardingsphere-shadow/shardingsphere-shadow-core/src/main/java/org/apache/shardingsphere/shadow/yaml/swapper/ShadowRuleConfigurationYamlSwapper.java)
|
+| SHADOW | Used to convert algorithm-based shadow database
configuration into shadow database standard configuration |
[`org.apache.shardingsphere.shadow.yaml.swapper.ShadowRuleAlgorithmProviderConfigurationYamlSwapper`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-features/shardingsphere-shadow/shardingsphere-shadow-core/src/main/java/org/apache/shardingsphere/shadow/yaml/swapper/ShadowRuleAlgorithmProviderConfigurationYamlSwapper.java)
|
+| SQL_TRANSLATOR | Used to convert the YAML configuration of the SQL
transformation to the SQL transformation standard configuration |
[`org.apache.shardingsphere.sqltranslator.yaml.swapper.SQLTranslatorRuleConfigurationYamlSwapper`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-kernel/shardingsphere-sql-translator/shardingsphere-sql-translator-core/src/main/java/org/apache/shardingsphere/sqltranslator/yaml/swapper/SQLTranslatorRuleConfigurationYamlSwappe
[...]
+
+## ShardingSphereYamlConstruct
+
+### Fully-qualified class name
+
+[`org.apache.shardingsphere.infra.yaml.engine.constructor.ShardingSphereYamlConstruct`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-infra/shardingsphere-infra-common/src/main/java/org/apache/shardingsphere/infra/yaml/engine/constructor/ShardingSphereYamlConstruct.java)
+
+### Definition
+
+Used to convert custom objects and YAML to and from each other
+
+### Implementation classes
+
+| *Configuration Type* | *Description*
| *Fully-qualified class name* |
+| ------------------------------------- |
--------------------------------------------------------------------------- |
---------------------------- |
+| YamlNoneShardingStrategyConfiguration | Used to convert non-sharding policy
objects and YAML to and from each other |
[`org.apache.shardingsphere.sharding.yaml.engine.construct.NoneShardingStrategyConfigurationYamlConstruct`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-features/shardingsphere-sharding/shardingsphere-sharding-core/src/main/java/org/apache/shardingsphere/sharding/yaml/engine/construct/NoneShardingStrategyConfigurationYamlConstruct.java)
|
