support multiple database

Author: taozhi8833998

.gitignore

@@ -2,6 +2,5 @@ node_modules/
 build/
 coverage/
 lib/
-index.d.ts
 .nyc_output/
 .coveralls.yml

README.md

@@ -36,7 +36,7 @@ or
 yarn add node-sql-parser
 ```
 
-**Install the following type module for typescript usage**
+**(Deprecated)Install the following type module for typescript usage**
 
 ```bash
 npm install @types/node-sql-parser --save-dev
@@ -85,20 +85,28 @@ console.log(ast);
 ### Convert AST back to SQL
 
 ```javascript
+const opt = {
+  database: 'MySQL' // MySQL is the default database
+}
 const { Parser } = require('node-sql-parser');
 const parser = new Parser()
-const ast = parser.astify('SELECT * FROM t');
-const sql = parse.sqlify(ast);
+// opt is optional
+const ast = parser.astify('SELECT * FROM t', opt);
+const sql = parse.sqlify(ast, opt);
 
 console.log(sql); // SELECT * FROM `t`
 ```
 
 ### Get TableList, ColumnList, Ast by `parse` function
 
 ```javascript
+const opt = {
+  database: 'MariaDB' // MySQL is the default database
+}
 const { Parser } = require('node-sql-parser');
 const parser = new Parser()
-const { tableList, columnList, ast } = parser.parse('SELECT * FROM t');
+// opt is optional
+const { tableList, columnList, ast } = parser.parse('SELECT * FROM t', opt);
 ```
 
 ### Get the SQL visited tables
@@ -107,9 +115,13 @@ const { tableList, columnList, ast } = parser.parse('SELECT * FROM t');
 -  the format is **{type}::{dbName}::{tableName}** // type could be select, update, delete or insert
 
 ```javascript
+const opt = {
+  database: 'MySQL'
+}
 const { Parser } = require('node-sql-parser');
 const parser = new Parser();
-const tableList = parser.tableList('SELECT * FROM t');
+// opt is optional
+const tableList = parser.tableList('SELECT * FROM t', opt);
 
 console.log(tableList); // ["select::null::t"]
 ```
@@ -121,24 +133,33 @@ console.log(tableList); // ["select::null::t"]
 - for `select *`, `delete` and `insert into tableName values()` without specified columns, the `.*` column authority regex is required
 
 ```javascript
+const opt = {
+  database: 'MySQL'
+}
 const { Parser } = require('node-sql-parser');
 const parser = new Parser();
-const columnList = parser.columnList('SELECT t.id FROM t');
+// opt is optional
+const columnList = parser.columnList('SELECT t.id FROM t', opt);
 
 console.log(columnList); // ["select::t::id"]
 ```
 
 ### Check the SQL with Authority List
 
 - check table authority
-- `whiteListCheck` function check on `table` mode by default
+- `whiteListCheck` function check on `table` mode and `MySQL` database by default
 
 ```javascript
 const { Parser } = require('node-sql-parser');
 const parser = new Parser();
 const sql = 'UPDATE a SET id = 1 WHERE name IN (SELECT name FROM b)'
 const whiteTableList = ['(select|update)::(.*)::(a|b)'] // array that contain multiple authorities
-parser.whiteListCheck(sql, whiteTableList, 'table') // if check failed, an error would be thrown with relevant error message, if passed it would return undefined
+const opt = {
+  database: 'MySQL',
+  type: 'table',
+}
+// opt is optional
+parser.whiteListCheck(sql, whiteTableList, opt) // if check failed, an error would be thrown with relevant error message, if passed it would return undefined
 ```
 
 - check column authority
@@ -148,7 +169,12 @@ const { Parser } = require('node-sql-parser');
 const parser = new Parser();
 const sql = 'UPDATE a SET id = 1 WHERE name IN (SELECT name FROM b)'
 const whiteColumnList = ['select::null::name', 'update::a::id'] // array that contain multiple authorities
