Skip to content

Commit e19736c

Browse files
taozhi8833998taozhi8833998
committed
update readme
1 parent a075eff commit e19736c

1 file changed

Lines changed: 12 additions & 12 deletions

File tree

‎README.md‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
[![npm version](https://badge.fury.io/js/node-sql-parser.svg)](https://badge.fury.io/js/node-sql-parser)
88
[![NPM downloads](http://img.shields.io/npm/dm/node-sql-parser.svg?style=flat-square)](http://www.npmtrends.com/node-sql-parser)
99
[![Coverage Status](https://img.shields.io/coveralls/github/taozhi8833998/node-sql-parser/master.svg)](https://coveralls.io/github/taozhi8833998/node-sql-parser?branch=master)
10-
![](https://img.shields.io/gitter/room/taozhi8833998/node-sql-parser.svg)
10+
[![](https://img.shields.io/gitter/room/taozhi8833998/node-sql-parser.svg)](https://gitter.im/node-sql-parser/community)
1111
[![Dependencies](https://img.shields.io/david/taozhi8833998/node-sql-parser.svg)](https://img.shields.io/david/taozhi8833998/node-sql-parser)
1212
[![Known Vulnerabilities](https://snyk.io/test/github/taozhi8833998/node-sql-parser/badge.svg?targetFile=package.json)](https://snyk.io/test/github/taozhi8833998/node-sql-parser?targetFile=package.json)
1313
[![issues](https://img.shields.io/github/issues/taozhi8833998/node-sql-parser.svg)](https://github.com/taozhi8833998/node-sql-parser/issues)
@@ -16,9 +16,9 @@
1616

1717
## :star: Features
1818

19-
- support multiple sql statement seperate by semicolon
20-
- support select, delete, update and insert type
21-
- output the table and column list that the sql visited with the corresponding authority
19+
- support multiple sql statement seperate by semicolon
20+
- support select, delete, update and insert type
21+
- output the table and column list that the sql visited with the corresponding authority
2222

2323
## :tada: Install
2424

@@ -40,8 +40,8 @@ console.log(ast);
4040

4141
### Get the SQL visited tables
4242

43-
- get the table list that the sql visited
44-
- the format is **{type}::{dbName}::{tableName}** // type could be select, update, delete or insert
43+
- get the table list that the sql visited
44+
- the format is **{type}::{dbName}::{tableName}** // type could be select, update, delete or insert
4545

4646
```javascript
4747
const { Parser } = require('node-sql-parser');
@@ -53,9 +53,9 @@ console.log(tableList); // ["select::null::t"]
5353

5454
### Get the SQL visited columns
5555

56-
- get the column list that the sql visited
57-
- the format is **{type}::{tableName}::{columnName}** // type could be select, update, delete or insert
58-
- for `select *`, `delete` and `insert into tableName values()` without specified columns, the `.*` column authority regex is required
56+
- get the column list that the sql visited
57+
- the format is **{type}::{tableName}::{columnName}** // type could be select, update, delete or insert
58+
- for `select *`, `delete` and `insert into tableName values()` without specified columns, the `.*` column authority regex is required
5959

6060
```javascript
6161
const { Parser } = require('node-sql-parser');
@@ -67,8 +67,8 @@ console.log(columnList); // ["select::t::id"]
6767

6868
### Check the SQL with Authority List
6969

70-
- check table authority
71-
- `whiteListCheck` function check on `table` mode by default
70+
- check table authority
71+
- `whiteListCheck` function check on `table` mode by default
7272

7373
```javascript
7474
const { Parser } = require('node-sql-parser');
@@ -78,7 +78,7 @@ const whiteTableList = ['(select|update)::(.*)::(a|b)'] // array that contain mu
7878
parser.whiteListCheck(sql, whiteTableList, 'table') // if check failed, an error would be thrown with relevant error message, if passed it would return undefined
7979
```
8080

81-
- check column authority
81+
- check column authority
8282

8383
```javascript
8484
const { Parser } = require('node-sql-parser');

0 commit comments

Comments
 (0)