pg plpgsql query native

.gitignore

@@ -1,3 +1,6 @@
 node_modules/
 build/
+libs/
 npm-debug.log
+libpg_query/**/*.a
+libpg_query/**/*.h

.travis.yml

@@ -1,8 +1,6 @@
 language: node_js
 node_js:
-  - "0.12"
-  - "4"
-  - "5"
+  - "8"
 addons:
   apt:
     sources:

CHANGELOG.md

@@ -1,3 +1,17 @@
+# 1.2.1
+* Rename package
+
+# 1.2.0
+* Add TS typings
+
+# 1.1.2 (07/23/19)
+* Fix build script
+
+# 1.1.0 (Republish, 07/23/19)
+* Rewrite to use Node-Addons-API (C++ wrapper for the stable N-API)
+* Support PL/PGSql Parsing
+* Support async parsing
+
 ## 0.0.5 (November 19, 2015)
 * Update libpg_query to include latest A_CONST fixes
 

README.md

@@ -1,45 +1,42 @@
-# pg-query-native [![Build Status](https://travis-ci.org/zhm/node-pg-query-native.svg?branch=master)](https://travis-ci.org/zhm/node-pg-query-native)
+# @sqlutils/parse
 
-The real PostgreSQL parser for nodejs.
+The real PostgreSQL parser, exposed for nodejs.
 
 This is based on the output of [libpg_query](https://github.com/lfittl/libpg_query). This wraps the static library output and links it into a node module for use in js.
 
 All credit for the hard problems goes to [Lukas Fittl](https://github.com/lfittl).
 
+## Requirements
+
+Install node-gyp globally
+
+```sh
+npm install node-gyp -g
+```
+
 ## Installation
 
 ```sh
-npm install pg-query-native-latest
+npm install @sqlutils/parse
 ```
 
 ### Documentation
 
-### `query.parse(query)`
+### `query.parseQuery(sql)`/`parseQuerySync`
 
-Parses the query and returns the parse tree.
+Parses the sql and returns a Promise for the parse tree (or returns the parse tree directly in the sync version). May reject with/throw a parse error.
 
-### Parameters
+The return value is an array, as multiple queries may be provided in a single string (semicolon-delimited, as Postgres expects).
 
-| parameter            | type               | description                                               |
-| -------------------- | ------------------ | --------------------------------------------------------- |
-| `query`              | String             | SQL query                                                 |
+### `query.parsePlPgSQL(funcsSql)`/`query.parsePlPgSQLSync(funcsSql)`
 
-Returns an object in the format:
-
-```
-{ query: <query|Object>,
-  error: { message: <message|String>,
-           fileName: <fileName|String>,
-           lineNumber: <line|Number>,
-           cursorPosition: <cursor|Number> }
-```
+Parses the contents of a PL/PGSql function, from a `CREATE FUNCTION` declaration, and returns a Promise for the parse tree (or returns the parse tree directly in the sync version). May reject with/throw a parse error.
 
 ## Example
 
 ```js
-var parse = require('pg-query-native').parse;
-
-console.log(parse('select 1').query);
+const parser = require('@sqlutils/parse');
+parser.parseQuery('select 1').then(console.log);
 ```
 
 ## Related

binding.gyp

@@ -1,21 +1,40 @@
 {
   "targets": [
     {
-      "target_name": "pg-query",
-      "sources": [ "pg-query.cc", "functions.cc" ],
-      "include_dirs" : [
- 	 			"<!(node -e \"require('nan')\")",
-        "libpg_query/include"
-			],
+      "target_name": "queryparser",
+      "sources": [
+        "src/addon.cc",
+        "src/helpers.cc",
+        "src/sync.cc",
+        "src/async.cc"
+      ],
+      'cflags!': [ '-fno-exceptions' ],
+      'cflags_cc!': [ '-fno-exceptions' ],
+      'include_dirs': [
+        "libpg_query/include",
+        "<!@(node -p \"require('node-addon-api').include\")"
+      ],
+      'dependencies': ["<!(node -p \"require('node-addon-api').gyp\")"],
       'conditions': [
         ['OS=="linux"', {
-            "libraries": [ "-L<!(pwd)/libpg_query/linux", "-lpg_query" ]
-        } ],
+          "libraries": [ "-L<!(pwd)/libpg_query/linux", "-lpg_query" ]
+        }],
         ['OS=="mac"', {
-          "libraries": [ "-L<!(pwd)/libpg_query/osx", "-lpg_query" ]
-        } ],
-        ['OS=="win"', { }]
+          "libraries": [ "-L<!(pwd)/libpg_query/osx", "-lpg_query" ],
+          "xcode_settings": {
+            "CLANG_CXX_LIBRARY": "libc++",
+            'GCC_ENABLE_CPP_EXCEPTIONS': 'YES',
+            'MACOSX_DEPLOYMENT_TARGET': '10.7'
+          }
+        }],
+        ['OS=="win"', {
+          "msvs_settings": {
+            "VCCLCompilerTool": {
+              "ExceptionHandling": 1
+            }
+          }
+        }]
       ]
     }
