[shardingsphere] branch master updated: Updated documentation for custom properties for the CLASS_BASED algorithm (#19161)

[zh...@apache.org]

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 0afa7bb10ea Updated documentation for custom properties for the CLASS_BASED algorithm (#19161)
0afa7bb10ea is described below

commit 0afa7bb10eaab5d608dd90b26ead9bb6501f4982
Author: Ling Hengqian <li...@outlook.com>
AuthorDate: Thu Jul 14 23:45:48 2022 +0800

    Updated documentation for custom properties for the CLASS_BASED algorithm (#19161)
    
    * Updated documentation for custom properties for the CLASS_BASED algorithm.
    
    * fix the style error.
---
 .../user-manual/shardingsphere-jdbc/builtin-algorithm/sharding.cn.md    | 2 ++
 .../user-manual/shardingsphere-jdbc/builtin-algorithm/sharding.en.md    | 2 ++
 2 files changed, 4 insertions(+)

diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/builtin-algorithm/sharding.cn.md b/docs/document/content/user-manual/shardingsphere-jdbc/builtin-algorithm/sharding.cn.md
index 89ac3d0edf3..20160776465 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/builtin-algorithm/sharding.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/builtin-algorithm/sharding.cn.md
@@ -131,6 +131,8 @@ Apache ShardingSphere 内置的标准分片算法实现类包括：
 ### 自定义类分片算法
 
 通过配置分片策略类型和算法类名，实现自定义扩展。
+`CLASS_BASED` 允许向算法类内传入额外的自定义属性，传入的属性可以通过属性名为 `props` 的 `java.util.Properties` 类实例取出。 
+参考 Git 的 `org.apache.shardingsphere.example.extension.sharding.algortihm.classbased.fixture.ClassBasedStandardShardingAlgorithmFixture` 。
 
 类型：CLASS_BASED
 
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/builtin-algorithm/sharding.en.md b/docs/document/content/user-manual/shardingsphere-jdbc/builtin-algorithm/sharding.en.md
index 4bdf853174c..a6e55cc2c03 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/builtin-algorithm/sharding.en.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/builtin-algorithm/sharding.en.md
@@ -134,6 +134,8 @@ Type: COMPLEX_INLINE
 ### Class Based Sharding Algorithm
 
 Realize custom extension by configuring the sharding strategy type and algorithm class name.
+`CLASS_BASED` allows additional custom properties to be passed into the algorithm class. The passed properties can be retrieved through the `java.util.Properties` class instance with the property name `props`. 
+Refer to Git's `org.apache.shardingsphere.example.extension.sharding.algortihm.classbased.fixture.ClassBasedStandardShardingAlgorithmFixture`.
 
 Type：CLASS_BASED