FlyingZC opened a new issue, #35092: URL: https://github.com/apache/shardingsphere/issues/35092
# Background Hi community, ShardingSphere's parser engine enables users to parse SQL into AST (Abstract Syntax Tree) and convert it into SQLStatement objects. This issue focuses on enhancing MySQL stored procedure parsing capabilities to support complex database programming logic. More details: https://shardingsphere.apache.org/document/current/en/reference/sharding/parse/ # Issue Background Explanation These SQL statements are from the official MySQL test set. You can find the corresponding stored procedure SQL statements in the following website: https://github.com/mysql/mysql-server/tree/8.0/mysql-test/t These SQL cases are then passed to ShardingSphere's parsing engine for analysis. For SQL cases that fail to be parsed successfully, every 3 to 5 SQL cases are grouped together as an issue. 1. It cannot be guaranteed that all SQL cases are correct. Please follow the following process to handle this pull request (PR). 2. Some SQL cases may have already been fixed in other PRs. For cases that can already be executed successfully, simply leave a comment to ignore them. 3. If a SQL case can be executed successfully without any code changes, there is no need to add a corresponding test assert file. # Task This issue requires adding support for the following MySQL stored procedure syntax: ```sql -- The original file and line number of the sql: keywords:134 CREATE PROCEDURE p1() BEGIN DECLARE slow INT; DECLARE general INT; DECLARE ignore_server_ids INT; DECLARE source_heartbeat_period INT; SELECT max(t1.slow) INTO slow FROM t1; SELECT max(t1.general) INTO general FROM t1; SELECT max(t1.ignore_server_ids) INTO ignore_server_ids FROM t1; SELECT max(t1.source_heartbeat_period) INTO source_heartbeat_period FROM t1; SELECT slow, general, ignore_server_ids, source_heartbeat_period; END ``` ```sql -- The original file and line number of the sql: keywords:159 CREATE PROCEDURE p2() BEGIN DECLARE n INT DEFAULT 2; general: WHILE n > 0 DO SET n = n -1; END WHILE general; SET n = 2; slow: WHILE n > 0 DO SET n = n -1; END WHILE slow; SET n = 2; ignore_server_ids: WHILE n > 0 DO SET n = n -1; END WHILE ignore_server_ids; SET n = 2; source_heartbeat_period: WHILE n > 0 DO SET n = n -1; END WHILE source_heartbeat_period; END ``` ```sql -- The original file and line number of the sql: library_privileges:103 CREATE PROCEDURE lib_uses_both() LANGUAGE JAVASCRIPT AS $$ console.log("Hello world") $$ ``` ```sql -- The original file and line number of the sql: m_i_db_createschema:287 CREATE DEFINER=root@localhost PROCEDURE check_warnings(OUT result INT) BEGIN DECLARE `pos` bigint unsigned; -- Don't write these queries to binlog SET SQL_LOG_BIN=0; -- -- Remove mark from lines that are suppressed by global suppressions -- UPDATE error_log el, global_suppressions gs SET suspicious=0 WHERE el.suspicious=1 AND el.line REGEXP gs.pattern; -- -- Remove mark from lines that are suppressed by test specific suppressions -- UPDATE error_log el, test_suppressions ts SET suspicious=0 WHERE el.suspicious=1 AND el.line REGEXP ts.pattern; -- -- Get the number of marked lines and return result -- SELECT COUNT(*) INTO @num_warnings FROM error_log WHERE suspicious=1; IF @num_warnings > 0 THEN SELECT line FROM error_log WHERE suspicious=1; --SELECT * FROM test_suppressions; -- Return 2 -> check failed SELECT 2 INTO result; ELSE -- Return 0 -> OK SELECT 0 INTO RESULT; END IF; -- Cleanup for next test TRUNCATE test_suppressions; DROP TABLE error_log; END ``` # Overall Procedure If you intend to participate in fixing this issue, please feel free to leave a comment below the issue. Community members will assign the issue accordingly. For example, you can leave a comment like this: "Hi, please assign this issue to me. Thank you!" Once you have claimed the issue, please review the syntax of the SQL on the official website of the corresponding database. Execute the SQL on the respective database to ensure the correctness of the SQL syntax. You can check the corresponding source of each SQL case on the official database website. Next, execute the problematic SQL cases mentioned above in the database (you can quickly start the corresponding database using the Docker image for that database, and then connect to it using a client you are familiar with), to ensure that the SQL syntax itself is correct. Once you have confirmed the correctness of the SQL syntax, you can validate and fix the grammar parsing issue in ShardingSphere. >If you are using IntelliJ IDEA, you will need to install the ANTLR plugin before proceeding. If it is an ANTLR parsing error message, try to repair the `.g4` file by comparing it with the official database syntax until the SQL can be correctly parsed by ANTLR. When there is no error message in the ANTLR Preview window, it means that ANTLR can correctly parse the SQL. After ANTLR parses SQL into an abstract syntax tree, ShardingSphere will access the abstract syntax tree through Visitor and extract the required information. If you need to extract Segments, you need to first execute: ```shell mvn -T 2C clean install -DskipTests ``` Under the shardingsphere-parser module to compile the entire parser module. Then rewrite the corresponding visit method in SQLStatementVisitorr as needed to extract the corresponding Segment. After the above SQL parsing problem is repaired, the corresponding Test needs to be added. The steps are as follows: 1. Add the corresponding `sql-case` in the `sql/supported` directory. 2. Add case assertions in the case directory of the `shardingsphere-test-it-parser` module. 3. Run `org.apache.shardingsphere.test.it.sql.parser.internal.InternalSQLParserIT` After SQL Parser IT runs successfully, you can submit a PR. 1. Master JAVA language 2. Have a basic understanding of Antlr g4 file 3. Be familiar with MySQL SQLs -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: notifications-unsubscr...@shardingsphere.apache.org.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
