You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@shardingsphere.apache.org by su...@apache.org on 2023/06/19 08:04:44 UTC
[shardingsphere] branch master updated: update doc of broadcast table (#26432)
This is an automated email from the ASF dual-hosted git repository.
sunnianjun 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 d2cb6ed428e update doc of broadcast table (#26432)
d2cb6ed428e is described below
commit d2cb6ed428ea033869b6c0c80cb328f52e4fe1bf
Author: jiangML <10...@qq.com>
AuthorDate: Mon Jun 19 16:04:37 2023 +0800
update doc of broadcast table (#26432)
* update doc of broadcast table
* update doc
---
.../content/features/sharding/concept.cn.md | 2 +-
.../content/features/sharding/concept.en.md | 2 +-
.../common-config/builtin-algorithm/sharding.cn.md | 6 ++-
.../common-config/builtin-algorithm/sharding.en.md | 6 ++-
.../java-api/rules/sharding.cn.md | 8 ++--
.../java-api/rules/sharding.en.md | 8 ++--
.../yaml-config/rules/broadcast.cn.md | 52 +++++++++++++++++++++
.../yaml-config/rules/broadcast.en.md | 54 ++++++++++++++++++++++
.../yaml-config/rules/encrypt.cn.md | 2 +-
.../yaml-config/rules/encrypt.en.md | 2 +-
.../yaml-config/rules/mask.cn.md | 2 +-
.../yaml-config/rules/mask.en.md | 2 +-
.../yaml-config/rules/mix.cn.md | 2 +-
.../yaml-config/rules/mix.en.md | 2 +-
.../yaml-config/rules/readwrite-splitting.cn.md | 2 +-
.../yaml-config/rules/readwrite-splitting.en.md | 2 +-
.../yaml-config/rules/shadow.cn.md | 2 +-
.../yaml-config/rules/shadow.en.md | 2 +-
.../yaml-config/rules/sharding-cache.cn.md | 2 +-
.../yaml-config/rules/sharding-cache.en.md | 2 +-
.../yaml-config/rules/sharding.cn.md | 14 ++++--
.../yaml-config/rules/sharding.en.md | 14 ++++--
.../yaml-config/rules/sql-parser.cn.md | 2 +-
.../yaml-config/rules/sql-parser.en.md | 2 +-
.../yaml-config/rules/sql-translator.cn.md | 2 +-
.../yaml-config/rules/sql-translator.en.md | 2 +-
.../yaml-config/rules/transaction.cn.md | 2 +-
.../yaml-config/rules/transaction.en.md | 2 +-
.../distsql/syntax/reserved-word.cn.md | 4 ++
.../distsql/syntax/reserved-word.en.md | 4 ++
30 files changed, 170 insertions(+), 40 deletions(-)
diff --git a/docs/document/content/features/sharding/concept.cn.md b/docs/document/content/features/sharding/concept.cn.md
index 74718b65575..2ee35668426 100644
--- a/docs/document/content/features/sharding/concept.cn.md
+++ b/docs/document/content/features/sharding/concept.cn.md
@@ -47,7 +47,7 @@ SELECT i.* FROM t_order_1 o JOIN t_order_item_1 i ON o.order_id=i.order_id WHERE
### 广播表
-指所有的分片数据源中都存在的表，表结构及其数据在每个数据库中均完全一致。 适用于数据量不大且需要与海量数据的表进行关联查询的场景，例如：字典表。
+指所有的数据源中都存在的表，表结构及其数据在每个数据库中均完全一致。 适用于数据量不大且需要与海量数据的表进行关联查询的场景，例如：字典表。
### 单表
diff --git a/docs/document/content/features/sharding/concept.en.md b/docs/document/content/features/sharding/concept.en.md
index 58b1c3ba161..d9653e41d80 100644
--- a/docs/document/content/features/sharding/concept.en.md
+++ b/docs/document/content/features/sharding/concept.en.md
@@ -52,7 +52,7 @@ The t_order table will be used by ShardingSphere as the master table for the ent
### Broadcast data frame
-Refers to tables that exist in all sharded data sources. The table structure and its data are identical in each database. Suitable for scenarios where the data volume is small and queries are required to be associated with tables of massive data, e.g., dictionary tables.
+Refers to tables that exist in all data sources. The table structure and its data are identical in each database. Suitable for scenarios where the data volume is small and queries are required to be associated with tables of massive data, e.g., dictionary tables.
### Single Table
diff --git a/docs/document/content/user-manual/common-config/builtin-algorithm/sharding.cn.md b/docs/document/content/user-manual/common-config/builtin-algorithm/sharding.cn.md
index 2285d620c6e..15d0a1b219b 100644
--- a/docs/document/content/user-manual/common-config/builtin-algorithm/sharding.cn.md
+++ b/docs/document/content/user-manual/common-config/builtin-algorithm/sharding.cn.md
@@ -239,8 +239,6 @@ rules:
defaultShardingColumn: account_id
bindingTables:
- t_order,t_order_item
- broadcastTables:
- - t_address
defaultDatabaseStrategy:
standard:
shardingColumn: user_id
@@ -268,6 +266,10 @@ rules:
keyGenerators:
snowflake:
type: SNOWFLAKE
+
+- !BROADCAST
+ tables:
+ - t_address
```
## 相关参考
diff --git a/docs/document/content/user-manual/common-config/builtin-algorithm/sharding.en.md b/docs/document/content/user-manual/common-config/builtin-algorithm/sharding.en.md
index 9fcac42745f..0c00c95465f 100644
--- a/docs/document/content/user-manual/common-config/builtin-algorithm/sharding.en.md
+++ b/docs/document/content/user-manual/common-config/builtin-algorithm/sharding.en.md
@@ -241,8 +241,6 @@ rules:
defaultShardingColumn: account_id
bindingTables:
- t_order,t_order_item
- broadcastTables:
- - t_address
defaultDatabaseStrategy:
standard:
shardingColumn: user_id
@@ -270,6 +268,10 @@ rules:
keyGenerators:
snowflake:
type: SNOWFLAKE
+
+- !BROADCAST
+ tables:
+ - t_address
```
## Related References
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/java-api/rules/sharding.cn.md b/docs/document/content/user-manual/shardingsphere-jdbc/java-api/rules/sharding.cn.md
index 6d9dda38189..9209b659cc2 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/java-api/rules/sharding.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/java-api/rules/sharding.cn.md
@@ -20,7 +20,6 @@ weight = 1
| tables (+) | Collection\<ShardingTableRuleConfiguration\> | 分片表规则列表 | - |
| autoTables (+) | Collection\<ShardingAutoTableRuleConfiguration\> | 自动分片表规则列表 | - |
| bindingTableGroups (*) | Collection\<String\> | 绑定表规则列表 | 无 |
-| broadcastTables (*) | Collection\<String\> | 广播表规则列表 | 无 |
| defaultDatabaseShardingStrategy (?) | ShardingStrategyConfiguration | 默认分库策略 | 不分片 |
| defaultTableShardingStrategy (?) | ShardingStrategyConfiguration | 默认分表策略 | 不分片 |
| defaultKeyGenerateStrategy (?) | KeyGeneratorConfiguration | 默认自增列生成器配置 | 雪花算法 |
@@ -140,7 +139,7 @@ public final class ShardingDatabasesAndTablesConfigurationPrecise {
@Override
public DataSource getDataSource() throws SQLException {
- return ShardingSphereDataSourceFactory.createDataSource(createDataSourceMap(), Collections.singleton(createShardingRuleConfiguration()), new Properties());
+ return ShardingSphereDataSourceFactory.createDataSource(createDataSourceMap(), Arrays.asList(createShardingRuleConfiguration(), createBroadcastRuleConfiguration())), new Properties());
}
private ShardingRuleConfiguration createShardingRuleConfiguration() {
@@ -148,7 +147,6 @@ public final class ShardingDatabasesAndTablesConfigurationPrecise {
result.getTables().add(getOrderTableRuleConfiguration());
result.getTables().add(getOrderItemTableRuleConfiguration());
result.getBindingTableGroups().add(new ShardingTableReferenceRuleConfiguration("foo", "t_order, t_order_item"));
- result.getBroadcastTables().add("t_address");
result.setDefaultDatabaseShardingStrategy(new StandardShardingStrategyConfiguration("user_id", "inline"));
result.setDefaultTableShardingStrategy(new StandardShardingStrategyConfiguration("order_id", "standard_test_tbl"));
Properties props = new Properties();
@@ -179,6 +177,10 @@ public final class ShardingDatabasesAndTablesConfigurationPrecise {
result.put("demo_ds_1", DataSourceUtil.createDataSource("demo_ds_1"));
return result;
}
+
+ private BroadcastRuleConfiguration createBroadcastRuleConfiguration() {
+ return new BroadcastRuleConfiguration(Collections.singletonList("t_address"));;
+ }
}
```
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/java-api/rules/sharding.en.md b/docs/document/content/user-manual/shardingsphere-jdbc/java-api/rules/sharding.en.md
index 624412dbbe8..f67e861e381 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/java-api/rules/sharding.en.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/java-api/rules/sharding.en.md
@@ -20,7 +20,6 @@ Attributes:
| tables (+) | Collection\<ShardingTableRuleConfiguration\> | Sharding table rules | - |
| autoTables (+) | Collection\<ShardingAutoTableRuleConfiguration\> | Sharding auto table rules | - |
| bindingTableGroups (*) | Collection\<String\> | Binding table rules | Empty |
-| broadcastTables (*) | Collection\<String\> | Broadcast table rules | Empty |
| defaultDatabaseShardingStrategy (?) | ShardingStrategyConfiguration | Default database sharding strategy | Not sharding |
| defaultTableShardingStrategy (?) | ShardingStrategyConfiguration | Default table sharding strategy | Not sharding |
| defaultKeyGenerateStrategy (?) | KeyGeneratorConfiguration | Default key generator | Snowflake |
@@ -139,7 +138,7 @@ public final class ShardingDatabasesAndTablesConfigurationPrecise {
@Override
public DataSource getDataSource() throws SQLException {
- return ShardingSphereDataSourceFactory.createDataSource(createDataSourceMap(), Collections.singleton(createShardingRuleConfiguration()), new Properties());
+ return ShardingSphereDataSourceFactory.createDataSource(createDataSourceMap(), Arrays.asList(createShardingRuleConfiguration(), createBroadcastRuleConfiguration())), new Properties());
}
private ShardingRuleConfiguration createShardingRuleConfiguration() {
@@ -147,7 +146,6 @@ public final class ShardingDatabasesAndTablesConfigurationPrecise {
result.getTables().add(getOrderTableRuleConfiguration());
result.getTables().add(getOrderItemTableRuleConfiguration());
result.getBindingTableGroups().add(new ShardingTableReferenceRuleConfiguration("foo", "t_order, t_order_item"));
- result.getBroadcastTables().add("t_address");
result.setDefaultDatabaseShardingStrategy(new StandardShardingStrategyConfiguration("user_id", "inline"));
result.setDefaultTableShardingStrategy(new StandardShardingStrategyConfiguration("order_id", "standard_test_tbl"));
Properties props = new Properties();
@@ -178,6 +176,10 @@ public final class ShardingDatabasesAndTablesConfigurationPrecise {
result.put("demo_ds_1", DataSourceUtil.createDataSource("demo_ds_1"));
return result;
}
+
+ private BroadcastRuleConfiguration createBroadcastRuleConfiguration() {
+ return new BroadcastRuleConfiguration(Collections.singletonList("t_address"));;
+ }
}
```
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/broadcast.cn.md b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/broadcast.cn.md
new file mode 100644
index 00000000000..d7488acb492
--- /dev/null
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/broadcast.cn.md
@@ -0,0 +1,52 @@
++++
+title = "广播表"
+weight = 2
++++
+
+广播表 YAML 配置方式具有非凡的可读性，通过 YAML 格式，能够快速地理解广播表配置，ShardingSphere 会根据 YAML 配置，自动完成 ShardingSphereDataSource 对象的创建，减少用户不必要的编码工作。
+
+## 参数解释
+
+```yaml
+rules:
+- !BROADCAST
+ tables: # Broadcast tables
+ - <table_name>
+ - <table_name>
+```
+
+## 操作步骤
+
+1. 在 YAML 文件中配置广播表列表
+2. 调用 YamlShardingSphereDataSourceFactory 对象的 createDataSource 方法，根据 YAML 文件中的配置信息创建 ShardingSphereDataSource。
+
+## 配置示例
+
+广播表 YAML 配置示例如下：
+
+```yaml
+dataSources:
+ ds_0:
+ dataSourceClassName: com.zaxxer.hikari.HikariDataSource
+ driverClassName: com.mysql.jdbc.Driver
+ jdbcUrl: jdbc:mysql://localhost:3306/demo_ds_0?serverTimezone=UTC&useSSL=false&useUnicode=true&characterEncoding=UTF-8
+ username: root
+ password:
+ ds_1:
+ dataSourceClassName: com.zaxxer.hikari.HikariDataSource
+ driverClassName: com.mysql.jdbc.Driver
+ jdbcUrl: jdbc:mysql://localhost:3306/demo_ds_1?serverTimezone=UTC&useSSL=false&useUnicode=true&characterEncoding=UTF-8
+ username: root
+ password:
+
+rules:
+- !BROADCAST
+ tables: # 广播表规则列表
+ - t_address
+```
+
+通过 YamlShardingSphereDataSourceFactory 的 createDataSource 方法，读取 YAML 配置完成数据源的创建。
+
+```java
+YamlShardingSphereDataSourceFactory.createDataSource(getFile("/META-INF/broadcast-databases-tables.yaml"));
+```
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/broadcast.en.md b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/broadcast.en.md
new file mode 100644
index 00000000000..0a8721d3361
--- /dev/null
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/broadcast.en.md
@@ -0,0 +1,54 @@
++++
+title = "Broadcast Table"
+weight = 2
++++
+
+## Background
+
+Broadcast table YAML configuration is highly readable. The broadcast rules can be quickly understood through the YAML format. ShardingSphere automatically creates the ShardingSphereDataSource object according to YAML configuration, which can reduce unnecessary coding for users.
+
+## Parameters
+
+```yaml
+rules:
+- !BROADCAST
+ tables: # Broadcast tables
+ - <table_name>
+ - <table_name>
+```
+
+## Procedure
+
+1. Configure broadcast table list in YAML file.
+2. Call createDataSource method of the object YamlShardingSphereDataSourceFactory. Create ShardingSphereDataSource according to the configuration information in YAML files.
+
+## Sample
+
+The YAML configuration sample of broadcast table is as follows:
+
+```yaml
+dataSources:
+ ds_0:
+ dataSourceClassName: com.zaxxer.hikari.HikariDataSource
+ driverClassName: com.mysql.jdbc.Driver
+ jdbcUrl: jdbc:mysql://localhost:3306/demo_ds_0?serverTimezone=UTC&useSSL=false&useUnicode=true&characterEncoding=UTF-8
+ username: root
+ password:
+ ds_1:
+ dataSourceClassName: com.zaxxer.hikari.HikariDataSource
+ driverClassName: com.mysql.jdbc.Driver
+ jdbcUrl: jdbc:mysql://localhost:3306/demo_ds_1?serverTimezone=UTC&useSSL=false&useUnicode=true&characterEncoding=UTF-8
+ username: root
+ password:
+
+rules:
+- !BROADCAST
+ tables:
+ - t_address
+```
+
+Read the YAML configuration to create a data source according to the createDataSource method of YamlShardingSphereDataSourceFactory.
+
+```java
+YamlShardingSphereDataSourceFactory.createDataSource(getFile("/META-INF/broadcast-databases-tables.yaml"));
+```
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/encrypt.cn.md b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/encrypt.cn.md
index 940a439b0f4..af060e1347b 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/encrypt.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/encrypt.cn.md
@@ -1,6 +1,6 @@
+++
title = "数据加密"
-weight = 4
+weight = 5
+++
## 背景信息
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/encrypt.en.md b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/encrypt.en.md
index 22935ad2a83..66dcdb9f99f 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/encrypt.en.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/encrypt.en.md
@@ -1,6 +1,6 @@
+++
title = "Encryption"
-weight = 4
+weight = 5
+++
## Background
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/mask.cn.md b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/mask.cn.md
index 9b95b988d1d..fc0f560f5de 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/mask.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/mask.cn.md
@@ -1,6 +1,6 @@
+++
title = "数据脱敏"
-weight = 5
+weight = 6
+++
## 背景信息
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/mask.en.md b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/mask.en.md
index b53e8656c3a..7c3d6ebc671 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/mask.en.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/mask.en.md
@@ -1,6 +1,6 @@
+++
title = "Data Masking"
-weight = 5
+weight = 6
+++
## Background
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/mix.cn.md b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/mix.cn.md
index 6e63a2a310e..eb847555fe6 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/mix.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/mix.cn.md
@@ -1,6 +1,6 @@
+++
title = "混合规则"
-weight = 9
+weight = 10
+++
## 背景信息
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/mix.en.md b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/mix.en.md
index 2474859f016..147039e7f7a 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/mix.en.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/mix.en.md
@@ -1,6 +1,6 @@
+++
title = "Mixed Rules"
-weight = 9
+weight = 10
+++
## Background
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/readwrite-splitting.cn.md b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/readwrite-splitting.cn.md
index 7b509383f5d..d0889ab5b0f 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/readwrite-splitting.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/readwrite-splitting.cn.md
@@ -1,6 +1,6 @@
+++
title = "读写分离"
-weight = 2
+weight = 3
+++
## 背景信息
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/readwrite-splitting.en.md b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/readwrite-splitting.en.md
index 252711e4a7f..793fc6ea5b6 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/readwrite-splitting.en.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/readwrite-splitting.en.md
@@ -1,6 +1,6 @@
+++
title = "Readwrite-splitting"
-weight = 2
+weight = 3
+++
## Background
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/shadow.cn.md b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/shadow.cn.md
index 3a95fb0b6e4..781f7df65d4 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/shadow.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/shadow.cn.md
@@ -1,6 +1,6 @@
+++
title = "影子库"
-weight = 6
+weight = 7
+++
## 背景信息
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/shadow.en.md b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/shadow.en.md
index b3e29e9edbb..d8e261bfb55 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/shadow.en.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/shadow.en.md
@@ -1,6 +1,6 @@
+++
title = "Shadow DB"
-weight = 6
+weight = 7
+++
## Background
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/sharding-cache.cn.md b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/sharding-cache.cn.md
index f587c1c7093..d8522840077 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/sharding-cache.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/sharding-cache.cn.md
@@ -1,6 +1,6 @@
+++
title = "数据分片路由缓存"
-weight = 10
+weight = 11
+++
## 背景信息
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/sharding-cache.en.md b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/sharding-cache.en.md
index 92a5dd4a403..98a906ae0de 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/sharding-cache.en.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/sharding-cache.en.md
@@ -1,6 +1,6 @@
+++
title = "Cache for Sharding Route"
-weight = 10
+weight = 11
+++
## Background
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/sharding.cn.md b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/sharding.cn.md
index 3ca7dcd61a9..6dcc4f14f10 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/sharding.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/sharding.cn.md
@@ -44,9 +44,6 @@ rules:
bindingTables (+): # 绑定表规则列表
- <logic_table_name_1, logic_table_name_2, ...>
- <logic_table_name_1, logic_table_name_2, ...>
- broadcastTables (+): # 广播表规则列表
- - <table_name>
- - <table_name>
defaultDatabaseStrategy: # 默认数据库分片策略
defaultTableStrategy: # 默认表分片策略
defaultKeyGenerateStrategy: # 默认的分布式序列策略
@@ -71,6 +68,11 @@ rules:
type: # 分片审计算法类型
props: # 分片审计算法属性配置
# ...
+
+- !BROADCAST
+ tables: # 广播表规则列表
+ - <table_name>
+ - <table_name>
```
## 操作步骤
@@ -133,8 +135,6 @@ rules:
defaultShardingColumn: account_id
bindingTables:
- t_order,t_order_item
- broadcastTables:
- - t_address
defaultDatabaseStrategy:
standard:
shardingColumn: user_id
@@ -166,6 +166,10 @@ rules:
sharding_key_required_auditor:
type: DML_SHARDING_CONDITIONS
+- !BROADCAST
+ tables:
+ - t_address
+
props:
sql-show: false
```
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/sharding.en.md b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/sharding.en.md
index 38e4eb33a58..226932233ae 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/sharding.en.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/sharding.en.md
@@ -44,9 +44,6 @@ rules:
bindingTables (+): # Binding tables
- <logic_table_name_1, logic_table_name_2, ...>
- <logic_table_name_1, logic_table_name_2, ...>
- broadcastTables (+): # Broadcast tables
- - <table_name>
- - <table_name>
defaultDatabaseStrategy: # Default strategy for database sharding
defaultTableStrategy: # Default strategy for table sharding
defaultKeyGenerateStrategy: # Default Key generator strategy
@@ -72,6 +69,11 @@ rules:
type: # Sharding audit algorithm type
props: # Sharding audit algorithm properties
# ...
+
+- !BROADCAST
+ tables: # Broadcast tables
+ - <table_name>
+ - <table_name>
```
## Procedure
@@ -134,8 +136,6 @@ rules:
defaultShardingColumn: account_id
bindingTables:
- t_order,t_order_item
- broadcastTables:
- - t_address
defaultDatabaseStrategy:
standard:
shardingColumn: user_id
@@ -167,6 +167,10 @@ rules:
sharding_key_required_auditor:
type: DML_SHARDING_CONDITIONS
+- !BROADCAST
+ tables: # Broadcast tables
+ - t_address
+
props:
sql-show: false
```
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/sql-parser.cn.md b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/sql-parser.cn.md
index 5f5cc131874..294889c6657 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/sql-parser.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/sql-parser.cn.md
@@ -1,6 +1,6 @@
+++
title = "SQL 解析"
-weight = 7
+weight = 8
+++
## 背景信息
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/sql-parser.en.md b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/sql-parser.en.md
index e26601cf7c6..b681d8de7d3 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/sql-parser.en.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/sql-parser.en.md
@@ -1,6 +1,6 @@
+++
title = "SQL-parser"
-weight = 7
+weight = 8
+++
## Background
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/sql-translator.cn.md b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/sql-translator.cn.md
index a6e1cb60c83..b7b6c3da701 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/sql-translator.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/sql-translator.cn.md
@@ -1,6 +1,6 @@
+++
title = "SQL 翻译"
-weight = 8
+weight = 9
+++
## 配置项说明
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/sql-translator.en.md b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/sql-translator.en.md
index a18be947049..a387dcd6426 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/sql-translator.en.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/sql-translator.en.md
@@ -1,6 +1,6 @@
+++
title = "SQL Translator"
-weight = 8
+weight = 9
+++
## Configuration Item Explanation
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/transaction.cn.md b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/transaction.cn.md
index 28e5d1307da..aa9c88f0776 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/transaction.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/transaction.cn.md
@@ -1,6 +1,6 @@
+++
title = "分布式事务"
-weight = 3
+weight = 4
+++
## 背景信息
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/transaction.en.md b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/transaction.en.md
index 69f2c6a9baa..b956a51ea18 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/transaction.en.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/yaml-config/rules/transaction.en.md
@@ -1,6 +1,6 @@
+++
title = "Distributed Transaction"
-weight = 3
+weight = 4
+++
## Background
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word.cn.md
index de843779c63..ea73aa71262 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word.cn.md
@@ -22,6 +22,10 @@ weight = 5
、`GENERATOR`、`SHARDING_COLUMNS`、`KEY_GENERATOR`、`SHARDING_ALGORITHM`、`COLUMN`、`AUDIT_STRATEGY`、`AUDITORS`
、`ALLOW_HINT_DISABLE`
+### 广播表
+
+`BROADCAST`
+
#### 单表
`SET`、`DEFAULT`、`SINGLE`、`STORAGE`、`UNIT`、`RANDOM`
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word.en.md
index 17f6c8fc6a7..a8f6d288c21 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/reserved-word.en.md
@@ -23,6 +23,10 @@ weight = 5
, `GENERATOR`, `SHARDING_COLUMNS`, `KEY_GENERATOR`, `SHARDING_ALGORITHM`, `COLUMN`, `AUDIT_STRATEGY`
, `AUDITORS`, `ALLOW_HINT_DISABLE`
+### Broadcast table
+
+`BROADCAST`
+
#### Single Table
`SET`, `DEFAULT`, `SINGLE`, `STORAGE`, `UNIT`, `RANDOM`