https://github.com/hazlema/sqlparse
Basic SQLParser, Parses the SQL query into an object. You can then apply the query results to a JS dataset.
https://github.com/hazlema/sqlparse
js node parse sql
Last synced: 2 months ago
JSON representation
Basic SQLParser, Parses the SQL query into an object. You can then apply the query results to a JS dataset.
- Host: GitHub
- URL: https://github.com/hazlema/sqlparse
- Owner: hazlema
- License: mit
- Created: 2021-05-04T07:23:57.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-05-10T02:32:40.000Z (about 5 years ago)
- Last Synced: 2025-03-04T17:36:02.153Z (over 1 year ago)
- Topics: js, node, parse, sql
- Language: JavaScript
- Homepage:
- Size: 259 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# *SQLParse*
🚧 ***Under Heavy Development*** 🚧
Basic JS SQLParser, creates an object that contains the parsed SQL(ish) query. You can then apply the query to a dataset.
Only supports select, where and orderby.
### *Functions*
Some Functions are now chainable, marked with 🔗
| Function | Description |
| -------- | ----------- |
| **hasQuery** | Is the query set? |
| **hasSelect** | Does the query have a **Select** statement |
| **hasWhere** | Does the query have a **Where** statement |
| **hasOrderBy** | Does the query have an **OrderBy** statement |
| | |
| **get** | Return the parsed query |
| **getSelect** | Return the **Select** of the parsed query |
| **getWhere** | Return the **Where** of the parsed query |
| **getOrderBy** | Return the **OrderBy** of the parsed query |
| | |
| **isWhere** | Return **true** or **false** if the data matches the **Where** statement |
| **renderTree** | Render the parsed query |
| | |
| 🔗 **setQuery** | Shortcut to set the query property |
| 🔗 **sort** | Sort the dataset |
| 🔗 **where** | Apply the **Where** query to the dataset |
| 🔗 **select** | Apply the **Select** query to the dataset |
| 🔗 **update** | Apply the updates to the dataset |
| | |
| **results** | Returns an array of results
| **table** | Returns a table of results
#### *You only need to initialize the SQLParse object once*
To change the current query simply set the value of the query property:
```js
object.query = "where new=true"
```
### Quick examples
```js
let parser = new SQLParse('where (name=/matthew/i and color = "Blue")');
```
**Single where (returns true):**
```js
parser.isWhere({name:"matthew", color="Blue"});
```
**Sort the DataSet**
```js
parser.sort([dataset]).results();
```
**Where the DataSet**
```js
parser.where([dataset]).results();
```
**Select the DataSet**
```js
parser.select([dataset]).results();
```
**Do it all**
```js
parser.sort([dataset]).where().select().results()
```
As you can see in the above query, you only need to set the dataset for the first function in the chain.
The chain is smart, for instance if there is no **Where** statement in your query, your chain processes will skip over that part.
**Update the DataSet (3 examples)**
```js
parser.query = "[query]";
parser.update({key: value}, [dataset]);
```
```js
parser.setQuery([query]).update({key: value}, [dataset]);
```
```js
parser.query = "[query]";
parser.sort([dataset]).update({key: value}).results();
```
- If the query is not specified the last query is used. Look at `test-update.js` for an example.
- The same rules for chained functions apply, the dataset to use only needs to be set in the first link in the chain.
## *Test Results*
- [Latest Query Test Results](test-query.txt)
- [Latest Update Test Results](test-update.txt)