[GitHub] [incubator-shardingsphere] tristaZero edited a comment on issue #4781: Add start-index and stop-index assertion for LiteralExpressionSegment

[GitBox <gi...@apache.org>]

tristaZero edited a comment on issue #4781: Add start-index and stop-index assertion for LiteralExpressionSegment
URL: https://github.com/apache/incubator-shardingsphere/issues/4781#issuecomment-599462168
 
 
   ### How to find the targets to be fixed?
   1. Open class `ExpressionAssert` and clear the comment of `SQLSegmentAssert.assertIs(assertContext, actual, expected)` in `assertLiteralExpression`.
   2. run `SQLParserParameterizedTest`
   3. All the SQL cases which have the error assertion results are our targets to be fixed.
   
   ### How to fix the above assertion results?
   1. Look at the exception log and find the corresponding `SQL Case ID` and `SQL`.
   2. Find out the `parsing result` of this `SQL Case ID` in `./incubator-shardingsphere/shardingsphere-sql-parser/shardingsphere-sql-parser-test/src/test/resources/sql/dml`
   3. Calculate the correct `start-index` and `stop-index` of `literal-expression` segment of this `SQL`.
   4. Add the calculated `start-index` and `stop-index` labels of `literal-expression` segment to `parsing result` of this `SQL Case ID`, like
   ```
               <literal-expression value="init" start-index="10" stop-index="11" />
   ```
   5. Add the correct `literal-start-index` and `literal-stop-index` of `literal-expression` segment to `parsing result` of this `SQL Case ID` when it is necessary, like
   ```
               <literal-expression value="init" literal-start-index="10" literal-stop-index="11" />
   ```
   6. Run `SQLParserParameterizedTest` again to check whether this `SQL Case ID` does not stay in the list of `SQL` with  `bad assertion result`.
   
   ### Note
   
   1. What is the definition of `literal-expression`?
   
   For instance, here is a SQL,
   > select * from tb where id = 1 or id =?
   
   The value of `1` is a `LiteralExpressionSegment`, on the other hand, `?` is a `ParameterMarkerExpression `.
   
   2. What is the difference between `literal-start-index` and `start-index`?
   
   When a SQL does not contain parameter maker, i.e.,`?`, this SQL only has one form; Otherwise, you will see two forms of this SQL, i.e, a SQL form filled with parameter and a SQL form only with parameter marks. For instance,
   ```
   Case1 One SQL without parameter mark,
   select * from table where id = 1;
   
   Case2 One SQL with parameter mark,
   Original SQL: select * from table where id = ?;
   SQL filled with Parameter: select * from table where id = 1;
   ```
   Replace `the parameter mark` with `the actual parameter` will change the position of the segment. Therefore we need to add `start-index` to represent the start position of a segment for `Original SQL`, and `literal-start-index` is used to represent the start position of a segment for `SQL filled with Parameter`.
   

----------------------------------------------------------------
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.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services