@sqb/postgres 4.2.1 → 4.5.0

package/README.md

@@ -0,0 +1,67 @@
+
+<p style="text-align:center">
+  <img src="https://user-images.githubusercontent.com/3836517/32965280-1a2b63ce-cbe7-11e7-8ee1-ba47313503c5.png" width="500px" alt="SQB Logo"/>
+</p>
+
+<br>
+  
+[![NPM Version][npm-image]][npm-url]
+[![NPM Downloads][downloads-image]][downloads-url]
+[![Build Status][travis-image]][travis-url]
+[![Test Coverage][coveralls-image]][coveralls-url]
+[![Dependencies][dependencies-image]][dependencies-url]
+[![DevDependencies][devdependencies-image]][devdependencies-url]
+[![Package Quality][quality-image]][quality-url]
+
+
+## About SQB
+
+SQB is an extensible, multi-dialect SQL query builder and Database connection wrapper for NodeJS.
+
+## Main goals
+
+- Single code base for any sql based database
+- Powerful and simplified query coding scheme
+- Fast applications with low memory requirements
+- Let applications work with large data tables efficiently
+- Support latest JavaScript language standards
+- Lightweight and extensible framework. 
+
+
+You can report bugs and discuss features on the [GitHub issues](https://github.com/sqbjs/sqb/issues) page
+
+Thanks to all of the great [contributions](https://github.com/sqbjs/sqb/graphs/contributors) to the project.
+
+You may want to check detailed [DOCUMENTATION](https://sqbjs.github.io/sqb/)
+
+
+## Installation
+
+```bash
+$ npm install @sqb/postgres --save
+```
+
+## Node Compatibility
+
+  - node >= 16.x
+  
+   
+### License
+SQB is available under [MIT](LICENSE) license.
+
+[npm-image]: https://img.shields.io/npm/v/@sqb/postgres.svg
+[npm-url]: https://npmjs.org/package/@sqb/postgres
+[travis-image]: https://img.shields.io/travis/sqbjs/@sqb/postgres/master.svg
+[travis-url]: https://travis-ci.org/sqbjs/@sqb/postgres
+[coveralls-image]: https://img.shields.io/coveralls/sqbjs/@sqb/postgres/master.svg
+[coveralls-url]: https://coveralls.io/r/sqbjs/@sqb/postgres
+[downloads-image]: https://img.shields.io/npm/dm/@sqb/postgres.svg
+[downloads-url]: https://npmjs.org/package/@sqb/postgres
+[gitter-image]: https://badges.gitter.im/sqbjs/@sqb/postgres.svg
+[gitter-url]: https://gitter.im/sqbjs/@sqb/postgres?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
+[dependencies-image]: https://david-dm.org/sqbjs/@sqb/postgres/status.svg
+[dependencies-url]:https://david-dm.org/sqbjs/@sqb/postgres
+[devdependencies-image]: https://david-dm.org/sqbjs/@sqb/postgres/dev-status.svg
+[devdependencies-url]:https://david-dm.org/sqbjs/@sqb/postgres?type=dev
+[quality-image]: http://npm.packagequality.com/shield/@sqb/postgres.png
+[quality-url]: http://packagequality.com/#?package=@sqb/postgres

package/{dist → cjs}/index.js

@@ -2,5 +2,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 require("@sqb/postgres-dialect");
 const connect_1 = require("@sqb/connect");
-const PgAdapter_1 = require("./PgAdapter");
-(0, connect_1.registerAdapter)(new PgAdapter_1.PgAdapter());
+const pg_adapter_js_1 = require("./pg-adapter.js");
+(0, connect_1.registerAdapter)(new pg_adapter_js_1.PgAdapter());

package/cjs/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/{dist/PgAdapter.js → cjs/pg-adapter.js}

@@ -4,17 +4,15 @@ exports.PgAdapter = void 0;
 require("@sqb/postgres-dialect");
 const postgresql_client_1 = require("postgresql-client");
 const connect_1 = require("@sqb/connect");
-const PgConnection_1 = require("./PgConnection");
+const pg_connection_js_1 = require("./pg-connection.js");
 class PgAdapter {
-    constructor() {
-        this.driver = 'postgresql-client';
-        this.dialect = 'postgres';
-        this.features = {
-            cursor: true,
-            schema: true,
-            fetchAsString: [connect_1.DataType.DATE, connect_1.DataType.TIMESTAMP, connect_1.DataType.TIMESTAMPTZ]
-        };
-    }
+    driver = 'postgresql-client';
+    dialect = 'postgres';
+    features = {
+        cursor: true,
+        schema: true,
+        fetchAsString: [connect_1.DataType.DATE, connect_1.DataType.TIMESTAMP, connect_1.DataType.TIMESTAMPTZ]
+    };
     async connect(config) {
         const cfg = { ...config.driverOptions };
         if (config.user)
@@ -32,7 +30,7 @@ class PgAdapter {
         const connection = new postgresql_client_1.Connection(cfg);
         try {
             await connection.connect();
-            return new PgConnection_1.PgConnection(connection);
+            return new pg_connection_js_1.PgConnection(connection);
         }
         catch (e) {
             await connection.close(0);

package/{dist/PgConnection.js → cjs/pg-connection.js}

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.PgConnection = void 0;
 const postgresql_client_1 = require("postgresql-client");
 const connect_1 = require("@sqb/connect");
-const datatype_map_1 = require("./datatype-map");
+const datatype_map_js_1 = require("./datatype-map.js");
 const SqbDataTypToOIDMap = {
     [connect_1.DataType.BOOL]: postgresql_client_1.DataTypeOIDs.bool,
     [connect_1.DataType.CHAR]: postgresql_client_1.DataTypeOIDs.char,
@@ -23,6 +23,7 @@ const SqbDataTypToOIDMap = {
     [connect_1.DataType.GUID]: postgresql_client_1.DataTypeOIDs.uuid,
 };
 class PgConnection {
+    intlcon;
     constructor(conn) {
         this.intlcon = conn;
     }
@@ -101,7 +102,7 @@ class PgConnection {
         const params = query.params?.map((v, i) => {
             const paramOpts = Array.isArray(query.paramOptions) ? query.paramOptions[i] : undefined;
             if (v != null && paramOpts && paramOpts.dataType) {
-                const oid = (0, datatype_map_1.dataTypeToOID)(paramOpts.dataType, paramOpts.isArray);
+                const oid = (0, datatype_map_js_1.dataTypeToOID)(paramOpts.dataType, paramOpts.isArray);
                 if (oid)
                     return new postgresql_client_1.BindParam(oid, v);
             }

package/esm/datatype-map.js

@@ -0,0 +1,28 @@
+import { DataTypeOIDs } from 'postgresql-client';
+import { DataType } from '@sqb/builder';
+export function dataTypeToOID(dataType, isArray) {
+    if (dataType === DataType.DATE)
+        return isArray ? DataTypeOIDs._date : DataTypeOIDs.date;
+    if (dataType === DataType.BOOL)
+        return isArray ? DataTypeOIDs._bool : DataTypeOIDs.bool;
+    if (dataType === DataType.CHAR)
+        return isArray ? DataTypeOIDs._bpchar : DataTypeOIDs.bpchar;
+    if (dataType === DataType.SMALLINT)
+        return isArray ? DataTypeOIDs._int2 : DataTypeOIDs.int2;
+    if (dataType === DataType.INTEGER)
+        return isArray ? DataTypeOIDs._int4 : DataTypeOIDs.int4;
+    if (dataType === DataType.BIGINT)
+        return isArray ? DataTypeOIDs._int8 : DataTypeOIDs.int8;
+    if (dataType === DataType.BINARY)
+        return isArray ? DataTypeOIDs._bytea : DataTypeOIDs.bytea;
+    if (dataType === DataType.FLOAT)
+        return isArray ? DataTypeOIDs._float4 : DataTypeOIDs.float4;
+    if (dataType === DataType.DOUBLE)
+        return isArray ? DataTypeOIDs._float8 : DataTypeOIDs.float8;
+    if (dataType === DataType.GUID)
+        return isArray ? DataTypeOIDs._uuid : DataTypeOIDs.uuid;
+    if (dataType === DataType.TEXT)
+        return isArray ? DataTypeOIDs._text : DataTypeOIDs.text;
+    if (dataType === DataType.JSON)
+        return isArray ? DataTypeOIDs._json : DataTypeOIDs.json;
+}

package/esm/index.js

@@ -0,0 +1,4 @@
+import '@sqb/postgres-dialect';
+import { registerAdapter } from '@sqb/connect';
+import { PgAdapter } from './pg-adapter.js';
+registerAdapter(new PgAdapter());

package/esm/pg-adapter.js

@@ -0,0 +1,37 @@
+import '@sqb/postgres-dialect';
+import { Connection } from 'postgresql-client';
+import { DataType } from '@sqb/connect';
+import { PgConnection } from './pg-connection.js';
+export class PgAdapter {
+    driver = 'postgresql-client';
+    dialect = 'postgres';
+    features = {
+        cursor: true,
+        schema: true,
+        fetchAsString: [DataType.DATE, DataType.TIMESTAMP, DataType.TIMESTAMPTZ]
+    };
+    async connect(config) {
+        const cfg = { ...config.driverOptions };
+        if (config.user)
+            cfg.user = config.user;
+        if (config.password)
+            cfg.password = config.password;
+        if (config.host)
+            cfg.host = config.host;
+        if (config.port)
+            cfg.port = config.port;
+        if (config.database)
+            cfg.database = config.database;
+        if (config.schema)
+            cfg.schema = config.schema;
+        const connection = new Connection(cfg);
+        try {
+            await connection.connect();
+            return new PgConnection(connection);
+        }
+        catch (e) {
+            await connection.close(0);
+            throw e;
+        }
+    }
+}

package/esm/pg-connection.js

@@ -0,0 +1,155 @@
+import { BindParam, DataTypeOIDs } from 'postgresql-client';
+import { DataType } from '@sqb/connect';
+import { dataTypeToOID } from './datatype-map.js';
+const SqbDataTypToOIDMap = {
+    [DataType.BOOL]: DataTypeOIDs.bool,
+    [DataType.CHAR]: DataTypeOIDs.char,
+    [DataType.VARCHAR]: DataTypeOIDs.varchar,
+    [DataType.SMALLINT]: DataTypeOIDs.int2,
+    [DataType.INTEGER]: DataTypeOIDs.int4,
+    [DataType.BIGINT]: DataTypeOIDs.int8,
+    [DataType.FLOAT]: DataTypeOIDs.float4,
+    [DataType.DOUBLE]: DataTypeOIDs.float8,
+    [DataType.NUMBER]: DataTypeOIDs.float8,
+    [DataType.DATE]: DataTypeOIDs.date,
+    [DataType.TIMESTAMP]: DataTypeOIDs.timestamp,
+    [DataType.TIMESTAMPTZ]: DataTypeOIDs.timestamptz,
+    [DataType.TIME]: DataTypeOIDs.time,
+    [DataType.BINARY]: DataTypeOIDs.bytea,
+    [DataType.TEXT]: DataTypeOIDs.text,
+    [DataType.GUID]: DataTypeOIDs.uuid,
+};
+export class PgConnection {
+    intlcon;
+    constructor(conn) {
+        this.intlcon = conn;
+    }
+    get sessionId() {
+        return this.intlcon && this.intlcon.processID;
+    }
+    async close() {
+        if (!this.intlcon)
+            return;
+        await this.intlcon.close(0);
+        this.intlcon = undefined;
+    }
+    async reset() {
+        return this.rollback();
+    }
+    async startTransaction() {
+        if (!this.intlcon)
+            throw new Error('Can not start transaction for a closed db session');
+        await this.intlcon.startTransaction();
+    }
+    async commit() {
+        if (!this.intlcon)
+            throw new Error('Can not commit transaction for a closed db session');
+        await this.intlcon.commit();
+    }
+    async rollback() {
+        if (!this.intlcon)
+            return;
+        await this.intlcon.rollback();
+    }
+    async setSavepoint(savepoint) {
+        if (!this.intlcon)
+            throw new Error('Can not set savepoint for a closed db session');
+        return this.intlcon.savepoint(savepoint);
+    }
+    async releaseSavepoint(savepoint) {
+        if (!this.intlcon)
+            throw new Error('Can not release savepoint for a closed db session');
+        return this.intlcon.releaseSavepoint(savepoint);
+    }
+    async rollbackSavepoint(savepoint) {
+        if (!this.intlcon)
+            throw new Error('Can not rollback to a savepoint for a closed db session');
+        return this.intlcon.rollbackToSavepoint(savepoint);
+    }
+    getInTransaction() {
+        return !!(this.intlcon && this.intlcon.inTransaction);
+    }
+    async test() {
+        if (!this.intlcon)
+            throw new Error('DB session is closed');
+        await this.intlcon.query('select 1');
+    }
+    async getSchema() {
+        if (!this.intlcon)
+            throw new Error('DB session is closed');
+        const r = await this.intlcon.query('SHOW search_path');
+        if (r && r.rows && r.rows[0])
+            return r.rows[0][0];
+        return '';
+    }
+    async setSchema(schema) {
+        if (!this.intlcon)
+            throw new Error('Can not set schema of a closed db session');
+        await this.intlcon.execute('SET search_path TO ' + schema);
+    }
+    onGenerateQuery(request) {
+        if (this.intlcon) {
+            // eslint-disable-next-line dot-notation
+            request.dialectVersion = this.intlcon.sessionParameters['server_version'];
+        }
+    }
+    async execute(query) {
+        if (!this.intlcon)
+            throw new Error('Can not execute query with a closed db session');
+        const params = query.params?.map((v, i) => {
+            const paramOpts = Array.isArray(query.paramOptions) ? query.paramOptions[i] : undefined;
+            if (v != null && paramOpts && paramOpts.dataType) {
+                const oid = dataTypeToOID(paramOpts.dataType, paramOpts.isArray);
+                if (oid)
+                    return new BindParam(oid, v);
+            }
+            return v;
+        });
+        const opts = {
+            autoCommit: query.autoCommit,
+            params,
+            cursor: query.cursor,
+            fetchCount: query.fetchRows,
+            objectRows: query.objectRows
+        };
+        if (query.fetchAsString) {
+            const items = query.fetchAsString.reduce((a, v) => {
+                const oid = SqbDataTypToOIDMap[v];
+                if (oid)
+                    a.push(oid);
+                return a;
+            }, []);
+            if (items.length)
+                opts.fetchAsString = items;
+        }
+        const resp = await this.intlcon.query(query.sql, opts);
+        const out = {};
+        if (resp.fields)
+            out.fields = this._convertFields(resp.fields);
+        if (resp.rows)
+            out.rows = resp.rows;
+        if (resp.cursor)
+            out.cursor = resp.cursor;
+        if (resp.rowType)
+            out.rowType = resp.rowType;
+        if (resp.rowsAffected)
+            out.rowsAffected = resp.rowsAffected;
+        return out;
+    }
+    _convertFields(fields) {
+        const result = [];
+        for (let i = 0; i < fields.length; i++) {
+            const v = fields[i];
+            const o = {
+                fieldName: v.fieldName,
+                dataType: v.dataTypeName,
+                elementDataType: v.elementDataTypeName,
+                jsType: v.jsType,
+                isArray: v.isArray,
+                _inf: v
+            };
+            result.push(o);
+        }
+        return result;
+    }
+}

package/package.json

@@ -1,63 +1,78 @@
 {
-  "name": "@sqb/postgres",
-  "description": "SQB serialization extension for PostgreSQL database",
-  "version": "4.2.1",
-  "author": "Panates",
-  "contributors": [
-    "Eray Hanoglu <e.hanoglu@panates.com>"
+  "name" : "@sqb/postgres",
+  "description" : "SQB serialization extension for PostgreSQL database",
+  "version" : "4.5.0",
+  "author" : "Panates",
+  "contributors" : [
+    "Eray Hanoglu <e.hanoglu@panates.com>",
+    "Ilker Gurelli <i.gurelli@panates.com>"
   ],
-  "license": "Apache-2.0",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/sqbjs/sqb.git",
-    "directory": "packages/postgres"
+  "license" : "Apache-2.0",
+  "repository" : {
+    "type" : "git",
+    "url" : "https://github.com/sqbjs/sqb.git",
+    "directory" : "packages/postgres"
   },
-  "keywords": [
-    "javascript",
-    "typescript",
-    "sql",
-    "query",
-    "builder",
-    "dialect",
-    "postgres",
-    "postgresql",
-    "pg",
-    "database"
-  ],
-  "dependencies": {
-    "putil-promisify": "^1.8.5"
+  "scripts" : {
+    "compile" : "tsc",
+    "prebuild" : "npm run lint && npm run clean",
+    "build" : "npm run build:cjs && npm run build:esm",
+    "build:cjs" : "tsc -b tsconfig-build-cjs.json",
+    "build:esm" : "tsc -b tsconfig-build-esm.json",
+    "postbuild" : "cp README.md package.json ../../LICENSE ../../build/postgres && cp ../../package.cjs.json ../../build/postgres/cjs/package.json",
+    "lint" : "eslint .",
+    "test" : "jest",
+    "cover" : "jest --collect-coverage",
+    "clean" : "npm run clean:src | npm run clean:dist | npm run clean:cover",
+    "clean:src" : "ts-cleanup -s src --all",
+    "clean:dist" : "rimraf ../../build/postgres",
+    "clean:cover" : "rimraf ../../coverage/postgres"
   },
-  "devDependencies": {
-    "postgresql-client": "^2.1.4"
+  "dependencies" : {
+    "putil-promisify" : "^1.8.5"
   },
-  "peerDependencies": {
-    "@sqb/builder": "^4.2.0",
-    "@sqb/connect": "^4.2.0",
-    "@sqb/postgres-dialect": "^4.2.0",
-    "postgresql-client": "^2.0.0"
+  "devDependencies" : {
+    "postgresql-client" : "^2.1.5"
   },
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "engines": {
-    "node": ">= 16.0"
+  "peerDependencies" : {
+    "@sqb/builder" : "^4.5.0",
+    "@sqb/connect" : "^4.5.0",
+    "@sqb/postgres-dialect" : "^4.5.0",
+    "postgresql-client" : "^2.x.x"
   },
-  "directories": {
-    "lib": "dist",
-    "test": "test"
+  "type" : "module",
+  "main" : "cjs/index.js",
+  "module" : "esm/index.js",
+  "types" : "esm/index.d.ts",
+  "exports" : {
+    "." : {
+      "require" : "./cjs/index.js",
+      "default" : "./esm/index.js"
+    },
+    "./cjs" : "./cjs/index.js",
+    "./esm" : "./esm/index.js"
   },
-  "files": [
+  "engines" : {
+    "node" : ">=16.0",
+    "npm" : ">=7.0.0"
+  },
+  "files" : [
+    "bin/",
+    "cjs/",
+    "esm/",
     "LICENSE",
-    "README",
-    "dist/"
+    "README.md"
   ],
-  "scripts": {
-    "build": "tsc -b tsconfig-build.json",
-    "prebuild": "npm run lint && npm run clean:dist",
-    "postbuild": "copyfiles package.json README.md LICENSE ../../build/postgres",
-    "clean": "ts-cleanup -s src --all & ts-cleanup -s test",
-    "clean:dist": "rimraf ../../build/postgres",
-    "compile": "tsc",
-    "lint": "eslint src/** --no-error-on-unmatched-pattern",
-    "test": "TS_NODE_PROJECT='./test/tsconfig.json' mocha -r ts-node/register -r tsconfig-paths/register --reporter spec test/**/*.spec.ts"
-  }
-}
+  "keywords" : [
+    "sqb",
+    "postgressql",
+    "postgres",
+    "pg",
+    "sql",
+    "query",
+    "builder",
+    "dialect",
+    "serializer",
+    "database"
+  ]
+}