You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@shardingsphere.apache.org by pa...@apache.org on 2020/06/15 13:48:58 UTC

[shardingsphere] branch master updated: For #5889, mod.value --> sharding.count (#6052)

This is an automated email from the ASF dual-hosted git repository.

panjuan 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 16a2e81  For #5889, mod.value --> sharding.count (#6052)
16a2e81 is described below

commit 16a2e81f162bbff3568f887bff7bf8128e2273d4
Author: Liang Zhang <te...@163.com>
AuthorDate: Mon Jun 15 21:48:47 2020 +0800

    For #5889, mod.value --> sharding.count (#6052)
---
 .../configuration/java-api/sharding.cn.md                    | 12 ++++++------
 .../configuration/java-api/sharding.en.md                    | 12 ++++++------
 .../strategy/algorithm/sharding/HashShardingAlgorithm.java   | 12 ++++++------
 .../strategy/algorithm/sharding/ModuloShardingAlgorithm.java | 12 ++++++------
 .../apache/shardingsphere/sharding/rule/TableRuleTest.java   |  4 ++--
 .../algorithm/sharding/HashShardingAlgorithmTest.java        |  2 +-
 .../algorithm/sharding/ModuloShardingAlgorithmTest.java      |  2 +-
 .../src/test/resources/config-sharding.yaml                  |  2 +-
 .../src/test/resources/META-INF/rdb/shardingNamespace.xml    |  2 +-
 9 files changed, 30 insertions(+), 30 deletions(-)

diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/configuration/java-api/sharding.cn.md b/docs/document/content/user-manual/shardingsphere-jdbc/configuration/java-api/sharding.cn.md
index 0bf6c4a..e988a9d 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/configuration/java-api/sharding.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/configuration/java-api/sharding.cn.md
@@ -80,9 +80,9 @@ Apache ShardingSphere 内置的标准分片算法实现类包括:
 
 可配置属性:
 
-| *属性名称* | *数据类型* | *说明*  |
-| --------- | --------- | ------- |
-| mod.value | int       | 分片数量 |
+| *属性名称*      | *数据类型* | *说明*  |
+| -------------- | --------- | ------- |
+| sharding.count | int       | 分片数量 |
 
 #### 哈希取模分片算法
 
@@ -90,9 +90,9 @@ Apache ShardingSphere 内置的标准分片算法实现类包括:
 
 可配置属性:
 
-| *属性名称* | *数据类型* | *说明*  |
-| --------- | --------- | ------- |
-| mod.value | int       | 分片数量 |
+| *属性名称*      | *数据类型* | *说明*  |
+| -------------- | --------- | ------- |
+| sharding.count | int       | 分片数量 |
 
 #### 固定容量范围分片算法
 
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/configuration/java-api/sharding.en.md b/docs/document/content/user-manual/shardingsphere-jdbc/configuration/java-api/sharding.en.md
index 2b1dbff..6dc2891 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/configuration/java-api/sharding.en.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/configuration/java-api/sharding.en.md
@@ -80,9 +80,9 @@ Class name: org.apache.shardingsphere.sharding.strategy.algorithm.sharding.Modul
 
 Attributes:
 
-| *Name*    | *DataType* | *Description*  |
-| --------- | ---------- | -------------- |
-| mod.value | int        | Sharding count |
+| *Name*         | *DataType* | *Description*  |
+| -------------- | ---------- | -------------- |
+| sharding.count | int        | Sharding count |
 
 #### Hash Modulo Sharding Algorithm
 
@@ -90,9 +90,9 @@ Class name: org.apache.shardingsphere.sharding.strategy.algorithm.sharding.HashS
 
 Attributes:
 
-| *Name*    | *DataType* | *Description*  |
-| --------- | ---------- | -------------- |
-| mod.value | int        | Sharding count |
+| *Name*         | *DataType* | *Description*  |
+| -------------- | ---------- | -------------- |
+| sharding.count | int        | Sharding count |
 
 #### Volume Range Sharding Algorithm
 
