HyriseSQLParser/README.md

49 lines
1.8 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
2015-05-27 22:24:22 +02:00
### Links
* [General Usage](#general-usage)
* [License](#license)
* [Contributers](#contributers)
* [Working Syntax Examples](docs/syntax.md)
* [Known Issues](docs/issues.md)
* [Developer Documentation](docs/documentation.md)
* [Integration in Hyrise](docs/integration.md)
2015-05-27 22:37:46 +02:00
In March 2015 we've also written a short paper outlining discussing some development details and the integration into our database Hyrise. You can find the paper [here](http://torpedro.com/paper/HyriseSQL-03-2015.pdf).
2014-11-10 01:48:33 +01:00
### General Usage
2014-10-31 18:54:00 +01:00
**Prerequisites:**
2015-05-27 22:30:44 +02:00
* [bison](https://www.gnu.org/software/bison/) (tested with v3.0.2)
* [flex](http://flex.sourceforge.net/) (tested with v2.5.5)
2014-10-31 18:54:00 +01:00
2015-05-27 22:30:44 +02:00
The parser library code is created in `build/`. To create the full parser code run
```
make build
````
2014-10-31 18:54:00 +01:00
2015-01-26 20:33:22 +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`](https://github.com/hyrise/hyrise/blob/master/src/lib/access/sql/SQLQueryParser.cpp) for how it's used in Hyrise.
2014-10-31 18:54:00 +01:00
2015-05-27 22:30:44 +02:00
**Important:** Run tests and add tests for new features.
```
make test
```
2014-12-03 16:32:56 +01:00
2015-04-15 09:18:40 +02:00
### Contributers
The following people contributed to HYRISE sql-parser in various forms.
* Pedro Flemming ([@torpedro](https://github.com/torpedro))
* David Schwalb ([@schwald](https://github.com/schwald))
2015-04-15 09:18:40 +02:00
### License
HYRISE sql-parser is licensed as open source after the OpenSource "Licence of the Hasso-Plattner Institute" declared in the LICENSE file of this project.