Skip to content

Commit 61b9b7c

Browse files
committed
Add javascript target README.md
1 parent bad4811 commit 61b9b7c

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

cratedb_sqlparse_js/README.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Cratedb sqlparse - javascript edition.
2+
3+
![NPM License](https://img.shields.io/npm/l/cratedb-sqlparse?style=for-the-badge)
4+
![NPM Version](https://img.shields.io/npm/v/cratedb-sqlparse?style=for-the-badge)
5+
![NPM Unpacked Size](https://img.shields.io/npm/unpacked-size/cratedb-sqlparse?style=for-the-badge)
6+
![NPM Type Definitions](https://img.shields.io/npm/types/cratedb-sqlparse?style=for-the-badge)
7+
8+
CrateDB sqlparser for javascript, compiled from antlr4 Javascript compile target.
9+
10+
### Simple usage
11+
```javascript
12+
import { sqlparse } from cratedb-sqlparse;
13+
14+
const query = `
15+
SELECT * FROM SYS.SHARDS;
16+
INSERT INTO doc.tbl1 VALUES ('metric', 1238123, 'true');
17+
`
18+
const queries = sqlparse(query);
19+
20+
console.log(queries.length)
21+
// 2
22+
23+
console.log(queries[0].query)
24+
// SELECT * FROM SYS.SHARDS
25+
26+
console.log(queries[0].type)
27+
// SELECT
28+
29+
console.log(queries[0].original_query)
30+
// SELECT * FROM SYS.SHARDS;
31+
// INSERT INTO doc.tbl1 VALUES ('metric', 1238123, 'true');
32+
```
33+
### Features
34+
Currently, we support the same features as CrateDB java's parser:
35+
- First class CrateDB sql dialect support.
36+
- Input is case-insensitive.
37+
- Native errors as exceptions.
38+
- Dollar strings.
39+
40+
Optional features:
41+
42+
### Errors
43+
Errors are thrown as 'ParseError' e.g:
44+
```javascript
45+
ParseError: line2:9 mismatched input 'ROM' expecting {<EOF>, ';'}
46+
```

0 commit comments

Comments
 (0)