@oino-ts/db-mariadb 0.5.2 → 0.6.1

package/dist/cjs/OINODbMariadb.js

@@ -85,7 +85,8 @@ class OINOMariadbData extends db_1.OINODbDataSet {
  */
 class OINODbMariadb extends db_1.OINODb {
     static _fieldLengthRegex = /([^\(\)]+)(\s?\((\d+)\s?\,?\s?(\d*)?\))?/i;
-    static _exceptionMessageRegex = /\(([^\)]*)\) (.*)\nsql\:(.*)?/i;
+    static _connectionExceptionMessageRegex = /\(([^\)]*)\) (.*)/i;
+    static _sqlExceptionMessageRegex = /\(([^\)]*)\) (.*)\nsql\:(.*)?/i;
     _pool;
     /**
      * Constructor of `OINODbMariadb`
@@ -97,7 +98,8 @@ class OINODbMariadb extends db_1.OINODb {
         if (this._params.type !== "OINODbMariadb") {
             throw new Error(db_1.OINO_ERROR_PREFIX + ": Not OINODbMariadb-type: " + this._params.type);
         }
-        this._pool = mariadb_1.default.createPool({ host: params.url, database: params.database, port: params.port, user: params.user, password: params.password, acquireTimeout: 2000, debug: false, rowsAsArray: true });
+        this._pool = mariadb_1.default.createPool({ host: this._params.url, database: this._params.database, port: this._params.port, user: this._params.user, password: this._params.password, acquireTimeout: 2000, debug: false, rowsAsArray: true });
+        delete this._params.password; // do not store password in db object
         // this._pool.on("acquire", (conn: mariadb.Connection) => {
         //     OINOLog.info("OINODbMariadb acquire", {conn:conn})
         // })
@@ -148,7 +150,7 @@ class OINODbMariadb extends db_1.OINODb {
             return Promise.resolve(result);
         }
         catch (err) {
-            const msg_parts = err.message.match(OINODbMariadb._exceptionMessageRegex) || [];
+            const msg_parts = err.message.match(OINODbMariadb._sqlExceptionMessageRegex) || [];
             // OINOLog.debug("OINODbMariadb._exec exception", {connection: msg_parts[1], message:msg_parts[2], sql:msg_parts[3]}) // print connection info just to log so tests don't break on runtime output
             throw new Error(msg_parts[2]);
         }
@@ -270,17 +272,57 @@ class OINODbMariadb extends db_1.OINODb {
      *
      */
     async connect() {
+        const result = new db_1.OINOResult();
+        let connection = null;
         try {
             // make sure that any items are correctly URL encoded in the connection string
             // OINOLog.debug("OINODbMariadb.connect")
-            await this._pool.on;
-            // await this._client.connect()
-            return Promise.resolve(true);
+            connection = await this._pool.getConnection();
+            this.isConnected = true;
+        }
+        catch (err) {
+            const msg_parts = err.message.match(OINODbMariadb._connectionExceptionMessageRegex) || [];
+            result.setError(500, "Error connecting to server: " + msg_parts[2], "OINODbMariadb.connect");
+            db_1.OINOLog.error(result.statusMessage, { error: err });
+        }
+        finally {
+            if (connection) {
+                await connection.end();
+            }
+        }
+        return Promise.resolve(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("OINODbMariadb.validate", {sql:sql})
+            const sql_res = await this.sqlSelect(sql);
+            // OINOLog.debug("OINODbMariadb.validate", {sql_res:sql_res})
+            if (sql_res.isEmpty()) {
+                result.setError(400, "DB returned no rows for select!", "OINODbMariadb.validate");
+            }
+            else if (sql_res.getRow().length == 0) {
+                result.setError(400, "DB returned no values for database!", "OINODbMariadb.validate");
+            }
+            else if (sql_res.getRow()[0] == "0") {
+                result.setError(400, "DB returned no schema for database!", "OINODbMariadb.validate");
+            }
+            else {
+                this.isValidated = true;
+            }
         }
         catch (err) {
-            // ... error checks
-            throw new Error(db_1.OINO_ERROR_PREFIX + ": Error connecting to OINODbMariadb server: " + err);
+            result.setError(500, "Exception validating connection: " + err.message, "OINODbMariadb.validate");
+            db_1.OINOLog.error(result.statusMessage, { error: err });
         }
+        db_1.OINOBenchmark.end("OINODb", "validate");
+        return result;
     }
     /**
      * Execute a select operation.
@@ -337,6 +379,14 @@ WHERE C.TABLE_SCHEMA = '${dbName}' AND C.TABLE_NAME = '${tableName}'
 ORDER BY C.ORDINAL_POSITION;`;
         return sql;
     }
+    _getValidateSql(dbName) {
+        const sql = `SELECT
+    Count(c.COLUMN_NAME) AS COLUMN_COUNT
+FROM information_schema.COLUMNS C
+	LEFT JOIN information_schema.KEY_COLUMN_USAGE KCU ON KCU.TABLE_SCHEMA = C.TABLE_SCHEMA AND KCU.TABLE_NAME = C.TABLE_NAME AND C.COLUMN_NAME = KCU.COLUMN_NAME and KCU.REFERENCED_TABLE_NAME IS NOT NULL
+WHERE C.TABLE_SCHEMA = '${dbName}';`;
+        return sql;
+    }
     /**
      * Initialize a data model by getting the SQL schema and populating OINODbDataFields of
      * the model.

package/dist/esm/OINODbMariadb.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, OINO_INFO_PREFIX, OINODB_EMPTY_ROW, OINODB_EMPTY_ROWS, OINOLog } from "@oino-ts/db";
+import { OINODb, OINODbDataSet, OINOBooleanDataField, OINONumberDataField, OINOStringDataField, OINO_ERROR_PREFIX, OINOBenchmark, OINODatetimeDataField, OINOBlobDataField, OINO_INFO_PREFIX, OINODB_EMPTY_ROW, OINODB_EMPTY_ROWS, OINOLog, OINOResult } from "@oino-ts/db";
 import mariadb from "mariadb";
 /**
  * Implmentation of OINODbDataSet for MariaDb.
@@ -82,7 +82,8 @@ class OINOMariadbData extends OINODbDataSet {
  */
 export class OINODbMariadb extends OINODb {
     static _fieldLengthRegex = /([^\(\)]+)(\s?\((\d+)\s?\,?\s?(\d*)?\))?/i;
-    static _exceptionMessageRegex = /\(([^\)]*)\) (.*)\nsql\:(.*)?/i;
+    static _connectionExceptionMessageRegex = /\(([^\)]*)\) (.*)/i;
+    static _sqlExceptionMessageRegex = /\(([^\)]*)\) (.*)\nsql\:(.*)?/i;
     _pool;
     /**
      * Constructor of `OINODbMariadb`
@@ -94,7 +95,8 @@ export class OINODbMariadb extends OINODb {
         if (this._params.type !== "OINODbMariadb") {
             throw new Error(OINO_ERROR_PREFIX + ": Not OINODbMariadb-type: " + this._params.type);
         }
-        this._pool = mariadb.createPool({ host: params.url, database: params.database, port: params.port, user: params.user, password: params.password, acquireTimeout: 2000, debug: false, rowsAsArray: true });
+        this._pool = mariadb.createPool({ host: this._params.url, database: this._params.database, port: this._params.port, user: this._params.user, password: this._params.password, acquireTimeout: 2000, debug: false, rowsAsArray: true });
+        delete this._params.password; // do not store password in db object
         // this._pool.on("acquire", (conn: mariadb.Connection) => {
         //     OINOLog.info("OINODbMariadb acquire", {conn:conn})
         // })
@@ -145,7 +147,7 @@ export class OINODbMariadb extends OINODb {
             return Promise.resolve(result);
         }
         catch (err) {
-            const msg_parts = err.message.match(OINODbMariadb._exceptionMessageRegex) || [];
+            const msg_parts = err.message.match(OINODbMariadb._sqlExceptionMessageRegex) || [];
             // OINOLog.debug("OINODbMariadb._exec exception", {connection: msg_parts[1], message:msg_parts[2], sql:msg_parts[3]}) // print connection info just to log so tests don't break on runtime output
             throw new Error(msg_parts[2]);
         }
@@ -267,17 +269,57 @@ export class OINODbMariadb extends OINODb {
      *
      */
     async connect() {
+        const result = new OINOResult();
+        let connection = null;
         try {
             // make sure that any items are correctly URL encoded in the connection string
             // OINOLog.debug("OINODbMariadb.connect")
-            await this._pool.on;
-            // await this._client.connect()
-            return Promise.resolve(true);
+            connection = await this._pool.getConnection();
+            this.isConnected = true;
+        }
+        catch (err) {
+            const msg_parts = err.message.match(OINODbMariadb._connectionExceptionMessageRegex) || [];
+            result.setError(500, "Error connecting to server: " + msg_parts[2], "OINODbMariadb.connect");
+            OINOLog.error(result.statusMessage, { error: err });
+        }
+        finally {
+            if (connection) {
+                await connection.end();
+            }
+        }
+        return Promise.resolve(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("OINODbMariadb.validate", {sql:sql})
+            const sql_res = await this.sqlSelect(sql);
+            // OINOLog.debug("OINODbMariadb.validate", {sql_res:sql_res})
+            if (sql_res.isEmpty()) {
+                result.setError(400, "DB returned no rows for select!", "OINODbMariadb.validate");
+            }
+            else if (sql_res.getRow().length == 0) {
+                result.setError(400, "DB returned no values for database!", "OINODbMariadb.validate");
+            }
+            else if (sql_res.getRow()[0] == "0") {
+                result.setError(400, "DB returned no schema for database!", "OINODbMariadb.validate");
+            }
+            else {
+                this.isValidated = true;
+            }
         }
         catch (err) {
-            // ... error checks
-            throw new Error(OINO_ERROR_PREFIX + ": Error connecting to OINODbMariadb server: " + err);
+            result.setError(500, "Exception validating connection: " + err.message, "OINODbMariadb.validate");
+            OINOLog.error(result.statusMessage, { error: err });
         }
+        OINOBenchmark.end("OINODb", "validate");
+        return result;
     }
     /**
      * Execute a select operation.
@@ -334,6 +376,14 @@ WHERE C.TABLE_SCHEMA = '${dbName}' AND C.TABLE_NAME = '${tableName}'
 ORDER BY C.ORDINAL_POSITION;`;
         return sql;
     }
+    _getValidateSql(dbName) {
+        const sql = `SELECT
+    Count(c.COLUMN_NAME) AS COLUMN_COUNT
+FROM information_schema.COLUMNS C
+	LEFT JOIN information_schema.KEY_COLUMN_USAGE KCU ON KCU.TABLE_SCHEMA = C.TABLE_SCHEMA AND KCU.TABLE_NAME = C.TABLE_NAME AND C.COLUMN_NAME = KCU.COLUMN_NAME and KCU.REFERENCED_TABLE_NAME IS NOT NULL
+WHERE C.TABLE_SCHEMA = '${dbName}';`;
+        return sql;
+    }
     /**
      * Initialize a data model by getting the SQL schema and populating OINODbDataFields of
      * the model.

package/dist/types/OINODbMariadb.d.ts

@@ -1,11 +1,12 @@
-import { OINODb, OINODbParams, OINODbDataSet, OINODbApi, OINODataCell } from "@oino-ts/db";
+import { OINODb, OINODbParams, OINODbDataSet, OINODbApi, OINODataCell, OINOResult } from "@oino-ts/db";
 /**
  * Implementation of MariaDb/MySql-database.
  *
  */
 export declare class OINODbMariadb extends OINODb {
     private static _fieldLengthRegex;
-    private static _exceptionMessageRegex;
+    private static _connectionExceptionMessageRegex;
+    private static _sqlExceptionMessageRegex;
     private _pool;
     /**
      * Constructor of `OINODbMariadb`
@@ -58,7 +59,12 @@ export declare class OINODbMariadb extends OINODb {
      * Connect to database.
      *
      */
-    connect(): Promise<boolean>;
+    connect(): Promise<OINOResult>;
+    /**
+     * Validate connection to database is working.
+     *
+     */
+    validate(): Promise<OINOResult>;
     /**
      * Execute a select operation.
      *
@@ -74,6 +80,7 @@ export declare class OINODbMariadb 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-mariadb",
-  "version": "0.5.2",
+  "version": "0.6.1",
   "description": "OINO TS package for using Mariadb databases.",
   "author": "Matias Kiviniemi (pragmatta)",
   "license": "MPL-2.0",
@@ -21,7 +21,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",
     "mariadb": "^3.2.3"
   },
   "devDependencies": {

package/src/OINODbMariadb.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, OINO_INFO_PREFIX, OINODB_EMPTY_ROW, OINODB_EMPTY_ROWS, OINOLog } from "@oino-ts/db";
+import { OINODb, OINODbParams, OINODbDataSet, OINODbApi, OINOBooleanDataField, OINONumberDataField, OINOStringDataField, OINODbDataFieldParams, OINO_ERROR_PREFIX, OINODataRow, OINODataCell, OINOBenchmark, OINODatetimeDataField, OINOBlobDataField, OINO_INFO_PREFIX, OINODB_EMPTY_ROW, OINODB_EMPTY_ROWS, OINOLog, OINOResult } from "@oino-ts/db";
 
 import mariadb from "mariadb";
 
@@ -91,7 +91,8 @@ class OINOMariadbData extends OINODbDataSet {
 export class OINODbMariadb extends OINODb {
     
     private static _fieldLengthRegex = /([^\(\)]+)(\s?\((\d+)\s?\,?\s?(\d*)?\))?/i
-    private static _exceptionMessageRegex = /\(([^\)]*)\) (.*)\nsql\:(.*)?/i
+    private static _connectionExceptionMessageRegex = /\(([^\)]*)\) (.*)/i
+    private static _sqlExceptionMessageRegex = /\(([^\)]*)\) (.*)\nsql\:(.*)?/i
     
     private _pool:mariadb.Pool
 
@@ -106,8 +107,9 @@ export class OINODbMariadb extends OINODb {
         if (this._params.type !== "OINODbMariadb") {
             throw new Error(OINO_ERROR_PREFIX + ": Not OINODbMariadb-type: " + this._params.type)
         } 
-        this._pool = mariadb.createPool({ host: params.url, database: params.database, port: params.port, user: params.user, password: params.password, acquireTimeout: 2000, debug:false, rowsAsArray: true })
-       
+        this._pool = mariadb.createPool({ host: this._params.url, database: this._params.database, port: this._params.port, user: this._params.user, password: this._params.password, acquireTimeout: 2000, debug:false, rowsAsArray: true })
+        delete this._params.password // do not store password in db object
+
         // this._pool.on("acquire", (conn: mariadb.Connection) => {
         //     OINOLog.info("OINODbMariadb acquire", {conn:conn})
         // })
@@ -160,7 +162,7 @@ export class OINODbMariadb extends OINODb {
             return Promise.resolve(result)
         
         } catch (err) {
-            const msg_parts = (err as Error).message.match(OINODbMariadb._exceptionMessageRegex) || []
+            const msg_parts = (err as Error).message.match(OINODbMariadb._sqlExceptionMessageRegex) || []
             // OINOLog.debug("OINODbMariadb._exec exception", {connection: msg_parts[1], message:msg_parts[2], sql:msg_parts[3]}) // print connection info just to log so tests don't break on runtime output
             throw new Error(msg_parts[2]);
         } finally {
@@ -285,17 +287,58 @@ export class OINODbMariadb extends OINODb {
      * Connect to database.
      *
      */
-    async connect(): Promise<boolean> {
+    async connect(): Promise<OINOResult> {
+        const result:OINOResult = new OINOResult()
+        let connection:mariadb.Connection|null = null
         try {
             // make sure that any items are correctly URL encoded in the connection string
             // OINOLog.debug("OINODbMariadb.connect")
-            await this._pool.on
-            // await this._client.connect()
-            return Promise.resolve(true)
+            connection = await this._pool.getConnection()
+            this.isConnected = true
+
         } catch (err) {
-            // ... error checks
-            throw new Error(OINO_ERROR_PREFIX + ": Error connecting to OINODbMariadb server: " + err)
-        }        
+            const msg_parts = (err as Error).message.match(OINODbMariadb._connectionExceptionMessageRegex) || []
+            result.setError(500, "Error connecting to server: " + msg_parts[2], "OINODbMariadb.connect")
+            OINOLog.error(result.statusMessage, {error:err})
+        } finally {
+            if (connection) {
+                await connection.end()
+            }
+        }   
+
+        return Promise.resolve(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("OINODbMariadb.validate", {sql:sql})
+            const sql_res:OINODbDataSet = await this.sqlSelect(sql)
+            // OINOLog.debug("OINODbMariadb.validate", {sql_res:sql_res})
+            if (sql_res.isEmpty()) {
+                result.setError(400, "DB returned no rows for select!", "OINODbMariadb.validate")
+
+            } else if (sql_res.getRow().length == 0) {
+                result.setError(400, "DB returned no values for database!", "OINODbMariadb.validate")
+
+            } else if (sql_res.getRow()[0] == "0") {
+                result.setError(400, "DB returned no schema for database!", "OINODbMariadb.validate")
+
+            } else {
+                this.isValidated = true
+            }
+        } catch (err:any) {
+            result.setError(500, "Exception validating connection: " + err.message, "OINODbMariadb.validate")
+            OINOLog.error(result.statusMessage, {error:err})
+        }
+        OINOBenchmark.end("OINODb", "validate")
+        return result
     }
 
     /**
@@ -357,6 +400,17 @@ ORDER BY C.ORDINAL_POSITION;`
         return sql
     }
 
+    private _getValidateSql(dbName:string):string {
+        const sql = 
+`SELECT
+    Count(c.COLUMN_NAME) AS COLUMN_COUNT
+FROM information_schema.COLUMNS C
+	LEFT JOIN information_schema.KEY_COLUMN_USAGE KCU ON KCU.TABLE_SCHEMA = C.TABLE_SCHEMA AND KCU.TABLE_NAME = C.TABLE_NAME AND C.COLUMN_NAME = KCU.COLUMN_NAME and KCU.REFERENCED_TABLE_NAME IS NOT NULL
+WHERE C.TABLE_SCHEMA = '${dbName}';`
+        return sql
+    }
+
+
     /**
      * Initialize a data model by getting the SQL schema and populating OINODbDataFields of 
      * the model.