You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@shardingsphere.apache.org by zh...@apache.org on 2022/06/10 15:20:47 UTC

[shardingsphere] branch master updated: update encrypt related doc (#18290)

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 5ae40c53c5a update encrypt related doc (#18290)
5ae40c53c5a is described below

commit 5ae40c53c5a6d6f17877a91656a543b156048b73
Author: cheese8 <yi...@163.com>
AuthorDate: Fri Jun 10 23:20:40 2022 +0800

    update encrypt related doc (#18290)
    
    * update encrypt related doc
---
 docs/document/content/dev-manual/encryption.cn.md      | 10 ----------
 docs/document/content/dev-manual/encryption.en.md      | 10 ----------
 .../shardingsphere-jdbc/java-api/rules/encrypt.cn.md   | 18 ++++++++++--------
 .../shardingsphere-jdbc/java-api/rules/encrypt.en.md   |  4 +++-
 4 files changed, 13 insertions(+), 29 deletions(-)

diff --git a/docs/document/content/dev-manual/encryption.cn.md b/docs/document/content/dev-manual/encryption.cn.md
index 06180a973e5..d88bb19ccf4 100644
--- a/docs/document/content/dev-manual/encryption.cn.md
+++ b/docs/document/content/dev-manual/encryption.cn.md
@@ -18,13 +18,3 @@ chapter = true
 | RC4EncryptAlgorithm | 基于 RC4 的数据加密算法 |
 | SM4EncryptAlgorithm | 基于 SM4 的数据加密算法 |
 | SM3EncryptAlgorithm | 基于 SM3 的数据加密算法 |
-
-## QueryAssistedEncryptAlgorithm
-
-| *SPI 名称*                    | *详细说明*                 |
-| ----------------------------- | ------------------------ |
-| QueryAssistedEncryptAlgorithm | 包含查询辅助列的数据加密算法 |
-
-| *已知实现类*                   | *详细说明*                 |
-| ----------------------------- | ------------------------- |
-| 无                            |                           |
diff --git a/docs/document/content/dev-manual/encryption.en.md b/docs/document/content/dev-manual/encryption.en.md
index 638585b0078..e214c161fab 100644
--- a/docs/document/content/dev-manual/encryption.en.md
+++ b/docs/document/content/dev-manual/encryption.en.md
@@ -18,13 +18,3 @@ chapter = true
 | RC4EncryptAlgorithm           | RC4 data encrypt algorithm |
 | SM3EncryptAlgorithm           | SM3 data encrypt algorithm |
 | SM4EncryptAlgorithm           | SM4 data encrypt algorithm |
-
-## QueryAssistedEncryptAlgorithm
-
-| *SPI Name*                    | *Description*                                              |
-| ----------------------------- | ---------------------------------------------------------- |
-| QueryAssistedEncryptAlgorithm | Data encrypt algorithm which include query assisted column |
-
-| *Implementation Class*        | *Description*                                              |
-| ----------------------------- | ---------------------------------------------------------- |
-| None                          |                                                            |
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/java-api/rules/encrypt.cn.md b/docs/document/content/user-manual/shardingsphere-jdbc/java-api/rules/encrypt.cn.md
index e08a8c744d4..f8c40dc9bbd 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/java-api/rules/encrypt.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/java-api/rules/encrypt.cn.md
@@ -25,7 +25,7 @@ weight = 4
 | ----------- | -------------------------------------------- | --------------- |
 | name        | String                                       | 表名称           |
 | columns (+) | Collection\<EncryptColumnRuleConfiguration\> | 加密列规则配置列表 |
-| queryWithCipherColumn (?) | boolean                                             | 该表是否使用加密列进行查询 | true   |
+| queryWithCipherColumn (?) | boolean                                             | 该表是否使用加密列进行查询 |
 
 ## 加密列规则配置
 
@@ -33,13 +33,15 @@ weight = 4
 
 可配置属性:
 
-| *名称*                  | *数据类型* | *说明*        |
-| ----------------------- | -------- | ------------- |
-| logicColumn             | String   | 逻辑列名称     |
-| cipherColumn            | String   | 密文列名称     |
-| assistedQueryColumn (?) | String   | 查询辅助列名称 |
-| plainColumn (?)         | String   | 原文列名称     |
-| encryptorName           | String   | 加密算法名称   |
+| *名称*                    | *数据类型* | *说明*        |
+| ------------------------- | -------- | ------------- |
+| logicColumn               | String   | 逻辑列名称     |
+| cipherColumn              | String   | 密文列名称     |
+| assistedQueryColumn (?)   | String   | 查询辅助列名称 |
+| plainColumn (?)           | String   | 原文列名称     |
+| encryptorName             | String   | 密文列加密算法名称   |
+| assistedQueryEncryptorName| String   | 查询辅助列加密算法名称   |
+| queryWithCipherColumn (?) | boolean                                             | 该列是否使用加密列进行查询 |
 
 ## 加解密算法配置
 
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/java-api/rules/encrypt.en.md b/docs/document/content/user-manual/shardingsphere-jdbc/java-api/rules/encrypt.en.md
index 858162b1c61..c47eb26a26f 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/java-api/rules/encrypt.en.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/java-api/rules/encrypt.en.md
@@ -25,7 +25,7 @@ Attributes:
 | ----------- | -------------------------------------------- | ---------------------------------- |
 | name        | String                                       | Table name                         |
 | columns (+) | Collection\<EncryptColumnRuleConfiguration\> | Encrypt column rule configurations |
-| queryWithCipherColumn (?) | boolean                                             | The current table whether query with cipher column for data encrypt.  | true            |
+| queryWithCipherColumn (?) | boolean                                             | The current table whether query with cipher column for data encrypt.  |
 
 ### Encrypt Column Rule Configuration
 
@@ -40,6 +40,8 @@ Attributes:
 | assistedQueryColumn (?) | String     | Assisted query column name |
 | plainColumn (?)         | String     | Plain column name          |
 | encryptorName           | String     | Encrypt algorithm name     |
+| assistedQueryEncryptorName           | String     | Assisted query encrypt algorithm name     |
+| queryWithCipherColumn (?) | boolean                                             | The current column whether query with cipher column for data encrypt.  |
 
 ## Encrypt Algorithm Configuration