Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/resource-watch/sql2json
Library that converts PostgreSQL queries to/from JSON representation of the query
https://github.com/resource-watch/sql2json
Last synced: 1 day ago
JSON representation
Library that converts PostgreSQL queries to/from JSON representation of the query
- Host: GitHub
- URL: https://github.com/resource-watch/sql2json
- Owner: resource-watch
- Created: 2017-01-25T17:07:36.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2019-02-05T16:33:57.000Z (almost 6 years ago)
- Last Synced: 2024-04-09T11:25:07.049Z (7 months ago)
- Language: JavaScript
- Homepage:
- Size: 204 KB
- Stars: 1
- Watchers: 9
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# SQL2JSON
[](https://travis-ci.org/resource-watch/sql2json)
[](https://codeclimate.com/github/resource-watch/sql2json/test_coverage)
Library that serves two main purposes:
- Converts SQL queries to JSON representation of the query.
- Converts JSON representation of the query to SQL (as supported by [ElasticSearch's SQL plugin](https://github.com/NLPchina/elasticsearch-sql)
Example:
With this SQL
`SELECT * FROM tablename WHERE a > 2 and b < 3 or c = 2`
Return this object:
```json
{
"select":[
{
"value":"*",
"alias":null,
"type":"wildcard"
}
],
"from":"tablename",
"where":{
"type":"conditional",
"value":"or",
"left":{
"type":"conditional",
"value":"and",
"left":{
"type":"operator",
"value":">",
"left":{
"value":"a",
"type":"literal"
},
"right":{
"value":2,
"type":"number"
}
},
"right":{
"type":"operator",
"value":"<",
"left":{
"value":"b",
"type":"literal"
},
"right":{
"value":3,
"type":"number"
}
}
},
"right":{
"type":"operator",
"value":"=",
"left":{
"value":"c",
"type":"literal"
},
"right":{
"value":2,
"type":"number"
}
}
}
}
```
## SQL support
#### Supported
- `select` queries
- `delete` queries
- field alias
- `*` in select clause
- functions with and without arguments
- basic math operators
- constants
#### Unsupported
- Anything other than `select` and `delete` queries
- Subqueries
- Joins
- conditionals
- pretty much everything that's not covered in the tests
## Installation
```
npm install --save sql2json
```
## Use
To convert sql to json:
```javascript
const Sql2json = require('sql2json').sql2json;
new Sql2json().toJSON()
```
The library has a function that it convert json object to sql
To convert json to sql:
```javascript
const Json2sql = require('sql2json').json2sql;
Json2sql.toSQL()
```