-parser.whiteListCheck(sql, whiteColumnList, 'column') // if check failed, an error would be thrown with relevant error message, if passed it would return undefined
+const opt = {
+  database: 'MySQL',
+  type: 'column',
+}
+// opt is optional
+parser.whiteListCheck(sql, whiteColumnList, opt) // if check failed, an error would be thrown with relevant error message, if passed it would return undefined
 ```
 
 ## :kissing_heart: Acknowledgement

build.js

@@ -0,0 +1,18 @@
+const fs = require('fs')
+const path = require('path')
+const peg = require('pegjs')
+
+const parserFolder = path.join(__dirname, 'pegjs')
+const PARSER_FILE = /(.*)\.pegjs$/
+
+fs.readdirSync(parserFolder)
+  .filter(file => PARSER_FILE.test(file))
+  .forEach(file => {
+    const [, name] = file.match(PARSER_FILE)
+    const source = fs.readFileSync(path.join(parserFolder, file), 'utf8')
+    const parser = peg.generate(source, {
+      format: 'commonjs',
+      output: 'source',
+    })
+    fs.writeFileSync(path.join(__dirname, `build/${name}.js`), parser)
+  })

index.d.ts

@@ -0,0 +1,108 @@
+// Type definitions for node-sql-parser 1.0
+// Project: https://github.com/taozhi8833998/node-sql-parser#readme
+// Definitions by: taozhi8833998 <https://github.com/taozhi8833998>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+// TypeScript Version: 2.4
+
+export interface With {
+  name: string;
+  stmt: any[];
+  columns?: any[];
+}
+export type WhilteListCheckMode = 'table' | 'column';
+export interface Option {
+  database?: string,
+  type?: string,
+}
+export interface TableColumnAst {
+  tableList: string[];
+  columnsList: string[];
+  ast: AST[] | AST;
+}
+export interface From {
+  db: string | null;
+  table: string;
+  as: string | null;
+}
+export interface Dual {
+  type: 'dual';
+}
+export interface Limit {
+  type: string;
+  value: number;
+}
+export interface OrderBy {
+  type: 'ASC' | 'DESC';
+  expr: any;
+}
+export interface ColumnRef {
+  type: 'column_ref';
+  table: string | null;
+  column: string;
+}
+export interface SetList {
+  column: string;
+  value: any;
+  table: string | null;
+}
+export interface InsertReplaceValue {
+  type: 'expr_list';
+  value: any[];
+}
+export interface Select {
+  with: With | null;
+  type: 'select';
+  options: any[] | null;
+  distinct: 'DISTINCT' | null;
+  columns: any[] | '*';
+  from: Array<From | Dual> | null;
+  where: any;
+  groupby: ColumnRef[] | null;
+  having: any[] | null;
+  orderby: OrderBy[] | null;
+  limit: Limit[] | null;
+}
+export interface Insert_Replace {
+  type: 'replace' | 'insert';
+  db: string | null;
+  table: string;
+  columns: string[] | null;
+  values: InsertReplaceValue[];
+}
+export interface Update {
+  type: 'udpate';
+  db: string | null;
+  table: string;
+  set: SetList[];
+  where: any;
+}
+export interface Delete {
+  type: 'delete';
+  tables: any;
+  from: Array<From | Dual>;
+  where: any;
+}
+
+export interface Alter {
+  type: 'alter',
+  table: From,
+  expr: any
+}
+
+export type AST = Select | Insert_Replace | Update | Delete | Alter;
+
+export class Parser {
+  constructor();
+
+  parse(sql: string, opt?: Option): TableColumnAst;
+
+  astify(sql: string, opt?: Option): AST[] | AST;
+
+  sqlify(ast: AST[] | AST, opt?: Option): string;
+
+  whiteListCheck(sql: string, whiteList: string[], opt?: Option): Error | undefined;
+
+  tableList(sql: string, opt?: Option): string[];
+
+  columnList(sql: string, opt?: Option): string[];
+}

package.json

@@ -1,15 +1,16 @@
 {
   "name": "node-sql-parser",
-  "version": "1.5.2",
+  "version": "1.6.0",
   "description": "simple node sql parser",
   "main": "index.js",
   "types": "index.d.ts",
   "scripts": {
-    "build": "mkdir -p build && pegjs -o build/pegjs-parser.js sql.pegjs && npm run compile",
-    "test": "NODE_ENV=test npm run lint && mocha --require @babel/register",
+    "build": "mkdir -p build && node build.js && npm run compile",
+    "test": "NODE_ENV=test npm run lint && mocha --recursive --require @babel/register",
     "compile": "babel src -d lib",
     "lint": "npm run build && eslint src/",
     "prepublishOnly": "npm run build",
+    "coverLocal": "nyc npm run test",
     "cover": "nyc npm run test && nyc report --reporter=text-lcov | coveralls"
   },
   "repository": {
@@ -27,7 +28,8 @@
   "files": [
     "index.js",
     "lib/",
-    "build/pegjs-parser.js",
+    "index.d.ts",
+    "build/*.js",
     "README.md",
     "LICENSE"
   ],