diff --git a/shardingsphere-features/shardingsphere-sharding/shardingsphere-sharding-common/src/main/java/org/apache/shardingsphere/sharding/strategy/algorithm/sharding/HashShardingAlgorithm.java b/shardingsphere-features/shardingsphere-sharding/shardingsphere-sharding-common/src/main/java/org/apache/shardingsphere/sharding/strategy/algorithm/sharding/HashShardingAlgorithm.java
index fc916c5..fd450a4 100644
--- a/shardingsphere-features/shardingsphere-sharding/shardingsphere-sharding-common/src/main/java/org/apache/shardingsphere/sharding/strategy/algorithm/sharding/HashShardingAlgorithm.java
+++ b/shardingsphere-features/shardingsphere-sharding/shardingsphere-sharding-common/src/main/java/org/apache/shardingsphere/sharding/strategy/algorithm/sharding/HashShardingAlgorithm.java
@@ -32,20 +32,20 @@ import java.util.Properties;
  * Hash sharding algorithm.
  * 
  * <p>Shard by `y = z mod v` algorithm with z = hash(x). 
- * v is `MODULO_VALUE`.
+ * v is sharding count.
  * All available targets will be returned if sharding value is `RangeShardingValue`</p>
  */
 @Getter
 @Setter
 public final class HashShardingAlgorithm implements StandardShardingAlgorithm<Comparable<?>>, ShardingAutoTableAlgorithm {
     
-    private static final String MODULO_VALUE = "mod.value";
+    public static final String SHARDING_COUNT_KEY = "sharding.count";
     
     private Properties props = new Properties();
     
     @Override
     public void init() {
-        Preconditions.checkNotNull(props.get(MODULO_VALUE), "Modulo value cannot be null.");
+        Preconditions.checkNotNull(props.get(SHARDING_COUNT_KEY), "Modulo value cannot be null.");
     }
     
     @Override
@@ -68,13 +68,13 @@ public final class HashShardingAlgorithm implements StandardShardingAlgorithm<Co
     }
     
     private long getModuloValue() {
-        return Long.parseLong(props.get(MODULO_VALUE).toString());
+        return Long.parseLong(props.get(SHARDING_COUNT_KEY).toString());
     }
     
     @Override
     public int getAutoTablesAmount() {
-        Preconditions.checkNotNull(props.get(MODULO_VALUE), "Modulo value cannot be null.");
-        return Integer.parseInt(props.get(MODULO_VALUE).toString());
+        Preconditions.checkNotNull(props.get(SHARDING_COUNT_KEY), "Modulo value cannot be null.");
+        return Integer.parseInt(props.get(SHARDING_COUNT_KEY).toString());
     }
     
     @Override
diff --git a/shardingsphere-features/shardingsphere-sharding/shardingsphere-sharding-common/src/main/java/org/apache/shardingsphere/sharding/strategy/algorithm/sharding/ModuloShardingAlgorithm.java b/shardingsphere-features/shardingsphere-sharding/shardingsphere-sharding-common/src/main/java/org/apache/shardingsphere/sharding/strategy/algorithm/sharding/ModuloShardingAlgorithm.java
index f36b7a4..3aad4bf 100644
--- a/shardingsphere-features/shardingsphere-sharding/shardingsphere-sharding-common/src/main/java/org/apache/shardingsphere/sharding/strategy/algorithm/sharding/ModuloShardingAlgorithm.java
+++ b/shardingsphere-features/shardingsphere-sharding/shardingsphere-sharding-common/src/main/java/org/apache/shardingsphere/sharding/strategy/algorithm/sharding/ModuloShardingAlgorithm.java
@@ -34,20 +34,20 @@ import java.util.Properties;
  * 
  * <p>
  *     Shard by `y = x mod v` algorithm. 
