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 46de938 Update API doc for RDL (#7671)
46de938 is described below
commit 46de938b87eb3ddf5abb565c42d23c40271b44a8
Author: Juan Pan(Trista) <[email protected]>
AuthorDate: Wed Sep 30 17:25:25 2020 +0800
Update API doc for RDL (#7671)
---
.../configuration/spring-boot-starter/sharding.cn.md | 7 +++++++
.../configuration/spring-boot-starter/sharding.en.md | 7 +++++++
.../configuration/spring-namespace/sharding.cn.md | 6 ++++--
.../configuration/spring-namespace/sharding.en.md | 6 ++++--
.../shardingsphere-jdbc/configuration/yaml/sharding.cn.md | 7 +++++++
.../shardingsphere-jdbc/configuration/yaml/sharding.en.md | 9 ++++++++-
6 files changed, 37 insertions(+), 5 deletions(-)
diff --git
a/docs/document/content/user-manual/shardingsphere-jdbc/configuration/spring-boot-starter/sharding.cn.md
b/docs/document/content/user-manual/shardingsphere-jdbc/configuration/spring-boot-starter/sharding.cn.md
index 01ad680..44d478b 100644
---
a/docs/document/content/user-manual/shardingsphere-jdbc/configuration/spring-boot-starter/sharding.cn.md
+++
b/docs/document/content/user-manual/shardingsphere-jdbc/configuration/spring-boot-starter/sharding.cn.md
@@ -8,6 +8,7 @@ weight = 1
```properties
spring.shardingsphere.datasource.names= # 省略数据源配置
+# 标准分片表配置
spring.shardingsphere.rules.sharding.tables.<table-name>.actual-data-nodes= #
由数据源名 +
表名组成，以小数点分隔。多个表以逗号分隔，支持inline表达式。缺省表示使用已知数据源与逻辑表名称生成数据节点，用于广播表（即每个库中都需要一个同样的表用于关联查询，多为字典表）或只分库不分表且所有库的表结构完全一致的情况
# 分库策略，缺省表示使用默认分库策略，以下的分片策略只能选其一
@@ -26,6 +27,12 @@
spring.shardingsphere.rules.sharding.tables.<table-name>.database-strategy.hint.
# 分表策略，同分库策略
spring.shardingsphere.rules.sharding.tables.<table-name>.table-strategy.xxx= #
省略
+# 自动分片表配置
+spring.shardingsphere.rules.sharding.auto-tables.<auto-table-name>.actual-data-sources=
# 数据源名
+
+spring.shardingsphere.rules.sharding.auto-tables.<auto-table-name>.sharding-strategy.standard.sharding-column=
# 分片列名称
+spring.shardingsphere.rules.sharding.auto-tables.<auto-table-name>.sharding-strategy.standard.sharding-algorithm=
# 自动分片算法名称
+
# 分布式序列策略配置
spring.shardingsphere.rules.sharding.tables.<table-name>.key-generate-strategy.column=
# 分布式序列列名称
spring.shardingsphere.rules.sharding.tables.<table-name>.key-generate-strategy.key-generator-name=
# 分布式序列算法名称
diff --git
a/docs/document/content/user-manual/shardingsphere-jdbc/configuration/spring-boot-starter/sharding.en.md
b/docs/document/content/user-manual/shardingsphere-jdbc/configuration/spring-boot-starter/sharding.en.md
index 5b553ab..4416810 100644
---
a/docs/document/content/user-manual/shardingsphere-jdbc/configuration/spring-boot-starter/sharding.en.md
+++
b/docs/document/content/user-manual/shardingsphere-jdbc/configuration/spring-boot-starter/sharding.en.md
@@ -8,6 +8,7 @@ weight = 1
```properties
spring.shardingsphere.datasource.names= # Omit data source configuration
+# Standard sharding table configuration
spring.shardingsphere.rules.sharding.tables.<table-name>.actual-data-nodes= #
Describe data source names and actual tables, delimiter as point, multiple data
nodes separated with comma, support inline expression. Absent means sharding
databases only.
# Databases sharding strategy, use default databases sharding strategy if
absent. sharding strategy below can choose only one.
@@ -26,6 +27,12 @@
spring.shardingsphere.rules.sharding.tables.<table-name>.database-strategy.hint.
# Tables sharding strategy, same as database sharding strategy
spring.shardingsphere.rules.sharding.tables.<table-name>.table-strategy.xxx= #
Omitted
+# Auto sharding table configuraiton
+spring.shardingsphere.rules.sharding.auto-tables.<auto-table-name>.actual-data-sources=
# data source names
+
+spring.shardingsphere.rules.sharding.auto-tables.<auto-table-name>.sharding-strategy.standard.sharding-column=
# Sharding column name
+spring.shardingsphere.rules.sharding.auto-tables.<auto-table-name>.sharding-strategy.standard.sharding-algorithm=
# Auto sharding algorithm name
+
# Key generator strategy configuration
spring.shardingsphere.rules.sharding.tables.<table-name>.key-generate-strategy.column=
# Column name of key generator
spring.shardingsphere.rules.sharding.tables.<table-name>.key-generate-strategy.key-generator-name=
# Key generator name
diff --git
a/docs/document/content/user-manual/shardingsphere-jdbc/configuration/spring-namespace/sharding.cn.md
b/docs/document/content/user-manual/shardingsphere-jdbc/configuration/spring-namespace/sharding.cn.md
index c06af9a..7cc2d3f 100644
---
a/docs/document/content/user-manual/shardingsphere-jdbc/configuration/spring-namespace/sharding.cn.md
+++
b/docs/document/content/user-manual/shardingsphere-jdbc/configuration/spring-namespace/sharding.cn.md
@@ -26,8 +26,10 @@ weight = 1
| ------------------------- | ----- | --------------- |
| logic-table | 属性 | 逻辑表名称 |
| actual-data-nodes | 属性 | 由数据源名 +
表名组成，以小数点分隔。多个表以逗号分隔，支持inline表达式。缺省表示使用已知数据源与逻辑表名称生成数据节点，用于广播表（即每个库中都需要一个同样的表用于关联查询，多为字典表）或只分库不分表且所有库的表结构完全一致的情况
|
-| database-strategy-ref | 属性 | 分库策略名称 |
-| table-strategy-ref | 属性 | 分表策略名称 |
+| actual-data-sources | 属性 | 自动分片表数据源名 |
+| database-strategy-ref | 属性 | 标准分片表分库策略名称 |
+| table-strategy-ref | 属性 | 标准分片表分表策略名称 |
+| sharding-strategy-ref | 属性 | 自动分片表策略名称 |
| key-generate-strategy-ref | 属性 | 分布式序列策略名称 |
\<sharding:binding-table-rules />
diff --git
a/docs/document/content/user-manual/shardingsphere-jdbc/configuration/spring-namespace/sharding.en.md
b/docs/document/content/user-manual/shardingsphere-jdbc/configuration/spring-namespace/sharding.en.md
index 8cd2042..7b25e2a 100644
---
a/docs/document/content/user-manual/shardingsphere-jdbc/configuration/spring-namespace/sharding.en.md
+++
b/docs/document/content/user-manual/shardingsphere-jdbc/configuration/spring-namespace/sharding.en.md
@@ -26,8 +26,10 @@ Namespace:
[http://shardingsphere.apache.org/schema/shardingsphere/sharding/shar
| ------------------------- | --------- | -------------------------- |
| logic-table | Attribute | Logic table name |
| actual-data-nodes | Attribute | Describe data source names and
actual tables, delimiter as point, multiple data nodes separated with comma,
support inline expression. Absent means sharding databases only. |
-| database-strategy-ref | Attribute | Database strategy name |
-| table-strategy-ref | Attribute | Table strategy name |
+| actual-data-sources | Attribute | Data source names for auto sharding
table |
+| database-strategy-ref | Attribute | Database strategy name for standard
sharding table |
+| table-strategy-ref | Attribute | Table strategy name for standard
sharding table |
+| sharding-strategy-ref | Attribute | sharding strategy name for auto
sharding table |
| key-generate-strategy-ref | Attribute | Key generate strategy name |
\<sharding:binding-table-rules />
diff --git
a/docs/document/content/user-manual/shardingsphere-jdbc/configuration/yaml/sharding.cn.md
b/docs/document/content/user-manual/shardingsphere-jdbc/configuration/yaml/sharding.cn.md
index bcd5c33..6f94cb0 100644
---
a/docs/document/content/user-manual/shardingsphere-jdbc/configuration/yaml/sharding.cn.md
+++
b/docs/document/content/user-manual/shardingsphere-jdbc/configuration/yaml/sharding.cn.md
@@ -27,6 +27,13 @@ rules:
keyGenerateStrategy: # 分布式序列策略
column: # 自增列名称，缺省表示不使用自增主键生成器
keyGeneratorName: # 分布式序列算法名称
+ autoTables: # 自动分片表规则配置
+ t_order_auto: # 逻辑表名称
+ actualDataSources (?): # 数据源名称
+ shardingStrategy: # 切分策略
+ standard: # 用于单分片键的标准分片场景
+ shardingColumn: # 分片列名称
+ shardingAlgorithmName: # 自动分片算法名称
bindingTables (+): # 绑定表规则列表
- <logic_table_name_1, logic_table_name_2, ...>
broadcastTables (+): # 广播表规则列表
diff --git
a/docs/document/content/user-manual/shardingsphere-jdbc/configuration/yaml/sharding.en.md
b/docs/document/content/user-manual/shardingsphere-jdbc/configuration/yaml/sharding.en.md
index a9dd711..8025b12 100644
---
a/docs/document/content/user-manual/shardingsphere-jdbc/configuration/yaml/sharding.en.md
+++
b/docs/document/content/user-manual/shardingsphere-jdbc/configuration/yaml/sharding.en.md
@@ -10,7 +10,7 @@ dataSources: # Omit data source configuration
rules:
- !SHARDING
- tables: # Sharding rule configuration
+ tables: # Sharding table configuration
<logic-table-name> (+): # Logic table name
actualDataNodes (?): # Describe data source names and actual tables,
delimiter as point, multiple data nodes separated with comma, support inline
expression. Absent means sharding databases only.
databaseStrategy (?): # Databases sharding strategy, use default
databases sharding strategy if absent. sharding strategy below can choose only
one.
@@ -27,6 +27,13 @@ rules:
keyGenerateStrategy: # Key generator strategy
column: # Column name of key generator
keyGeneratorName: # Key generator name
+ autoTables: # Auto Sharding table configuration
+ t_order_auto: # Logic table name
+ actualDataSources (?): # Data source names
+ shardingStrategy: # Sharding strategy
+ standard: # For single sharding column scenario
+ shardingColumn: # Sharding column name
+ shardingAlgorithmName: # Auto sharding algorithm name
bindingTables (+): # Binding tables
- <logic_table_name_1, logic_table_name_2, ...>
broadcastTables (+): # Broadcast tables
