You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@shardingsphere.apache.org by du...@apache.org on 2021/10/27 22:51:48 UTC
[shardingsphere] branch master updated: Move empty judge from
ShardingRule to ShardingRuleBuilder (#13321)
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 efea1ab Move empty judge from ShardingRule to ShardingRuleBuilder (#13321)
efea1ab is described below
commit efea1ab2485b00823dcd1e660ddc30da47f4a4ea
Author: Liang Zhang <te...@163.com>
AuthorDate: Thu Oct 28 06:50:57 2021 +0800
Move empty judge from ShardingRule to ShardingRuleBuilder (#13321)
* Move empty judge from ShardingRule to ShardingRuleBuilder
* Move empty judge from ShardingRule to ShardingRuleBuilder
* Update index of data sharding of Apache ShardingSphere's document
* Add overview of sharding table
* Update table
---
.../content/features/sharding/concept/_index.cn.md | 9 +------
.../content/features/sharding/concept/_index.en.md | 9 +------
.../content/features/sharding/concept/table.cn.md | 26 +++++++++++++-----
.../content/features/sharding/concept/table.en.md | 31 +++++++++++++++++-----
.../shardingsphere/sharding/rule/ShardingRule.java | 1 -
.../sharding/rule/builder/ShardingRuleBuilder.java | 6 +++--
.../sharding/rule/ShardingRuleTest.java | 13 ---------
.../rule/builder/ShardingRuleBuilderTest.java | 18 +++++++++++++
8 files changed, 67 insertions(+), 46 deletions(-)
diff --git a/docs/document/content/features/sharding/concept/_index.cn.md b/docs/document/content/features/sharding/concept/_index.cn.md
index 3c063bb..eb53f02 100644
--- a/docs/document/content/features/sharding/concept/_index.cn.md
+++ b/docs/document/content/features/sharding/concept/_index.cn.md
@@ -6,11 +6,4 @@ chapter = true
## 导览
-本小节主要介绍数据分片的核心概念，主要包括：
-
-* SQL核心概念
-* 分片核心概念
-* 配置核心概念
-* 行表达式
-* 分布式主键
-* 强制分片路由
+本小节主要介绍数据分片的核心概念。
diff --git a/docs/document/content/features/sharding/concept/_index.en.md b/docs/document/content/features/sharding/concept/_index.en.md
index 81d004c..3b07b49 100644
--- a/docs/document/content/features/sharding/concept/_index.en.md
+++ b/docs/document/content/features/sharding/concept/_index.en.md
@@ -6,11 +6,4 @@ chapter = true
## Overview
-This chapter is to introduce core concepts of data sharding, including:
-
-- Core concepts of SQL
-- Core concepts of sharding
-- Core concepts of configuration
-- Inline expression
-- Distributed primary key
-- Hint Sharding route
\ No newline at end of file
+This chapter is to introduce core concepts of data sharding.
diff --git a/docs/document/content/features/sharding/concept/table.cn.md b/docs/document/content/features/sharding/concept/table.cn.md
index fb53097..81f79dc 100644
--- a/docs/document/content/features/sharding/concept/table.cn.md
+++ b/docs/document/content/features/sharding/concept/table.cn.md
@@ -3,21 +3,30 @@ title = "表"
weight = 1
+++
+表是透明化数据分片的关键概念。
+Apache ShardingSphere 通过提供多样化的表类型，适配不同场景下的数据分片需求。
+
## 逻辑表
-水平拆分的数据库（表）的相同逻辑和数据结构表的总称。例：订单数据根据主键尾数拆分为 10 张表，分别是 `t_order_0` 到 `t_order_9`，他们的逻辑表名为 `t_order`。
+相同结构的水平拆分数据库（表）的逻辑名称，是 SQL 中表的逻辑标识。
+例：订单数据根据主键尾数拆分为 10 张表，分别是 `t_order_0` 到 `t_order_9`，他们的逻辑表名为 `t_order`。
## 真实表
-在分片的数据库中真实存在的物理表。即上个示例中的 `t_order_0` 到 `t_order_9`。
+在水平拆分的数据库中真实存在的物理表。
+即上个示例中的 `t_order_0` 到 `t_order_9`。
## 数据节点
-数据分片的最小单元。由数据源名称和数据表组成，例：`ds_0.t_order_0`。
+数据分片的最小单元，由数据源名称和真实表组成。
+例：`ds_0.t_order_0`。
## 绑定表
-指分片规则一致的主表和子表。例如：`t_order` 表和 `t_order_item` 表，均按照 `order_id` 分片，则此两张表互为绑定表关系。绑定表之间的多表关联查询不会出现笛卡尔积关联，关联查询效率将大大提升。举例说明，如果 SQL 为：
+指分片规则一致的主表和子表。
+例如：`t_order` 表和 `t_order_item` 表，均按照 `order_id` 分片，则此两张表互为绑定表关系。
+绑定表之间的多表关联查询不会出现笛卡尔积关联，关联查询效率将大大提升。
+举例说明，如果 SQL 为：
```sql
SELECT i.* FROM t_order o JOIN t_order_item i ON o.order_id=i.order_id WHERE o.order_id in (10, 11);
@@ -44,12 +53,15 @@ SELECT i.* FROM t_order_1 o JOIN t_order_item_1 i ON o.order_id=i.order_id WHERE
```
其中 `t_order` 在 FROM 的最左侧，ShardingSphere 将会以它作为整个绑定表的主表。
-所有路由计算将会只使用主表的策略，那么 `t_order_item` 表的分片计算将会使用 `t_order` 的条件。故绑定表之间的分区键要完全相同。
+所有路由计算将会只使用主表的策略，那么 `t_order_item` 表的分片计算将会使用 `t_order` 的条件。
+因此，绑定表间的分区键需要完全相同。
## 广播表
-指所有的分片数据源中都存在的表，表结构和表中的数据在每个数据库中均完全一致。适用于数据量不大且需要与海量数据的表进行关联查询的场景，例如：字典表。
+指所有的分片数据源中都存在的表，表结构及其数据在每个数据库中均完全一致。
+适用于数据量不大且需要与海量数据的表进行关联查询的场景，例如：字典表。
## 单表
-指所有的分片数据源中只存在唯一一张的表。适用于数据量不大且不需要做任何分片操作的场景。
+指所有的分片数据源中仅唯一存在的表。
+适用于数据量不大且无需分片的表。
diff --git a/docs/document/content/features/sharding/concept/table.en.md b/docs/document/content/features/sharding/concept/table.en.md
index 2e1eb55..8624f8d 100644
--- a/docs/document/content/features/sharding/concept/table.en.md
+++ b/docs/document/content/features/sharding/concept/table.en.md
@@ -3,21 +3,28 @@ title = "Table"
weight = 1
+++
+Table is the core concept of data sharding transparently.
+There are diversified tables provided for different data sharding requirements by Apache ShardingSphere.
+
## Logic Table
-It refers collectively to horizontal sharding databases (tables) with the same logic and data structure. For instance, the order data is divided into 10 tables according to the last number of the primary key, and they are from `t_order_0` to `t_order_9`, whose logic name is `t_order`.
+The logical name of the horizontal sharding databases (tables) with the same schema, it is the logical table identification in SQL.
+For instance, the data of order is divided into 10 tables according to the last number of the primary key, and they are from `t_order_0` to `t_order_9`, whose logic name is `t_order`.
## Actual Table
-The physical table that really exists in the sharding database, i.e., `t_order_0` to `t_order_9` in the instance above.
+The physical table that really exists in the horizontal sharding database, i.e., `t_order_0` to `t_order_9` in the instance above.
## Data Node
-As the smallest unit of sharding, it consists of data source name and table name, e.g. `ds_0.t_order_0`.
+As the atomic unit of sharding, it consists of data source name and actual table name, e.g. `ds_0.t_order_0`.
## Binding Table
-It refers to the primary table and the joiner table with the same sharding rules, for example, `t_order` and `t_order_item` are both sharded by `order_id`, so they are binding tables with each other. Cartesian product correlation will not appear in the multi-table correlating query, so the query efficiency will increase greatly. Take this one for example, if SQL is:
+It refers to the primary table and the joiner table with the same sharding rules.
+for example, `t_order` and `t_order_item` are both sharded by `order_id`, so they are binding tables with each other.
+Cartesian product correlation will not appear in the multi-tables correlating query, so the query efficiency will increase greatly.
+Take this one for example, if SQL is:
```sql
SELECT i.* FROM t_order o JOIN t_order_item i ON o.order_id=i.order_id WHERE o.order_id in (10, 11);
@@ -27,8 +34,11 @@ When binding table relations are not configured, suppose the sharding key `order
```sql
SELECT i.* FROM t_order_0 o JOIN t_order_item_0 i ON o.order_id=i.order_id WHERE o.order_id in (10, 11);
+
SELECT i.* FROM t_order_0 o JOIN t_order_item_1 i ON o.order_id=i.order_id WHERE o.order_id in (10, 11);
+
SELECT i.* FROM t_order_1 o JOIN t_order_item_0 i ON o.order_id=i.order_id WHERE o.order_id in (10, 11);
+
SELECT i.* FROM t_order_1 o JOIN t_order_item_1 i ON o.order_id=i.order_id WHERE o.order_id in (10, 11);
```
@@ -36,15 +46,22 @@ With binding table configuration, there should be 2 SQLs after routing:
```sql
SELECT i.* FROM t_order_0 o JOIN t_order_item_0 i ON o.order_id=i.order_id WHERE o.order_id in (10, 11);
+
SELECT i.* FROM t_order_1 o JOIN t_order_item_1 i ON o.order_id=i.order_id WHERE o.order_id in (10, 11);
```
-In them, table `t_order` in the left end of FROM will be taken by ShardingSphere as the primary table of query. In a similar way, ShardingSphere will also take table `t_order` in the left end of FROM as the primary table of the whole binding table. All the route computations will only use the sharding strategy of the primary table, so sharding computation of `t_order_item` table will use the conditions of `t_order`. Due to this, sharding keys in binding tables should be totally identical.
+In them, table `t_order` in the left end of FROM will be taken by ShardingSphere as the primary table of query.
+In a similar way, ShardingSphere will also take table `t_order` in the left end of FROM as the primary table of the whole binding table.
+All the route computations will only use the sharding strategy of the primary table, so sharding computation of `t_order_item` table will use the conditions of `t_order`.
+Due to this, sharding keys in binding tables should be totally identical.
## Broadcast Table
-It refers to tables that exist in all sharding database sources. Their structures and data are the same in each database. It can be applied to the small data volume scenario that needs to correlate with big data volume tables to query, dictionary table for example.
+It refers to tables that exist in all sharding database sources.
+The schema and data must consist in each database.
+It can be applied to the small data volume that needs to correlate with big data tables to query, dictionary table for example.
## Single Table
-It refers to only one table that exists in all sharding database sources. It is suitable for scenarios where the amount of data is not large and does not require any sharding operations.
+It refers to only one table that exists in all sharding database sources.
+It is suitable for little data in table without sharding.
diff --git a/shardingsphere-features/shardingsphere-sharding/shardingsphere-sharding-core/src/main/java/org/apache/shardingsphere/sharding/rule/ShardingRule.java b/shardingsphere-features/shardingsphere-sharding/shardingsphere-sharding-core/src/main/java/org/apache/shardingsphere/sharding/rule/ShardingRule.java
index e611cd2..87ab6dd 100644
--- a/shardingsphere-features/shardingsphere-sharding/shardingsphere-sharding-core/src/main/java/org/apache/shardingsphere/sharding/rule/ShardingRule.java
+++ b/shardingsphere-features/shardingsphere-sharding/shardingsphere-sharding-core/src/main/java/org/apache/shardingsphere/sharding/rule/ShardingRule.java
@@ -87,7 +87,6 @@ public final class ShardingRule implements SchemaRule, DataNodeContainedRule, Ta
private final String defaultShardingColumn;
public ShardingRule(final ShardingRuleConfiguration config, final Collection<String> dataSourceNames) {
- Preconditions.checkArgument(null != dataSourceNames && !dataSourceNames.isEmpty(), "Data source names cannot be empty.");
this.dataSourceNames = getDataSourceNames(config.getTables(), config.getAutoTables(), dataSourceNames);
config.getShardingAlgorithms().forEach((key, value) -> shardingAlgorithms.put(key, ShardingSphereAlgorithmFactory.createAlgorithm(value, ShardingAlgorithm.class)));
config.getKeyGenerators().forEach((key, value) -> keyGenerators.put(key, ShardingSphereAlgorithmFactory.createAlgorithm(value, KeyGenerateAlgorithm.class)));
diff --git a/shardingsphere-features/shardingsphere-sharding/shardingsphere-sharding-core/src/main/java/org/apache/shardingsphere/sharding/rule/builder/ShardingRuleBuilder.java b/shardingsphere-features/shardingsphere-sharding/shardingsphere-sharding-core/src/main/java/org/apache/shardingsphere/sharding/rule/builder/ShardingRuleBuilder.java
index 8083f22..2947cbf 100644
--- a/shardingsphere-features/shardingsphere-sharding/shardingsphere-sharding-core/src/main/java/org/apache/shardingsphere/sharding/rule/builder/ShardingRuleBuilder.java
+++ b/shardingsphere-features/shardingsphere-sharding/shardingsphere-sharding-core/src/main/java/org/apache/shardingsphere/sharding/rule/builder/ShardingRuleBuilder.java
@@ -17,9 +17,10 @@
package org.apache.shardingsphere.sharding.rule.builder;
+import com.google.common.base.Preconditions;
import org.apache.shardingsphere.infra.rule.ShardingSphereRule;
-import org.apache.shardingsphere.infra.rule.builder.schema.SchemaRulesBuilderMaterials;
import org.apache.shardingsphere.infra.rule.builder.schema.SchemaRuleBuilder;
+import org.apache.shardingsphere.infra.rule.builder.schema.SchemaRulesBuilderMaterials;
import org.apache.shardingsphere.sharding.api.config.ShardingRuleConfiguration;
import org.apache.shardingsphere.sharding.constant.ShardingOrder;
import org.apache.shardingsphere.sharding.rule.ShardingRule;
@@ -36,7 +37,8 @@ public final class ShardingRuleBuilder implements SchemaRuleBuilder<ShardingRule
@Override
public ShardingRule build(final SchemaRulesBuilderMaterials materials, final ShardingRuleConfiguration config, final Collection<ShardingSphereRule> builtRules) {
Map<String, DataSource> dataSourceMap = materials.getDataSourceMap();
- return new ShardingRule(config, null != dataSourceMap ? dataSourceMap.keySet() : null);
+ Preconditions.checkArgument(null != dataSourceMap && !dataSourceMap.isEmpty(), "Data source names cannot be empty.");
+ return new ShardingRule(config, dataSourceMap.keySet());
}
@Override
diff --git a/shardingsphere-features/shardingsphere-sharding/shardingsphere-sharding-core/src/test/java/org/apache/shardingsphere/sharding/rule/ShardingRuleTest.java b/shardingsphere-features/shardingsphere-sharding/shardingsphere-sharding-core/src/test/java/org/apache/shardingsphere/sharding/rule/ShardingRuleTest.java
index 5132d9f..1068bb6 100644
--- a/shardingsphere-features/shardingsphere-sharding/shardingsphere-sharding-core/src/test/java/org/apache/shardingsphere/sharding/rule/ShardingRuleTest.java
+++ b/shardingsphere-features/shardingsphere-sharding/shardingsphere-sharding-core/src/test/java/org/apache/shardingsphere/sharding/rule/ShardingRuleTest.java
@@ -48,11 +48,6 @@ import static org.junit.Assert.assertTrue;
public final class ShardingRuleTest {
- @Test(expected = IllegalArgumentException.class)
- public void assertNewShardingRuleWithEmptyDataSourceNames() {
- new ShardingRule(new ShardingRuleConfiguration(), Collections.emptyList());
- }
-
@Test
public void assertNewShardingRuleWithMaximumConfiguration() {
ShardingRule actual = createMaximumShardingRule();
@@ -274,14 +269,6 @@ public final class ShardingRuleTest {
assertThat(actual.getShardingLogicTableNames(Arrays.asList("LOGIC_TABLE", "BROADCAST_TABLE")), is(Collections.singletonList("LOGIC_TABLE")));
}
- @Test(expected = IllegalArgumentException.class)
- public void assertConstructShardingRuleWithNullDataSourceNames() {
- ShardingRuleConfiguration shardingRuleConfig = new ShardingRuleConfiguration();
- ShardingTableRuleConfiguration shardingTableRuleConfig = createTableRuleConfiguration("LOGIC_TABLE", "pr_ds_${0..1}.table_${0..2}");
- shardingRuleConfig.getTables().add(shardingTableRuleConfig);
- new ShardingRule(shardingRuleConfig, Collections.emptyList());
- }
-
@Test
public void assertTableRuleExists() {
assertTrue(createMaximumShardingRule().tableRuleExists(Collections.singleton("logic_table")));
diff --git a/shardingsphere-features/shardingsphere-sharding/shardingsphere-sharding-core/src/test/java/org/apache/shardingsphere/sharding/rule/builder/ShardingRuleBuilderTest.java b/shardingsphere-features/shardingsphere-sharding/shardingsphere-sharding-core/src/test/java/org/apache/shardingsphere/sharding/rule/builder/ShardingRuleBuilderTest.java
index 990c392..798fdae 100644
--- a/shardingsphere-features/shardingsphere-sharding/shardingsphere-sharding-core/src/test/java/org/apache/shardingsphere/sharding/rule/builder/ShardingRuleBuilderTest.java
+++ b/shardingsphere-features/shardingsphere-sharding/shardingsphere-sharding-core/src/test/java/org/apache/shardingsphere/sharding/rule/builder/ShardingRuleBuilderTest.java
@@ -51,4 +51,22 @@ public final class ShardingRuleBuilderTest {
mock(DatabaseType.class), Collections.singletonMap("name", mock(DataSource.class, RETURNS_DEEP_STUBS)),
new ConfigurationProperties(new Properties())), ruleConfig, Collections.emptyList()), instanceOf(ShardingRule.class));
}
+
+ @SuppressWarnings({"rawtypes", "unchecked"})
+ @Test(expected = IllegalArgumentException.class)
+ public void assertBuildWithNullDataSourceMap() {
+ ShardingRuleConfiguration ruleConfig = mock(ShardingRuleConfiguration.class);
+ SchemaRuleBuilder builder = OrderedSPIRegistry.getRegisteredServices(SchemaRuleBuilder.class, Collections.singletonList(ruleConfig)).get(ruleConfig);
+ builder.build(new SchemaRulesBuilderMaterials("test_schema", Collections.emptyList(),
+ mock(DatabaseType.class), null, new ConfigurationProperties(new Properties())), ruleConfig, Collections.emptyList());
+ }
+
+ @SuppressWarnings({"rawtypes", "unchecked"})
+ @Test(expected = IllegalArgumentException.class)
+ public void assertBuildWithEmptyDataSourceMap() {
+ ShardingRuleConfiguration ruleConfig = mock(ShardingRuleConfiguration.class);
+ SchemaRuleBuilder builder = OrderedSPIRegistry.getRegisteredServices(SchemaRuleBuilder.class, Collections.singletonList(ruleConfig)).get(ruleConfig);
+ builder.build(new SchemaRulesBuilderMaterials("test_schema", Collections.emptyList(),
+ mock(DatabaseType.class), Collections.emptyMap(), new ConfigurationProperties(new Properties())), ruleConfig, Collections.emptyList());
+ }
}