@oino-ts/db-postgresql 0.5.2 → 0.6.1

package/dist/cjs/OINODbPostgresql.js

@@ -93,20 +93,21 @@ class OINODbPostgresql extends db_1.OINODb {
         if (this._params.type !== "OINODbPostgresql") {
             throw new Error(db_1.OINO_ERROR_PREFIX + ": Not OINODbPostgresql-type: " + this._params.type);
         }
-        const ssl_enabled = !(params.url == "localhost" || params.url == "127.0.0.1");
-        this._pool = new pg_1.Pool({ host: params.url, database: params.database, port: params.port, user: params.user, password: params.password, ssl: ssl_enabled });
+        const ssl_enabled = !(this._params.url == "localhost" || this._params.url == "127.0.0.1");
+        this._pool = new pg_1.Pool({ host: this._params.url, database: this._params.database, port: this._params.port, user: this._params.user, password: this._params.password, ssl: ssl_enabled });
+        delete this._params.password;
         this._pool.on("error", (err) => {
-            db_1.OINOLog.error("OINODbPostgresql error", { err: err });
-        });
-        this._pool.on("connect", (message) => {
-            // OINOLog.info("OINODbPostgresql connect")
-        });
-        this._pool.on("release", (message) => {
-            // OINOLog.info("OINODbPostgresql notice")
-        });
-        this._pool.on("acquire", () => {
-            // OINOLog.info("OINODbPostgresql end")
+            db_1.OINOLog.error("OINODbPostgresql error event", { err: err });
         });
+        // this._pool.on("connect", (message: any) => {
+        //     OINOLog.info("OINODbPostgresql connect")
+        // })
+        // this._pool.on("release", (message: any) => {
+        //     OINOLog.info("OINODbPostgresql notice")
+        // })
+        // this._pool.on("acquire", () => {
+        //     OINOLog.info("OINODbPostgresql end")
+        // })
     }
     _parseFieldLength(fieldLength) {
         let result = parseInt((fieldLength || "0").toString());
@@ -225,17 +226,50 @@ class OINODbPostgresql extends db_1.OINODb {
      *
      */
     async connect() {
+        let result = new db_1.OINOResult();
         try {
             // make sure that any items are correctly URL encoded in the connection string
             // OINOLog.debug("OINODbPostgresql.connect")
-            // await this._pool.connect()
-            // await this._client.connect()
-            return Promise.resolve(true);
+            await this._pool.connect();
+            this.isConnected = true;
+        }
+        catch (err) {
+            result.setError(500, "Exception connecting to database: " + err.message, "OINODbPostgresql.connect");
+            db_1.OINOLog.error(result.statusMessage, { error: err });
+        }
+        return result;
+    }
+    /**
+     * Validate connection to database is working.
+     *
+     */
+    async validate() {
+        db_1.OINOBenchmark.start("OINODb", "validate");
+        let result = new db_1.OINOResult();
+        try {
+            const sql = this._getValidateSql(this._params.database);
+            // OINOLog.debug("OINODbPostgresql.validate", {sql:sql})
+            const sql_res = await this.sqlSelect(sql);
+            // OINOLog.debug("OINODbPostgresql.validate", {sql_res:sql_res})
+            if (sql_res.isEmpty()) {
+                result.setError(400, "DB returned no rows for select!", "OINODbPostgresql.validate");
+            }
+            else if (sql_res.getRow().length == 0) {
+                result.setError(400, "DB returned no values for database!", "OINODbPostgresql.validate");
+            }
+            else if (sql_res.getRow()[0] == "0") {
+                result.setError(400, "DB returned no schema for database!", "OINODbPostgresql.validate");
+            }
+            else {
+                this.isValidated = true;
+            }
         }
         catch (err) {
-            // ... error checks
-            throw new Error(db_1.OINO_ERROR_PREFIX + ": Error connecting to Postgresql server: " + err);
+            result.setError(500, "Exception validating connection: " + err.message, "OINODbPostgresql.validate");
+            db_1.OINOLog.error(result.statusMessage, { error: err });
         }
+        db_1.OINOBenchmark.end("OINODb", "validate");
+        return result;
     }
     /**
      * Execute a select operation.
@@ -303,6 +337,25 @@ LEFT JOIN LATERAL
 WHERE col.table_catalog = '${dbName}' AND col.table_name = '${tableName}'`;
         return sql;
     }
+    _getValidateSql(dbName) {
+        const sql = `SELECT 
+    count(col.column_name) AS column_count
+FROM information_schema.columns col
+LEFT JOIN LATERAL
+    (select kcu.column_name, STRING_AGG(tco.constraint_type,',') as constraint_type
+    from 
+        information_schema.table_constraints tco,
+        information_schema.key_column_usage kcu 	 
+    where 
+        kcu.constraint_name = tco.constraint_name
+        and kcu.constraint_schema = tco.constraint_schema
+		and tco.table_catalog = col.table_catalog
+		and tco.table_name = col.table_name
+        and (tco.constraint_type = 'PRIMARY KEY' OR tco.constraint_type = 'FOREIGN KEY')
+	group by kcu.column_name) con on col.column_name = con.column_name
+WHERE col.table_catalog = '${dbName}'`;
+        return sql;
+    }
     /**
      * Initialize a data model by getting the SQL schema and populating OINODbDataFields of
      * the model.

package/dist/esm/OINODbPostgresql.js

@@ -3,7 +3,7 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at https://mozilla.org/MPL/2.0/.
  */
-import { OINODb, OINODbDataSet, OINOBooleanDataField, OINONumberDataField, OINOStringDataField, OINO_ERROR_PREFIX, OINOBenchmark, OINODatetimeDataField, OINOBlobDataField, OINOLog } from "@oino-ts/db";
+import { OINODb, OINODbDataSet, OINOBooleanDataField, OINONumberDataField, OINOStringDataField, OINO_ERROR_PREFIX, OINOBenchmark, OINODatetimeDataField, OINOBlobDataField, OINOLog, OINOResult } from "@oino-ts/db";
 import { Pool } from "pg";
 const EMPTY_ROW = [];
 /**
@@ -90,20 +90,21 @@ export class OINODbPostgresql extends OINODb {
         if (this._params.type !== "OINODbPostgresql") {
             throw new Error(OINO_ERROR_PREFIX + ": Not OINODbPostgresql-type: " + this._params.type);
         }
-        const ssl_enabled = !(params.url == "localhost" || params.url == "127.0.0.1");
-        this._pool = new Pool({ host: params.url, database: params.database, port: params.port, user: params.user, password: params.password, ssl: ssl_enabled });
+        const ssl_enabled = !(this._params.url == "localhost" || this._params.url == "127.0.0.1");
+        this._pool = new Pool({ host: this._params.url, database: this._params.database, port: this._params.port, user: this._params.user, password: this._params.password, ssl: ssl_enabled });
+        delete this._params.password;
         this._pool.on("error", (err) => {
-            OINOLog.error("OINODbPostgresql error", { err: err });
-        });
-        this._pool.on("connect", (message) => {
-            // OINOLog.info("OINODbPostgresql connect")
-        });
-        this._pool.on("release", (message) => {
-            // OINOLog.info("OINODbPostgresql notice")
-        });
-        this._pool.on("acquire", () => {
-            // OINOLog.info("OINODbPostgresql end")
+            OINOLog.error("OINODbPostgresql error event", { err: err });
         });
+        // this._pool.on("connect", (message: any) => {
+        //     OINOLog.info("OINODbPostgresql connect")
+        // })
+        // this._pool.on("release", (message: any) => {
+        //     OINOLog.info("OINODbPostgresql notice")
+        // })
+        // this._pool.on("acquire", () => {
+        //     OINOLog.info("OINODbPostgresql end")
+        // })
     }
     _parseFieldLength(fieldLength) {
         let result = parseInt((fieldLength || "0").toString());
@@ -222,17 +223,50 @@ export class OINODbPostgresql extends OINODb {
      *
      */
     async connect() {
+        let result = new OINOResult();
         try {
             // make sure that any items are correctly URL encoded in the connection string
             // OINOLog.debug("OINODbPostgresql.connect")
-            // await this._pool.connect()
-            // await this._client.connect()
-            return Promise.resolve(true);
+            await this._pool.connect();
+            this.isConnected = true;
+        }
+        catch (err) {
+            result.setError(500, "Exception connecting to database: " + err.message, "OINODbPostgresql.connect");
+            OINOLog.error(result.statusMessage, { error: err });
+        }
+        return result;
+    }
+    /**
+     * Validate connection to database is working.
+     *
+     */
+    async validate() {
+        OINOBenchmark.start("OINODb", "validate");
+        let result = new OINOResult();
+        try {
+            const sql = this._getValidateSql(this._params.database);
+            // OINOLog.debug("OINODbPostgresql.validate", {sql:sql})
+            const sql_res = await this.sqlSelect(sql);
+            // OINOLog.debug("OINODbPostgresql.validate", {sql_res:sql_res})
+            if (sql_res.isEmpty()) {
+                result.setError(400, "DB returned no rows for select!", "OINODbPostgresql.validate");
+            }
+            else if (sql_res.getRow().length == 0) {
+                result.setError(400, "DB returned no values for database!", "OINODbPostgresql.validate");
+            }
+            else if (sql_res.getRow()[0] == "0") {
+                result.setError(400, "DB returned no schema for database!", "OINODbPostgresql.validate");
+            }
+            else {
+                this.isValidated = true;
+            }
         }
         catch (err) {
-            // ... error checks
-            throw new Error(OINO_ERROR_PREFIX + ": Error connecting to Postgresql server: " + err);
+            result.setError(500, "Exception validating connection: " + err.message, "OINODbPostgresql.validate");
+            OINOLog.error(result.statusMessage, { error: err });
         }
+        OINOBenchmark.end("OINODb", "validate");
+        return result;
     }
     /**
      * Execute a select operation.
@@ -300,6 +334,25 @@ LEFT JOIN LATERAL
 WHERE col.table_catalog = '${dbName}' AND col.table_name = '${tableName}'`;
         return sql;
     }
+    _getValidateSql(dbName) {
+        const sql = `SELECT 
+    count(col.column_name) AS column_count
+FROM information_schema.columns col
+LEFT JOIN LATERAL
+    (select kcu.column_name, STRING_AGG(tco.constraint_type,',') as constraint_type
+    from 
+        information_schema.table_constraints tco,
+        information_schema.key_column_usage kcu 	 
+    where 
+        kcu.constraint_name = tco.constraint_name
+        and kcu.constraint_schema = tco.constraint_schema
+		and tco.table_catalog = col.table_catalog
+		and tco.table_name = col.table_name
+        and (tco.constraint_type = 'PRIMARY KEY' OR tco.constraint_type = 'FOREIGN KEY')
+	group by kcu.column_name) con on col.column_name = con.column_name
+WHERE col.table_catalog = '${dbName}'`;
+        return sql;
+    }
     /**
      * Initialize a data model by getting the SQL schema and populating OINODbDataFields of
      * the model.

package/dist/types/OINODbPostgresql.d.ts

@@ -1,4 +1,4 @@
-import { OINODb, OINODbParams, OINODbDataSet, OINODbApi, OINODataCell } from "@oino-ts/db";
+import { OINODb, OINODbParams, OINODbDataSet, OINODbApi, OINODataCell, OINOResult } from "@oino-ts/db";
 /**
  * Implementation of Postgresql-database.
  *
@@ -56,7 +56,12 @@ export declare class OINODbPostgresql extends OINODb {
      * Connect to database.
      *
      */
-    connect(): Promise<boolean>;
+    connect(): Promise<OINOResult>;
+    /**
+     * Validate connection to database is working.
+     *
+     */
+    validate(): Promise<OINOResult>;
     /**
      * Execute a select operation.
      *
@@ -72,6 +77,7 @@ export declare class OINODbPostgresql extends OINODb {
      */
     sqlExec(sql: string): Promise<OINODbDataSet>;
     private _getSchemaSql;
+    private _getValidateSql;
     /**
      * Initialize a data model by getting the SQL schema and populating OINODbDataFields of
      * the model.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oino-ts/db-postgresql",
-  "version": "0.5.2",
+  "version": "0.6.1",
   "description": "OINO TS package for using Postgresql databases.",
   "author": "Matias Kiviniemi (pragmatta)",
   "license": "MPL-2.0",
@@ -20,7 +20,7 @@
   "module": "./dist/esm/index.js",
   "types": "./dist/types/index.d.ts",
   "dependencies": {
-    "@oino-ts/db": "0.5.2",
+    "@oino-ts/db": "0.6.1",
     "pg": "^8.11.3"
   },
   "devDependencies": {

package/src/OINODbPostgresql.ts

@@ -4,7 +4,7 @@
  * file, You can obtain one at https://mozilla.org/MPL/2.0/.
  */
 
-import { OINODb, OINODbParams, OINODbDataSet, OINODbApi, OINOBooleanDataField, OINONumberDataField, OINOStringDataField, OINODbDataFieldParams, OINO_ERROR_PREFIX, OINODataRow, OINODataCell, OINOBenchmark, OINODatetimeDataField, OINOBlobDataField, OINOLog } from "@oino-ts/db";
+import { OINODb, OINODbParams, OINODbDataSet, OINODbApi, OINOBooleanDataField, OINONumberDataField, OINOStringDataField, OINODbDataFieldParams, OINO_ERROR_PREFIX, OINODataRow, OINODataCell, OINOBenchmark, OINODatetimeDataField, OINOBlobDataField, OINOLog, OINOResult } from "@oino-ts/db";
 
 import { Pool, QueryResult } from "pg";
 
@@ -101,20 +101,22 @@ export class OINODbPostgresql extends OINODb {
         if (this._params.type !== "OINODbPostgresql") {
             throw new Error(OINO_ERROR_PREFIX + ": Not OINODbPostgresql-type: " + this._params.type)
         } 
-        const ssl_enabled:boolean = !(params.url == "localhost" || params.url == "127.0.0.1")
-        this._pool = new Pool({ host: params.url, database: params.database, port: params.port, user: params.user, password: params.password, ssl: ssl_enabled })
+        const ssl_enabled:boolean = !(this._params.url == "localhost" || this._params.url == "127.0.0.1")
+        this._pool = new Pool({ host: this._params.url, database: this._params.database, port: this._params.port, user: this._params.user, password: this._params.password, ssl: ssl_enabled })
+        delete this._params.password
+
         this._pool.on("error", (err: any) => {
-            OINOLog.error("OINODbPostgresql error", {err:err})
-        })
-        this._pool.on("connect", (message: any) => {
-            // OINOLog.info("OINODbPostgresql connect")
-        })
-        this._pool.on("release", (message: any) => {
-            // OINOLog.info("OINODbPostgresql notice")
-        })
-        this._pool.on("acquire", () => {
-            // OINOLog.info("OINODbPostgresql end")
+            OINOLog.error("OINODbPostgresql error event", {err:err})
         })
+        // this._pool.on("connect", (message: any) => {
+        //     OINOLog.info("OINODbPostgresql connect")
+        // })
+        // this._pool.on("release", (message: any) => {
+        //     OINOLog.info("OINODbPostgresql notice")
+        // })
+        // this._pool.on("acquire", () => {
+        //     OINOLog.info("OINODbPostgresql end")
+        // })
     }
 
     private _parseFieldLength(fieldLength:OINODataCell):number {
@@ -240,17 +242,51 @@ export class OINODbPostgresql extends OINODb {
      * Connect to database.
      *
      */
-    async connect(): Promise<boolean> {
+    async connect(): Promise<OINOResult> {
+        let result:OINOResult = new OINOResult()
         try {
             // make sure that any items are correctly URL encoded in the connection string
             // OINOLog.debug("OINODbPostgresql.connect")
-            // await this._pool.connect()
-            // await this._client.connect()
-            return Promise.resolve(true)
-        } catch (err) {
-            // ... error checks
-            throw new Error(OINO_ERROR_PREFIX + ": Error connecting to Postgresql server: " + err)
+            await this._pool.connect()
+            this.isConnected = true
+
+        } catch (err:any) {
+            result.setError(500, "Exception connecting to database: " + err.message, "OINODbPostgresql.connect")
+            OINOLog.error(result.statusMessage, {error:err})
         }        
+        return result
+    }
+
+    /**
+     * Validate connection to database is working. 
+     *
+     */
+    async validate(): Promise<OINOResult> {
+        OINOBenchmark.start("OINODb", "validate")
+        let result:OINOResult = new OINOResult()
+        try {
+            const sql = this._getValidateSql(this._params.database)
+            // OINOLog.debug("OINODbPostgresql.validate", {sql:sql})
+            const sql_res:OINODbDataSet = await this.sqlSelect(sql)
+            // OINOLog.debug("OINODbPostgresql.validate", {sql_res:sql_res})
+            if (sql_res.isEmpty()) {
+                result.setError(400, "DB returned no rows for select!", "OINODbPostgresql.validate")
+
+            } else if (sql_res.getRow().length == 0) {
+                result.setError(400, "DB returned no values for database!", "OINODbPostgresql.validate")
+
+            } else if (sql_res.getRow()[0] == "0") {
+                result.setError(400, "DB returned no schema for database!", "OINODbPostgresql.validate")
+
+            } else {
+                this.isValidated = true
+            }
+        } catch (err:any) {
+            result.setError(500, "Exception validating connection: " + err.message, "OINODbPostgresql.validate")
+            OINOLog.error(result.statusMessage, {error:err})
+        }
+        OINOBenchmark.end("OINODb", "validate")
+        return result
     }
 
     /**
@@ -323,6 +359,27 @@ WHERE col.table_catalog = '${dbName}' AND col.table_name = '${tableName}'`
         return sql
     }
 
+    private _getValidateSql(dbName:string):string {
+        const sql = 
+`SELECT 
+    count(col.column_name) AS column_count
+FROM information_schema.columns col
+LEFT JOIN LATERAL
+    (select kcu.column_name, STRING_AGG(tco.constraint_type,',') as constraint_type
+    from 
+        information_schema.table_constraints tco,
+        information_schema.key_column_usage kcu 	 
+    where 
+        kcu.constraint_name = tco.constraint_name
+        and kcu.constraint_schema = tco.constraint_schema
+		and tco.table_catalog = col.table_catalog
+		and tco.table_name = col.table_name
+        and (tco.constraint_type = 'PRIMARY KEY' OR tco.constraint_type = 'FOREIGN KEY')
+	group by kcu.column_name) con on col.column_name = con.column_name
+WHERE col.table_catalog = '${dbName}'`
+        return sql
+    }
+
     /**
      * Initialize a data model by getting the SQL schema and populating OINODbDataFields of 
      * the model.