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/11/27 14:15:38 UTC

[shardingsphere] branch master updated: Update distsql-rdl rules on encrypt document and Format code (#22458)

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 c5c56359863 Update distsql-rdl rules on encrypt document and Format code (#22458)
c5c56359863 is described below

commit c5c56359863d860b1c9361df8f113488b5141137
Author: gxxiong <xi...@foxmail.com>
AuthorDate: Sun Nov 27 22:15:31 2022 +0800

    Update distsql-rdl rules on encrypt document and Format code (#22458)
    
    Signed-off-by: gxxiong <xi...@foxmail.com>
    
    Signed-off-by: gxxiong <xi...@foxmail.com>
---
 .../syntax/rdl/rule-definition/encrypt.cn.md       | 22 ++++++++++++----------
 .../syntax/rdl/rule-definition/encrypt.en.md       | 22 ++++++++++++----------
 .../discovery/cases/base/BaseITCase.java           |  1 -
 .../mysql/MySQLMGRPrimaryDataSourceChangedIT.java  |  1 -
 4 files changed, 24 insertions(+), 22 deletions(-)

diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/encrypt.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/encrypt.cn.md
index 5281f892534..dca3cefdd0b 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/encrypt.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/encrypt.cn.md
@@ -16,7 +16,7 @@ encryptRuleDefinition:
     tableName(COLUMNS(columnDefinition [, columnDefinition] ...), QUERY_WITH_CIPHER_COLUMN=queryWithCipherColumn)
 
 columnDefinition:
-    (NAME=columnName [, PLAIN=plainColumnName] , CIPHER=cipherColumnName, encryptAlgorithm)
+    (NAME=columnName [, PLAIN=plainColumnName] , CIPHER=cipherColumnName [, ASSISTED_QUERY_COLUMN=assistedQueryColumnName] [, LIKE_QUERY_COLUMN=likeQueryColumnName], encryptAlgorithm [, encryptAlgorithm] ...)
 
 encryptAlgorithm:
     TYPE(NAME=encryptAlgorithmType [, PROPERTIES([algorithmProperties] )] )
@@ -29,13 +29,15 @@ algorithmProperty:
 ```
 
 ### 参数解释
-| 名称                   | 数据类型       | 说明       |
-|:---------------------|:-----------|:---------|
-| tableName            | IDENTIFIER | 表名称      |
-| columnName           | IDENTIFIER | 逻辑数据列名称  |
-| plainColumnName      | IDENTIFIER | 明文数据列名称  |
-| cipherColumnName     | IDENTIFIER | 加密数据列名称  |
-| encryptAlgorithmType | STRING     | 加密算法类型名称 |
+| 名称                   | 数据类型       | 说明          |
+|:------------------------|:-----------|:--------------|
+| tableName               | IDENTIFIER | 表名称         |
+| columnName              | IDENTIFIER | 逻辑数据列名称  |
+| plainColumnName         | IDENTIFIER | 明文数据列名称  |
+| cipherColumnName        | IDENTIFIER | 加密数据列名称  |
+| assistedQueryColumnName | IDENTIFIER | 辅助查询列名称  |
+| likeQueryColumnName     | IDENTIFIER | 模糊查询列名称  |
+| encryptAlgorithmType    | STRING     | 加密算法类型名称 |
 
 ### 注意事项
 
@@ -49,7 +51,7 @@ algorithmProperty:
 ```sql
 CREATE ENCRYPT RULE t_encrypt (
 COLUMNS(
-(NAME=user_id,PLAIN=user_plain,CIPHER=user_cipher,TYPE(NAME='AES',PROPERTIES('aes-key-value'='123456abc'))),
+(NAME=user_id,PLAIN=user_plain,CIPHER=user_cipher,ASSISTED_QUERY_COLUMN=user_assisted,LIKE_QUERY_COLUMN=user_like,TYPE(NAME='MD5'),TYPE(NAME='AES',PROPERTIES('aes-key-value'='123456abc'),TYPE(NAME='CHAR_DIGEST_LIKE'))),
 (NAME=order_id, CIPHER =order_cipher,TYPE(NAME='MD5'))
 ),QUERY_WITH_CIPHER_COLUMN=true),
 t_encrypt_2 (
@@ -60,7 +62,7 @@ COLUMNS(
 
 ALTER ENCRYPT RULE t_encrypt (
 COLUMNS(
-(NAME=user_id,PLAIN=user_plain,CIPHER=user_cipher,TYPE(NAME='AES',PROPERTIES('aes-key-value'='123456abc'))),
+(NAME=user_id,PLAIN=user_plain,CIPHER=user_cipher,ASSISTED_QUERY_COLUMN=user_assisted,LIKE_QUERY_COLUMN=user_like,TYPE(NAME='MD5'),TYPE(NAME='AES',PROPERTIES('aes-key-value'='123456abc'),TYPE(NAME='CHAR_DIGEST_LIKE'))),
 (NAME=order_id,CIPHER=order_cipher,TYPE(NAME='MD5'))
 ), QUERY_WITH_CIPHER_COLUMN=TRUE);
 
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/encrypt.en.md b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/encrypt.en.md
index 7f3d47b3aaf..38ceba41fed 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/encrypt.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/encrypt.en.md
@@ -16,7 +16,7 @@ encryptRuleDefinition:
     tableName(COLUMNS(columnDefinition [, columnDefinition] ...), QUERY_WITH_CIPHER_COLUMN=queryWithCipherColumn)
 
 columnDefinition:
-    (NAME=columnName [, PLAIN=plainColumnName] , CIPHER=cipherColumnName, encryptAlgorithm)
+    (NAME=columnName [, PLAIN=plainColumnName] , CIPHER=cipherColumnName [, ASSISTED_QUERY_COLUMN=assistedQueryColumnName] [, LIKE_QUERY_COLUMN=likeQueryColumnName], encryptAlgorithm [, encryptAlgorithm] ...)
 
 encryptAlgorithm:
     TYPE(NAME=encryptAlgorithmType [, PROPERTIES([algorithmProperties] )] )
@@ -29,13 +29,15 @@ algorithmProperty:
 ```
 
 ### Parameters Explained
-| name                 | DateType   | Description                    |
-|:---------------------|:-----------|:-------------------------------|
-| tableName            | IDENTIFIER | Table name                     |
-| columnName           | IDENTIFIER | Logic column name              |
-| plainColumnName      | IDENTIFIER | Plain column name              |
-| cipherColumnName     | IDENTIFIER | Cipher column name             |
-| encryptAlgorithmType | STRING     | Encryption algorithm type name |
+| name                    | DateType   | Description                    |
+|:------------------------|:-----------|:-------------------------------|
+| tableName               | IDENTIFIER | Table name                     |
+| columnName              | IDENTIFIER | Logic column name              |
+| plainColumnName         | IDENTIFIER | Plain column name              |
+| cipherColumnName        | IDENTIFIER | Cipher column name             |
+| assistedQueryColumnName | IDENTIFIER | Assisted query column name     |
+| likeQueryColumnName     | IDENTIFIER | Like query column name         |
+| encryptAlgorithmType    | STRING     | Encryption algorithm type name |
 
 ### Notes 
 
@@ -49,7 +51,7 @@ algorithmProperty:
 ```sql
 CREATE ENCRYPT RULE t_encrypt (
 COLUMNS(
-(NAME=user_id,PLAIN=user_plain,CIPHER=user_cipher,TYPE(NAME='AES',PROPERTIES('aes-key-value'='123456abc'))),
+(NAME=user_id,PLAIN=user_plain,CIPHER=user_cipher,ASSISTED_QUERY_COLUMN=user_assisted,LIKE_QUERY_COLUMN=user_like,TYPE(NAME='MD5'),TYPE(NAME='AES',PROPERTIES('aes-key-value'='123456abc'),TYPE(NAME='CHAR_DIGEST_LIKE'))),
 (NAME=order_id, CIPHER =order_cipher,TYPE(NAME='MD5'))
 ), QUERY_WITH_CIPHER_COLUMN=true),
 t_encrypt_2 (
@@ -60,7 +62,7 @@ COLUMNS(
 
 ALTER ENCRYPT RULE t_encrypt (
 COLUMNS(
-(NAME=user_id,PLAIN=user_plain,CIPHER=user_cipher,TYPE(NAME='AES',PROPERTIES('aes-key-value'='123456abc'))),
+(NAME=user_id,PLAIN=user_plain,CIPHER=user_cipher,ASSISTED_QUERY_COLUMN=user_assisted,LIKE_QUERY_COLUMN=user_like,TYPE(NAME='MD5'),TYPE(NAME='AES',PROPERTIES('aes-key-value'='123456abc'),TYPE(NAME='CHAR_DIGEST_LIKE'))),
 (NAME=order_id,CIPHER=order_cipher,TYPE(NAME='MD5'))
 ), QUERY_WITH_CIPHER_COLUMN=TRUE);
 
diff --git a/test/integration-test/discovery/src/test/java/org/apache/shardingsphere/test/integration/discovery/cases/base/BaseITCase.java b/test/integration-test/discovery/src/test/java/org/apache/shardingsphere/test/integration/discovery/cases/base/BaseITCase.java
index 1bbce5b49f6..16ffc2ea247 100644
--- a/test/integration-test/discovery/src/test/java/org/apache/shardingsphere/test/integration/discovery/cases/base/BaseITCase.java
+++ b/test/integration-test/discovery/src/test/java/org/apache/shardingsphere/test/integration/discovery/cases/base/BaseITCase.java
@@ -42,7 +42,6 @@ import static org.junit.Assert.assertNotEquals;
 import static org.hamcrest.CoreMatchers.is;
 import static org.hamcrest.MatcherAssert.assertThat;
 
-
 /**
  * Base integration test.
  */
diff --git a/test/integration-test/discovery/src/test/java/org/apache/shardingsphere/test/integration/discovery/cases/mysql/MySQLMGRPrimaryDataSourceChangedIT.java b/test/integration-test/discovery/src/test/java/org/apache/shardingsphere/test/integration/discovery/cases/mysql/MySQLMGRPrimaryDataSourceChangedIT.java
index dbe34be97aa..89b3b7cefa5 100644
--- a/test/integration-test/discovery/src/test/java/org/apache/shardingsphere/test/integration/discovery/cases/mysql/MySQLMGRPrimaryDataSourceChangedIT.java
+++ b/test/integration-test/discovery/src/test/java/org/apache/shardingsphere/test/integration/discovery/cases/mysql/MySQLMGRPrimaryDataSourceChangedIT.java
@@ -33,7 +33,6 @@ import java.util.Collection;
 import java.util.Collections;
 import java.util.LinkedList;
 
-
 /**
  * MySQL MGR primary data source changed Integration Test.
  */