-  ],
+  ]
 }

docker-compose.yml

@@ -0,0 +1,7 @@
+version: '2'
+services:
+    pg_query:
+        build: ./docker
+        image: pyramation/libpg_query
+        volumes:
+          - ./libpg_query:/pg_query

docker/Dockerfile

@@ -0,0 +1,8 @@
+FROM node:12.18.2-alpine3.11
+RUN apk --no-cache add git
+RUN apk add --no-cache bash
+RUN apk add --no-cache make
+RUN apk add --update alpine-sdk
+RUN apk --no-cache add python
+
+ENTRYPOINT ["/bin/bash"]

docker/readme.md

@@ -0,0 +1,77 @@
+# 0 build on mac first
+
+build the binary on mac 
+
+# 1 build the docker image
+
+run `docker-compose build`
+
+# 2 start the server
+
+```sh
+docker run -d \
+  -it \
+  --name build_pg_query \
+  --mount type=bind,source="$(pwd)"/libpg_query,target=/pg_query \
+  pyramation/libpg_query
+```
+
+# 3 jump inside
+
+`ssh` into the box
+
+```sh
+docker exec -it build_pg_query /bin/bash
+```
+
+# publishing from inside 
+
+```sh
+mkdir git
+cd git
+git clone https://github.com/pyramation/pg-plpgsql-query-native
+cd pg-plpgsql-query-native/
+yarn
+
+# get the OSX version you build before...
+cp /pg_query/osx/libpg_query.a ./libpg_query/osx/
+
+# add your creds real quick... (look in your ~/.npmrc)
+vi .npmrc
+vi package.json
+npm publish
+```
+
+# building libpg_query
+
+not necessary, but for fun:
+
+```sh
+mkdir git
+cd git/
+git clone git clone [email protected]:lfittl/libpg_query.git
+git clone [email protected]:lfittl/libpg_query.git
+git clone https://github.com/lfittl/libpg_query.git
+cd libpg_query/
+make
+cp libpg_query.a /pg_query/linux/
+```
+
+you should see `.a` files now :)
+
+```
+libpg_query/
+libpg_query//osx
+libpg_query//osx/libpg_query.a
+libpg_query//osx/.gitkeep
+libpg_query//include
+libpg_query//include/.gitkeep
+libpg_query//include/pg_query.h
+libpg_query//linux
+libpg_query//linux/libpg_query.a
+libpg_query//linux/.gitkeep
+libpg_query//windows
+libpg_query//windows/.gitkeep
+```
+
+make sure you grab the `pg_query.h` if you don't have it ;)

index.d.ts

@@ -0,0 +1,4 @@
+export function parseQuery(sql: string): Promise<any>;
+export function parsePlPgSQL(funcsSql: string): Promise<any>;
+export function parseQuerySync(sql: string): any;
+export function parsePlPgSQLSync(funcsSql: string): any;

index.js

@@ -1,25 +1,27 @@
-var PgQuery = require('bindings')('pg-query');
+const PgQuery = require('./build/Release/queryparser');
 
 module.exports = {
-  parse: function(query) {
-    var result = PgQuery.parse(query);
+  parseQuery(query) {
+    return new Promise((resolve, reject) => {
+      PgQuery.parseQueryAsync(query, (err, result) => {
+        err ? reject(err) : resolve(JSON.parse(result));
+      });
+    });
+  },
 
-    if (result.query) {
-      result.query = JSON.parse(result.query);
-    }
+  parsePlPgSQL(query) {
+    return new Promise((resolve, reject) => {
+      PgQuery.parsePlPgSQLAsync(query, (err, result) => {
+        err ? reject(err) : resolve(JSON.parse(result));
+      });
+    });
+  },
 
-    if (result.error) {
-      var err = new Error(result.error.message);
+  parseQuerySync(query) {
+    return JSON.parse(PgQuery.parseQuerySync(query));
+  },
 
-      err.fileName = result.error.fileName;
-      err.lineNumber = result.error.lineNumber;
-      err.cursorPosition = result.error.cursorPosition;
-      err.functionName = result.error.functionName;
-      err.context = result.error.context;
-
-      result.error = err;
-    }
-
-    return result;
+  parsePlPgSQLSync(query) {
+    return JSON.parse(PgQuery.parsePlPgSQLSync(query));
   }
 };