-
Notifications
You must be signed in to change notification settings - Fork 490
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
docs: rewrite quickstart.md #884
Conversation
Codecov Report
@@ Coverage Diff @@
## master #884 +/- ##
==========================================
- Coverage 78.37% 78.33% -0.04%
==========================================
Files 40 40
Lines 14783 14765 -18
==========================================
- Hits 11586 11566 -20
- Misses 2509 2511 +2
Partials 688 688 |
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.
Rest LGTM
docs/quickstart.md
Outdated
> Here are a few things you might want to know: | ||
> - To use a parser, a `parser_driver` is required. It decides how to parse the basic data types in SQL. | ||
> | ||
> You can use `github.com/pingcap/parser/test_driver` as the `parser_driver` for test. Again, if you need advanced features, please use the `test_driver` in TiDB(`go get -v github.com/pingcap/tidb/types/parser_driver@v4.0.0-rc.1` and import it). |
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.
> You can use `github.com/pingcap/parser/test_driver` as the `parser_driver` for test. Again, if you need advanced features, please use the `test_driver` in TiDB(`go get -v github.com/pingcap/tidb/types/parser_driver@v4.0.0-rc.1` and import it). | |
> You can use `github.com/pingcap/parser/test_driver` as the `parser_driver` for test. Again, if you need advanced features, please use the `test_driver` in TiDB (`go get -v github.com/pingcap/tidb/types/parser_driver@v4.0.0-rc.1` and import it). |
BTW why 4.0.0-rc.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.
I found the latest released parser version is 4.0.0-rc.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.
Rest LGTM
3822be1
to
f9486ef
Compare
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.
LGTM
Co-authored-by: Ran <huangran@pingcap.com>
Co-authored-by: Ran <huangran@pingcap.com>
Co-authored-by: Ran <huangran@pingcap.com>
Co-authored-by: Ran <huangran@pingcap.com>
Co-authored-by: Ran <huangran@pingcap.com>
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.
Rest LGTM
Co-authored-by: Ran <huangran@pingcap.com>
What problem does this PR solve?
As mentioned in #812, #788, and a few other issues, it is not easy to quickstart with parser. This PR rewrites
quickstart.md
by giving an example of parsing SQL text and traversing AST nodes.What is changed and how it works?
Check List
Tests
Code changes
Side effects
Related changes