tristaZero edited a comment on issue #4853: Add start-index and stop-index 
assertion for `ColumnDefinitionSegment`
URL: 
https://github.com/apache/incubator-shardingsphere/issues/4853#issuecomment-601120579
 
 
   This issue is to count the `start-index` and `stop-index` to assert 
`ColumnDefinitionSegment ` 
   
   ### How to find the targets to be fixed?
   1. Open class `ColumnDefinitionAssert` and clear the comment of 
   ```
           assertThat(assertContext.getText("Column definition start index 
assertion error: "), actual.getStartIndex(), is(expected.getStartIndex()));
           assertThat(assertContext.getText("Column definition stop index 
assertion error: "), actual.getStopIndex(), is(expected.getStopIndex()));
       }
   ```
   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 ` 
ColumnDefinitionSegment` segment of this `SQL`.
   4. Add the calculated `start-index` and `stop-index` labels of 
`ColumnDefinitionSegment` segment to `parsing result` of this `SQL Case ID`, 
like
   ```
               <column-definition type="int" primary-key="true" 
start-index="10" stop-index="11" />
   ```
   5. Add the correct `literal-start-index` and `literal-stop-index` of 
`ColumnDefinitionSegment` segment to `parsing result` of this `SQL Case ID` 
when it is necessary, like
   ```
               <column-definition type="int" primary-key="true"  
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 `ColumnDefinitionSegment` segment?
   
   For instance, here is a SQL,
   > CREATE TABLE t_log(id int PRIMARY KEY, status varchar(10))
   
   The segment of `id int PRIMARY KEY` or `status varchar(10)` is a 
`ColumnDefinitionSegment `, which defines a column.
   
   
   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:
[email protected]


With regards,
Apache Git Services

Reply via email to