HyriseSQLParser/README.md

76 lines
3.2 KiB
Markdown
Raw Normal View History

C++ SQL Parser
2014-12-16 02:23:56 +01:00
=========================
[![GitHub release](https://img.shields.io/github/release/hyrise/sql-parser.svg?maxAge=2592000)]()
[![Build Status](https://img.shields.io/travis/hyrise/sql-parser.svg?maxAge=2592000)](https://travis-ci.org/hyrise/sql-parser)
2014-10-24 17:37:03 +02:00
This is a SQL Parser for C++. It parses the given SQL query into C++ objects.
It has been developed for integration in [Hyrise](https://github.com/hyrise/hyrise), but can be used perfectly well in other environments as well.
2014-10-31 18:54:00 +01:00
2015-12-23 16:39:59 +01: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).
2015-05-27 22:24:22 +02:00
2015-12-23 16:57:59 +01:00
## Usage
2015-05-27 22:24:22 +02:00
2016-02-27 18:39:16 +01:00
**Note:** You can also find a detailed usage description at this [blog post](http://torpedro.github.io/tech/c++/sql/parser/2016/02/27/c++-sql-parser.html).
2016-02-27 16:58:51 +01:00
**Requirements:**
2016-05-24 15:15:01 +02:00
* gcc 4.8+ (or clang 3.4+)
2016-02-27 16:58:51 +01:00
2016-05-24 15:15:01 +02:00
To use the SQL parser in your own projects you simply have to follow these few steps. The only requirement for is gcc 4.8+. Older versions of gcc/clang might also work, but are untested.
2015-05-27 22:37:46 +02:00
2015-12-23 17:00:09 +01:00
1. Download the [latest release here](https://github.com/hyrise/sql-parser/releases)
2015-12-23 16:39:59 +01:00
2. Compile the library `make` to create `libsqlparser.so`
3. *(Optional, Recommended)* Run `make install` to copy the library to `/usr/local/lib/`
4. Run the tests `make test` to make sure everything worked
5. Include the `SQLParser.h` from `src/` (or from `/usr/local/lib/hsql/` if you installed it) and link the library in your project
6. Take a look at the [example project here](https://github.com/hyrise/sql-parser/tree/master/example)
```cpp
#include "hsql/SQLParser.h"
/* ... */
{
// Basic Usage Example
const std::string query = "...";
hsql::SQLParserResult result;
hsql::SQLParser::parseSQLString(query, &result);
if (result.isValid() && result.size() > 0) {
const hsql::SQLStatement* statement = result.getStatement(0);
if (statement.isType(hsql::SelectStatement)) {
const hsql::SelectStatement* select = (const hsql::SelectStatement*) statement;
/* ... */
}
}
}
2015-12-23 16:57:59 +01:00
```
Quick Links:
2015-12-23 16:57:59 +01:00
* [SQLParser.h](src/SQLParser.h)
* [SQLParserResult.h](src/SQLParserResult.h)
* [SelectStatement.h](src/sql/SelectStatement.h)
2015-04-15 09:18:40 +02:00
## How to Contribute
2015-04-15 09:18:40 +02:00
**[Developer Documentation](docs/)**
2015-08-28 13:50:53 +02:00
We strongly encourage you to contribute to this project! If you want to contribute to this project there are several options. If you've noticed a bug or would like an improvement let us know by creating a [new issue](https://github.com/hyrise/sql-parser/issues). If you want to develop a new feature yourself or just improve the quality of the system, feel free to fork the reposistory and implement your changes. Open a pull request as soon as your done and we will look over it. If we think it's good then your pull request will be merged into this repository.
2015-12-23 16:57:59 +01:00
## License
2015-04-15 09:18:40 +02:00
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.
2015-12-23 16:57:59 +01:00
## Contributers
2015-12-23 16:57:59 +01:00
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))