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 2026/09/25 16:23:58 UTC

(shardingsphere) branch master updated: Fix shadow DistSQL rejecting unquoted SQL_HINT algorithm type (#39873)

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

terrymanu 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 8b510cd5549 Fix shadow DistSQL rejecting unquoted SQL_HINT algorithm type (#39873)
8b510cd5549 is described below

commit 8b510cd5549a590d28c69ddb4709bfcc55751820
Author: Eunbin Son <58...@users.noreply.github.com>
AuthorDate: Sat Sep 26 01:23:51 2026 +0900

    Fix shadow DistSQL rejecting unquoted SQL_HINT algorithm type (#39873)
    
    * Fix shadow DistSQL rejecting unquoted SQL_HINT algorithm type
    
    * Keep SQL_HINT usable as shadow DistSQL identifier
    
    Recognizing SQL_HINT as a keyword for the unquoted algorithm type made it
    reserved wherever the shadow grammar expects IDENTIFIER_, so existing
    statements such as CREATE SHADOW RULE SQL_HINT(...) failed to parse.
    Accept SQL_HINT in the shadow identifier positions and add a parser case
    for a rule named SQL_HINT.
---
 RELEASE-NOTES.md                                               |  1 +
 .../distsql/parser/src/main/antlr4/imports/shadow/BaseRule.g4  |  8 ++++++--
 .../distsql/parser/src/main/antlr4/imports/shadow/Keyword.g4   |  2 +-
 .../parser/src/main/antlr4/imports/shadow/RDLStatement.g4      |  8 ++++----
 .../parser/src/main/antlr4/imports/shadow/RQLStatement.g4      |  2 +-
 test/it/parser/src/main/resources/case/rdl/alter.xml           |  6 ++++++
 test/it/parser/src/main/resources/case/rdl/create.xml          | 10 ++++++++++
 test/it/parser/src/main/resources/sql/supported/rdl/alter.xml  |  1 +
 test/it/parser/src/main/resources/sql/supported/rdl/create.xml |  1 +
 9 files changed, 31 insertions(+), 8 deletions(-)

diff --git a/RELEASE-NOTES.md b/RELEASE-NOTES.md
index ae40ef2ba93..afa19f94fd5 100644
--- a/RELEASE-NOTES.md
+++ b/RELEASE-NOTES.md
@@ -49,6 +49,7 @@
 1. DistSQL: Fix empty rows returned by SHOW SHADOW TABLE RULE for specified table - [#39739](https://github.com/apache/shardingsphere/pull/39739)
 1. DistSQL: Fix `CREATE READWRITE_SPLITTING RULE IF NOT EXISTS` failing for an existing rule name - [#39371](https://github.com/apache/shardingsphere/pull/39371)
 1. DistSQL: Match mask table names case-insensitively in create and alter executors - [#39361](https://github.com/apache/shardingsphere/pull/39361)
+1. DistSQL: Fix shadow DistSQL rejecting unquoted `SQL_HINT` algorithm type - [#39873](https://github.com/apache/shardingsphere/pull/39873)
 1. JDBC: Fix stale generated values leaking into prepared statement executeBatch calls without pending batches - [#38160](https://github.com/apache/shardingsphere/pull/38160)
 1. JDBC: Fix MySQL-compatible typed string conversion for `ResultSet#getObject(index, Class<T>)` - [#38444](https://github.com/apache/shardingsphere/pull/38444)
 1. JDBC: Fix statement close invalidating live result sets of other statements on the same connection - [#39503](https://github.com/apache/shardingsphere/pull/39503)
diff --git a/features/shadow/distsql/parser/src/main/antlr4/imports/shadow/BaseRule.g4 b/features/shadow/distsql/parser/src/main/antlr4/imports/shadow/BaseRule.g4
index ff953d01e87..f0a41341b7a 100644
--- a/features/shadow/distsql/parser/src/main/antlr4/imports/shadow/BaseRule.g4
+++ b/features/shadow/distsql/parser/src/main/antlr4/imports/shadow/BaseRule.g4
@@ -50,9 +50,13 @@ property
     ;
 
 tableName
-    : IDENTIFIER_
+    : identifier
     ;
 
 ruleName
-    : IDENTIFIER_
+    : identifier
+    ;
+
+identifier
+    : IDENTIFIER_ | SQL_HINT
     ;
diff --git a/features/shadow/distsql/parser/src/main/antlr4/imports/shadow/Keyword.g4 b/features/shadow/distsql/parser/src/main/antlr4/imports/shadow/Keyword.g4
index 2e706d0e631..74ae7d78fcf 100644
--- a/features/shadow/distsql/parser/src/main/antlr4/imports/shadow/Keyword.g4
+++ b/features/shadow/distsql/parser/src/main/antlr4/imports/shadow/Keyword.g4
@@ -144,7 +144,7 @@ REGEX_MATCH
     ;
 
 SQL_HINT
-    : S I M P L E UL_ H I N T
+    : S Q L UL_ H I N T
     ;
 
 NOT
diff --git a/features/shadow/distsql/parser/src/main/antlr4/imports/shadow/RDLStatement.g4 b/features/shadow/distsql/parser/src/main/antlr4/imports/shadow/RDLStatement.g4
index c5070ec67d0..2e05bc086f6 100644
--- a/features/shadow/distsql/parser/src/main/antlr4/imports/shadow/RDLStatement.g4
+++ b/features/shadow/distsql/parser/src/main/antlr4/imports/shadow/RDLStatement.g4
@@ -56,19 +56,19 @@ shadowTableRule
     ;
 
 source
-    : IDENTIFIER_
+    : identifier
     ;
 
 shadow
-    : IDENTIFIER_
+    : identifier
     ;
 
 tableName
-    : IDENTIFIER_
+    : identifier
     ;
 
 algorithmName
-    : IDENTIFIER_
+    : identifier
     ;
 
 ifExists
diff --git a/features/shadow/distsql/parser/src/main/antlr4/imports/shadow/RQLStatement.g4 b/features/shadow/distsql/parser/src/main/antlr4/imports/shadow/RQLStatement.g4
index cc64da260a6..ec4276f8327 100644
--- a/features/shadow/distsql/parser/src/main/antlr4/imports/shadow/RQLStatement.g4
+++ b/features/shadow/distsql/parser/src/main/antlr4/imports/shadow/RQLStatement.g4
@@ -48,5 +48,5 @@ tableRule
     ;
 
 databaseName
-    : IDENTIFIER_
+    : identifier
     ;
diff --git a/test/it/parser/src/main/resources/case/rdl/alter.xml b/test/it/parser/src/main/resources/case/rdl/alter.xml
index 8ff9378c902..7b8b5f14738 100644
--- a/test/it/parser/src/main/resources/case/rdl/alter.xml
+++ b/test/it/parser/src/main/resources/case/rdl/alter.xml
@@ -315,6 +315,12 @@
         </shadow-algorithm>
     </alter-default-shadow-algorithm>
     
+    <alter-default-shadow-algorithm sql-case-id="alter-default-shadow-algorithm-without-quote-on-build-in-algorithm-type">
+        <shadow-algorithm algorithm-id="default">
+            <algorithm algorithm-name="SQL_HINT"/>
+        </shadow-algorithm>
+    </alter-default-shadow-algorithm>
+    
     <alter-default-sharding-strategy sql-case-id="alter-default-sharding-strategy">
         <strategy default-type="TABLE" strategy-type="standard" sharding-column="order_id">
             <algorithm-segment algorithm-name="INLINE">
diff --git a/test/it/parser/src/main/resources/case/rdl/create.xml b/test/it/parser/src/main/resources/case/rdl/create.xml
index 1a520ecc062..24c2ebb083e 100644
--- a/test/it/parser/src/main/resources/case/rdl/create.xml
+++ b/test/it/parser/src/main/resources/case/rdl/create.xml
@@ -723,6 +723,16 @@
         </rule>
     </create-shadow-rule>
     
+    <create-shadow-rule sql-case-id="create-shadow-rule-named-sql-hint">
+        <rule name="SQL_HINT" source="demo_ds" shadow="demo_ds_shadow">
+            <table-rule table-name="t_order">
+                <shadow-algorithm algorithm-id="sql_hint_t_order_sql_hint_0">
+                    <algorithm algorithm-name="SQL_HINT" />
+                </shadow-algorithm>
+            </table-rule>
+        </rule>
+    </create-shadow-rule>
+    
     <create-mask-rule sql-case-id="create-mask-rule">
         <rule name="t_mask">
             <column name="phone_number">
diff --git a/test/it/parser/src/main/resources/sql/supported/rdl/alter.xml b/test/it/parser/src/main/resources/sql/supported/rdl/alter.xml
index a11891572d1..73d20ec8205 100644
--- a/test/it/parser/src/main/resources/sql/supported/rdl/alter.xml
+++ b/test/it/parser/src/main/resources/sql/supported/rdl/alter.xml
@@ -33,6 +33,7 @@
     <sql-case id="alter-encrypt-rule-with-like-query-column" value="ALTER ENCRYPT RULE t_encrypt (COLUMNS((NAME=user_id,CIPHER=user_cipher,LIKE_QUERY_COLUMN=like_column, ENCRYPT_ALGORITHM(TYPE(NAME='AES',PROPERTIES('aes-key-value'='123456abc', 'digest-algorithm-name'='SHA-1'))), LIKE_QUERY_ALGORITHM(TYPE(NAME='CHAR_DIGEST_LIKE'))), (NAME=order_id, CIPHER=order_cipher,ENCRYPT_ALGORITHM(TYPE(NAME='RC4',PROPERTIES('rc4-key-value'='123456abc'))))))" db-types="ShardingSphere" />
     <sql-case id="alter-encrypt-rule-with-query-with-cipher-column" value="ALTER ENCRYPT RULE t_encrypt (COLUMNS((NAME=user_id,CIPHER=user_cipher, ENCRYPT_ALGORITHM(TYPE(NAME='AES',PROPERTIES('aes-key-value'='123456abc', 'digest-algorithm-name'='SHA-1')))), (NAME=order_id, CIPHER=order_cipher,ENCRYPT_ALGORITHM(TYPE(NAME='RC4',PROPERTIES('rc4-key-value'='123456abc'))))))" db-types="ShardingSphere" />
     <sql-case id="alter-default-shadow-algorithm" value="ALTER DEFAULT SHADOW ALGORITHM TYPE(NAME='SQL_HINT')" db-types="ShardingSphere" />
+    <sql-case id="alter-default-shadow-algorithm-without-quote-on-build-in-algorithm-type" value="ALTER DEFAULT SHADOW ALGORITHM TYPE(NAME=SQL_HINT)" db-types="ShardingSphere" />
     <sql-case id="alter-shadow-rule" value="ALTER SHADOW RULE shadow_rule(SOURCE=demo_ds,SHADOW=demo_ds_shadow,t_order(TYPE(NAME='REGEX_MATCH',PROPERTIES('operation'='insert','column'='user_id','regex'='[1]')),TYPE(NAME='SQL_HINT')))" db-types="ShardingSphere" />
     <sql-case id="alter-sharding-auto-table-rule" value="ALTER SHARDING TABLE RULE t_order (STORAGE_UNITS(ms_group_0,ms_group_1), SHARDING_COLUMN=order_id, TYPE(NAME='hash_mod',PROPERTIES('sharding-count'='4')),KEY_GENERATE_STRATEGY(COLUMN=another_id,TYPE(NAME='snowflake')))" db-types="ShardingSphere" />
     <sql-case id="alter-sharding-auto-table-rule-with-inline-expression" value="ALTER SHARDING TABLE RULE t_order (STORAGE_UNITS('ms_group_${0..1}'), SHARDING_COLUMN=order_id, TYPE(NAME='hash_mod',PROPERTIES('sharding-count'='4')),KEY_GENERATE_STRATEGY(COLUMN=another_id,TYPE(NAME='snowflake')))" db-types="ShardingSphere" />
diff --git a/test/it/parser/src/main/resources/sql/supported/rdl/create.xml b/test/it/parser/src/main/resources/sql/supported/rdl/create.xml
index 73e59f5d792..38a9a2a2a52 100644
--- a/test/it/parser/src/main/resources/sql/supported/rdl/create.xml
+++ b/test/it/parser/src/main/resources/sql/supported/rdl/create.xml
@@ -77,6 +77,7 @@
     <sql-case id="create-encrypt-rule-with-quota" value="CREATE ENCRYPT RULE `encrypt` (COLUMNS((NAME=user_id,CIPHER=user_cipher,ENCRYPT_ALGORITHM(TYPE(NAME='AES',PROPERTIES('aes-key-value'='123456abc', 'digest-algorithm-name'='SHA-1')))), (NAME=order_id, CIPHER=order_cipher,ENCRYPT_ALGORITHM(TYPE(NAME='RC4',PROPERTIES('rc4-key-value'='123456abc'))))))" db-types="ShardingSphere" />
     <sql-case id="create-encrypt-rule-with-query-with-cipher-column" value="CREATE ENCRYPT RULE `encrypt` (COLUMNS((NAME=user_id,CIPHER=user_cipher,ENCRYPT_ALGORITHM(TYPE(NAME='AES',PROPERTIES('aes-key-value'='123456abc', 'digest-algorithm-name'='SHA-1'))))))" db-types="ShardingSphere" />
     <sql-case id="create-shadow-rule-with-quota" value="CREATE SHADOW RULE `shadow_rule`(SOURCE=demo_ds,SHADOW=demo_ds_shadow,t_order(TYPE(NAME='REGEX_MATCH',PROPERTIES('operation'='insert','column'='user_id','regex'='[1]')),TYPE(NAME='SQL_HINT')))" db-types="ShardingSphere" />
+    <sql-case id="create-shadow-rule-named-sql-hint" value="CREATE SHADOW RULE SQL_HINT(SOURCE=demo_ds,SHADOW=demo_ds_shadow,t_order(TYPE(NAME=SQL_HINT)))" db-types="ShardingSphere" />
     <sql-case id="single-register-migration-source-storage-unit" value="REGISTER MIGRATION SOURCE STORAGE UNIT ds_0 (URL='jdbc:mysql://127.0.0.1:3306/test0',USER='ROOT',PASSWORD='123456');" db-types="ShardingSphere" />
     <sql-case id="create-mask-rule" value="CREATE MASK RULE t_mask (COLUMNS((NAME=phone_number,TYPE(NAME='MASK_FROM_X_TO_Y', PROPERTIES('from-x'=1, 'to-y'=2, 'replace-char'='*'))), (NAME=address,TYPE(NAME=MD5))));" db-types="ShardingSphere" />
     <sql-case id="create-mask-rule-if-not-exists" value="CREATE MASK RULE IF NOT EXISTS t_mask (COLUMNS((NAME=phone_number,TYPE(NAME='MASK_FROM_X_TO_Y', PROPERTIES('from-x'=1, 'to-y'=2, 'replace-char'='*'))), (NAME=address,TYPE(NAME=MD5))));" db-types="ShardingSphere" />