-
Notifications
You must be signed in to change notification settings - Fork 651
Add support for C-style comments #2034
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
5089fd5
to
4123881
Compare
This commit adds support for C-style comments supported by MySQL. It parses and consumes the optional version number after the `!` character and leading whitespace.
4123881
to
e5de267
Compare
} | ||
#[test] | ||
fn tokenize_multiline_comment_with_c_style_comment() { | ||
let sql = String::from("0/*! word */1"); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looking at their docs, I'm wondering if/how we support these examples?
SELECT /*! STRAIGHT_JOIN */ col1 FROM table1,table2
/*!50110 KEY_BLOCK_SIZE=1024 */
SELECT /*! BKA(t1) */ FROM T
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@iffyio - Parsing the c_style comment unblocks sqlparser to not discard those as if they were a normal comment. Support for each hint will have to be added in a case by case bases. For example #2033 - MySQL adds a c-style comment if you run SHOW CREATE TABLE:
mysql> SHOW CREATE TABLE b;
+-------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Table | Create Table |
+-------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| b | CREATE TABLE `b` (
`ID` int DEFAULT NULL,
`b` char(1) DEFAULT NULL /*!80023 INVISIBLE */
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci |
+-------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
1 row in set (0,008 sec)
Without the current patch, the invisible keyword will be discarded.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah so to clarify I'm rather wondering regarding the parser behavior for hints that aren't singe words e.g. /*!50110 KEY_BLOCK_SIZE=1024 */
- can we demonstrate the behavior with test cases for such scenarios?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@iffyio thanks flagging this. I have fixed the issue and now we properly return individual tokens inside a C-style hint comment.
Documented the C-style comments with an example.
} | ||
#[test] | ||
fn tokenize_multiline_comment_with_c_style_comment() { | ||
let sql = String::from("0/*! word */1"); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah so to clarify I'm rather wondering regarding the parser behavior for hints that aren't singe words e.g. /*!50110 KEY_BLOCK_SIZE=1024 */
- can we demonstrate the behavior with test cases for such scenarios?
Added the pending tokens structure to properly return all tokens inside a c-style hint comment.
This commit adds support for C-style comments supported by MySQL. It parses and consumes the optional version number after the
!
character.