- *     v is `MODULO_VALUE`. 
+ *     v is sharding count. 
  * </p>
  */
 @Getter
 @Setter
 public final class ModuloShardingAlgorithm implements StandardShardingAlgorithm<Comparable<?>>, ShardingAutoTableAlgorithm {
     
-    private static final String MODULO_VALUE = "mod.value";
+    public static final String SHARDING_COUNT_KEY = "sharding.count";
     
     private Properties props = new Properties();
     
     @Override
     public void init() {
-        Preconditions.checkNotNull(props.get(MODULO_VALUE), "Modulo value cannot be null.");
+        Preconditions.checkNotNull(props.get(SHARDING_COUNT_KEY), "Modulo value cannot be null.");
     }
     
     @Override
@@ -86,13 +86,13 @@ public final class ModuloShardingAlgorithm implements StandardShardingAlgorithm<
     }
     
     private long getModuloValue() {
-        return Long.parseLong(props.get(MODULO_VALUE).toString());
+        return Long.parseLong(props.get(SHARDING_COUNT_KEY).toString());
     }
     
     @Override
     public int getAutoTablesAmount() {
-        Preconditions.checkNotNull(props.get(MODULO_VALUE), "Modulo value cannot be null.");
-        return Integer.parseInt(props.get(MODULO_VALUE).toString());
+        Preconditions.checkNotNull(props.get(SHARDING_COUNT_KEY), "Modulo value cannot be null.");
+        return Integer.parseInt(props.get(SHARDING_COUNT_KEY).toString());
     }
     
     private long getLongValue(final Comparable<?> value) {
diff --git a/shardingsphere-features/shardingsphere-sharding/shardingsphere-sharding-common/src/test/java/org/apache/shardingsphere/sharding/rule/TableRuleTest.java b/shardingsphere-features/shardingsphere-sharding/shardingsphere-sharding-common/src/test/java/org/apache/shardingsphere/sharding/rule/TableRuleTest.java
index c0a5a7e..7e96b57 100644
--- a/shardingsphere-features/shardingsphere-sharding/shardingsphere-sharding-common/src/test/java/org/apache/shardingsphere/sharding/rule/TableRuleTest.java
+++ b/shardingsphere-features/shardingsphere-sharding/shardingsphere-sharding-common/src/test/java/org/apache/shardingsphere/sharding/rule/TableRuleTest.java
@@ -91,7 +91,7 @@ public final class TableRuleTest {
         ShardingAutoTableRuleConfiguration tableRuleConfig = new ShardingAutoTableRuleConfiguration("LOGIC_TABLE", "ds0,ds1");
         tableRuleConfig.setShardingStrategy(new StandardShardingStrategyConfiguration("col_1", "MOD"));
         ModuloShardingAlgorithm moduloShardingAlgorithm = new ModuloShardingAlgorithm();
-        moduloShardingAlgorithm.getProps().setProperty("mod.value", "4");
+        moduloShardingAlgorithm.getProps().setProperty(ModuloShardingAlgorithm.SHARDING_COUNT_KEY, "4");
         TableRule actual = new TableRule(tableRuleConfig, Arrays.asList("ds0", "ds1", "ds2"), moduloShardingAlgorithm, null);
         assertThat(actual.getLogicTable(), is("logic_table"));
         assertThat(actual.getActualDataNodes().size(), is(4));
@@ -109,7 +109,7 @@ public final class TableRuleTest {
         ShardingAutoTableRuleConfiguration tableRuleConfig = new ShardingAutoTableRuleConfiguration("LOGIC_TABLE", null);
         tableRuleConfig.setShardingStrategy(new StandardShardingStrategyConfiguration("col_1", "MOD"));
         ModuloShardingAlgorithm moduloShardingAlgorithm = new ModuloShardingAlgorithm();
-        moduloShardingAlgorithm.getProps().setProperty("mod.value", "4");
+        moduloShardingAlgorithm.getProps().setProperty(ModuloShardingAlgorithm.SHARDING_COUNT_KEY, "4");
         TableRule actual = new TableRule(tableRuleConfig, Arrays.asList("ds0", "ds1", "ds2"), moduloShardingAlgorithm, null);
         assertThat(actual.getLogicTable(), is("logic_table"));
         assertThat(actual.getActualDataNodes().size(), is(4));
diff --git a/shardingsphere-features/shardingsphere-sharding/shardingsphere-sharding-common/src/test/java/org/apache/shardingsphere/sharding/strategy/algorithm/sharding/HashShardingAlgorithmTest.java b/shardingsphere-features/shardingsphere-sharding/shardingsphere-sharding-common/src/test/java/org/apache/shardingsphere/sharding/strategy/algorithm/sharding/HashShardingAlgorithmTest.java
index 6e7f6c8..8688dad 100644
--- a/shardingsphere-features/shardingsphere-sharding/shardingsphere-sharding-common/src/test/java/org/apache/shardingsphere/sharding/strategy/algorithm/sharding/HashShardingAlgorithmTest.java
+++ b/shardingsphere-features/shardingsphere-sharding/shardingsphere-sharding-common/src/test/java/org/apache/shardingsphere/sharding/strategy/algorithm/sharding/HashShardingAlgorithmTest.java
@@ -42,7 +42,7 @@ public final class HashShardingAlgorithmTest {
     @Before
     public void setup() {
         HashShardingAlgorithm shardingAlgorithm = new HashShardingAlgorithm();
-        shardingAlgorithm.getProps().setProperty("mod.value", "4");
+        shardingAlgorithm.getProps().setProperty(HashShardingAlgorithm.SHARDING_COUNT_KEY, "4");
         shardingAlgorithm.init();
         shardingStrategy = new StandardShardingStrategy("order_type", shardingAlgorithm);
     }
diff --git a/shardingsphere-features/shardingsphere-sharding/shardingsphere-sharding-common/src/test/java/org/apache/shardingsphere/sharding/strategy/algorithm/sharding/ModuloShardingAlgorithmTest.java b/shardingsphere-features/shardingsphere-sharding/shardingsphere-sharding-common/src/test/java/org/apache/shardingsphere/sharding/strategy/algorithm/sharding/ModuloShardingAlgorithmTest.java
index a57e674..d2858b8 100644
--- a/shardingsphere-features/shardingsphere-sharding/shardingsphere-sharding-common/src/test/java/org/apache/shardingsphere/sharding/strategy/algorithm/sharding/ModuloShardingAlgorithmTest.java
+++ b/shardingsphere-features/shardingsphere-sharding/shardingsphere-sharding-common/src/test/java/org/apache/shardingsphere/sharding/strategy/algorithm/sharding/ModuloShardingAlgorithmTest.java
@@ -42,7 +42,7 @@ public final class ModuloShardingAlgorithmTest {
     @Before
     public void setup() {
         ModuloShardingAlgorithm shardingAlgorithm = new ModuloShardingAlgorithm();
-        shardingAlgorithm.getProps().setProperty("mod.value", "4");
+        shardingAlgorithm.getProps().setProperty(ModuloShardingAlgorithm.SHARDING_COUNT_KEY, "4");
         shardingAlgorithm.init();
         shardingStrategy = new StandardShardingStrategy("order_id", shardingAlgorithm);
     }
diff --git a/shardingsphere-jdbc/shardingsphere-jdbc-core/src/test/resources/config-sharding.yaml b/shardingsphere-jdbc/shardingsphere-jdbc-core/src/test/resources/config-sharding.yaml
index 45f7f31..ac44a9d 100644
--- a/shardingsphere-jdbc/shardingsphere-jdbc-core/src/test/resources/config-sharding.yaml
+++ b/shardingsphere-jdbc/shardingsphere-jdbc-core/src/test/resources/config-sharding.yaml
@@ -71,7 +71,7 @@ rules:
     mod:
       type: MOD
       props:
-        mod.value: 2
+        sharding.count: 2
   
   keyGenerators:
     increment:
diff --git a/shardingsphere-jdbc/shardingsphere-jdbc-spring/shardingsphere-jdbc-core-spring/shardingsphere-jdbc-core-spring-namespace/src/test/resources/META-INF/rdb/shardingNamespace.xml b/shardingsphere-jdbc/shardingsphere-jdbc-spring/shardingsphere-jdbc-core-spring/shardingsphere-jdbc-core-spring-namespace/src/test/resources/META-INF/rdb/shardingNamespace.xml
index 652ce21..d7445d5 100644
--- a/shardingsphere-jdbc/shardingsphere-jdbc-spring/shardingsphere-jdbc-core-spring/shardingsphere-jdbc-core-spring-namespace/src/test/resources/META-INF/rdb/shardingNamespace.xml
+++ b/shardingsphere-jdbc/shardingsphere-jdbc-spring/shardingsphere-jdbc-core-spring/shardingsphere-jdbc-core-spring-namespace/src/test/resources/META-INF/rdb/shardingNamespace.xml
@@ -47,7 +47,7 @@
     </sharding:sharding-algorithm>
     <sharding:sharding-algorithm id="modStrategyShardingAlgorithm" type="MOD">
         <props>
-            <prop key="mod.value">4</prop>
+            <prop key="sharding.count">4</prop>
         </props>
     </sharding:sharding-algorithm>