HyriseSQLParser/README.md

28 lines
1.0 KiB
Markdown
Raw Normal View History

2014-12-16 02:23:56 +01:00
C++ SQL Parser for Hyrise
=========================
2014-10-24 17:37:03 +02:00
This is a SQL Parser for C++. It parses the given SQL query into C++ objects.
2014-11-10 01:48:33 +01:00
It is developed for integration in hyrise (https://github.com/hyrise/hyrise), but can be used in other environments as well.
2014-10-31 18:54:00 +01:00
2014-11-10 01:48:33 +01:00
### General Usage
2014-10-31 18:54:00 +01:00
**Prerequisites:**
* bison (https://www.gnu.org/software/bison/)
* flex (http://flex.sourceforge.net/)
To create the full parser code run `make build`. The parser library code is created in `build/`.
2014-11-29 13:29:24 +01:00
To use the SQL Parser in your own code, you only need to include `SQLParser.h` and build+link all the source files from the parser with your project. See `hyrise/src/lib/access/sql/SQLQueryParser.cpp` for how it's used in Hyrise.
2014-10-31 18:54:00 +01:00
2014-12-16 02:23:56 +01:00
**Important:** Execute all tests by calling `make test`.
2014-12-03 16:32:56 +01:00
2014-12-16 02:23:56 +01:00
### Documentation
2014-12-03 16:32:56 +01:00
2015-01-26 20:50:01 +01:00
* [Working Syntax Examples](docs/sytax.md)
2014-12-16 02:23:56 +01:00
* [Developer Documentation](docs/documentation.md)
* [Integration in Hyrise](docs/integration.md)
2015-01-26 20:30:53 +01:00
* [Known Issues](docs/issues.md)
**Doxygen:**
Run `make docs` to create the doxygen documentation.