71 lines
3.3 KiB
Markdown
71 lines
3.3 KiB
Markdown
# Parser - A MySQL Compatible SQL Parser
|
|
|
|
[](https://goreportcard.com/report/github.com/pingcap/parser)
|
|
[](https://circleci.com/gh/pingcap/parser)
|
|
[](https://godoc.org/github.com/pingcap/parser)
|
|
[](https://codecov.io/gh/pingcap/parser)
|
|
|
|
The goal of this project is to build a Golang parser that is fully compatible with MySQL syntax, easy to extend, and high performance. Currently, features supported by parser are as follows:
|
|
|
|
- Highly compatible with MySQL: it supports almost all features of MySQL. For the complete details, see [parser.y](https://github.com/pingcap/tidb/blob/master/parser/parser.y) and [hintparser.y](https://github.com/pingcap/tidb/blob/master/parser/hintparser.y).
|
|
- Extensible: adding a new syntax requires only a few lines of Yacc and Golang code changes. As an example, see [PR-680](https://github.com/pingcap/parser/pull/680/files).
|
|
- Good performance: the parser is generated by goyacc in a bottom-up approach. It is efficient to build an AST tree with a state machine.
|
|
|
|
## How to use it
|
|
|
|
Please read the [quickstart](https://github.com/pingcap/tidb/blob/master/parser/docs/quickstart.md).
|
|
|
|
## Future
|
|
|
|
- Support more MySQL syntax
|
|
- Optimize the code structure, make it easier to extend
|
|
- Improve performance and benchmark
|
|
- Improve the quality of code and comments
|
|
|
|
## Getting Help
|
|
|
|
- [GitHub Issue](https://github.com/pingcap/tidb/issues)
|
|
- [Stack Overflow](https://stackoverflow.com/questions/tagged/tidb)
|
|
- [User Group (Chinese)](https://asktug.com/)
|
|
|
|
If you have any questions, feel free to discuss in sig-ddl. Here are the steps to join:
|
|
1. Join [TiDB Slack community](https://pingcap.com/tidbslack/), and then
|
|
2. Join [sig-ddl Slack channel](https://slack.tidb.io/invite?team=tidb-community&channel=sig-ddl&ref=github_sig).
|
|
|
|
If you want to join as a special interest group member, see [DDL Special Interest Group](https://github.com/pingcap/community/tree/master/special-interest-groups/sig-ddl).
|
|
|
|
## Users
|
|
|
|
These projects use this parser. Please feel free to extend this list if you
|
|
found you are one of the users but not listed here:
|
|
|
|
- [pingcap/tidb](https://github.com/pingcap/tidb)
|
|
- [XiaoMi/soar](https://github.com/XiaoMi/soar)
|
|
- [XiaoMi/Gaea](https://github.com/XiaoMi/Gaea)
|
|
- [sql-machine-learning/sqlflow](https://github.com/sql-machine-learning/sqlflow)
|
|
- [nooncall/shazam](https://github.com/nooncall/shazam)
|
|
- [bytebase/bytebase](https://github.com/bytebase/bytebase)
|
|
|
|
## Contributing
|
|
|
|
Contributions are welcomed and greatly appreciated. See [Contribution Guide](https://github.com/pingcap/community/blob/master/contributors/README.md) for details on submitting patches and the contribution workflow.
|
|
|
|
## Acknowledgments
|
|
|
|
Thanks [cznic](https://github.com/cznic) for providing some great open-source tools.
|
|
|
|
## License
|
|
Parser is under the Apache 2.0 license. See the LICENSE file for details.
|
|
|
|
## More resources
|
|
|
|
- TiDB documentation
|
|
|
|
- [English](https://docs.pingcap.com/tidb/stable)
|
|
- [简体中文](https://docs.pingcap.com/zh/tidb/stable)
|
|
|
|
- TiDB blog
|
|
|
|
- [English](https://pingcap.com/blog/)
|
|
- [简体中文](https://pingcap.com/blog-cn/)
|