@oino-ts/db-mariadb 0.5.1 → 0.6.0

package/dist/cjs/OINODbMariadb.js

@@ -250,7 +250,7 @@ class OINODbMariadb extends db_1.OINODb {
         else if (sqlValue === undefined) {
             return undefined;
         }
-        else if (((sqlType == "date")) && (typeof (sqlValue) == "string")) {
+        else if (((sqlType == "date")) && (typeof (sqlValue) == "string") && (sqlValue != "")) {
             return new Date(sqlValue);
         }
         else if ((sqlType == "bit") && (sqlValue instanceof Buffer)) { // mariadb returns a buffer for bit-fields
@@ -282,6 +282,37 @@ class OINODbMariadb extends db_1.OINODb {
             throw new Error(db_1.OINO_ERROR_PREFIX + ": Error connecting to OINODbMariadb server: " + err);
         }
     }
+    /**
+     * 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);
+            db_1.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 {
+                // connection is working
+            }
+        }
+        catch (e) {
+            result.setError(500, db_1.OINO_ERROR_PREFIX + " (validate): OINODbMariadb.validate exception in _db.query: " + e.message, "OINODbMariadb.validate");
+        }
+        db_1.OINOBenchmark.end("OINODb", "validate");
+        return result;
+    }
     /**
      * Execute a select operation.
      *
@@ -337,6 +368,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.
@@ -247,7 +247,7 @@ export class OINODbMariadb extends OINODb {
         else if (sqlValue === undefined) {
             return undefined;
         }
-        else if (((sqlType == "date")) && (typeof (sqlValue) == "string")) {
+        else if (((sqlType == "date")) && (typeof (sqlValue) == "string") && (sqlValue != "")) {
             return new Date(sqlValue);
         }
         else if ((sqlType == "bit") && (sqlValue instanceof Buffer)) { // mariadb returns a buffer for bit-fields
@@ -279,6 +279,37 @@ export class OINODbMariadb extends OINODb {
             throw new Error(OINO_ERROR_PREFIX + ": Error connecting to OINODbMariadb server: " + err);
         }
     }
+    /**
+     * 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 {
+                // connection is working
+            }
+        }
+        catch (e) {
+            result.setError(500, OINO_ERROR_PREFIX + " (validate): OINODbMariadb.validate exception in _db.query: " + e.message, "OINODbMariadb.validate");
+        }
+        OINOBenchmark.end("OINODb", "validate");
+        return result;
+    }
     /**
      * Execute a select operation.
      *
@@ -334,6 +365,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,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 MariaDb/MySql-database.
  *
@@ -59,6 +59,11 @@ export declare class OINODbMariadb extends OINODb {
      *
      */
     connect(): Promise<boolean>;
+    /**
+     * Validate connection to database is working.
+     *
+     */
+    validate(): Promise<OINOResult>;
     /**
      * Execute a select operation.
      *
@@ -74,6 +79,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.1",
+  "version": "0.6.0",
   "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.1",
+    "@oino-ts/db": "^0.6.0",
     "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";
 
@@ -264,7 +264,7 @@ export class OINODbMariadb extends OINODb {
         } else if (sqlValue === undefined) {
             return undefined
 
-        } else if (((sqlType == "date")) && (typeof(sqlValue) == "string")) {
+        } else if (((sqlType == "date")) && (typeof(sqlValue) == "string") && (sqlValue != "")) {
             return new Date(sqlValue)
 
         } else if ((sqlType == "bit") && (sqlValue instanceof Buffer)) { // mariadb returns a buffer for bit-fields
@@ -298,6 +298,37 @@ export class OINODbMariadb extends OINODb {
         }        
     }
 
+    /**
+     * 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 {
+                // connection is working
+            }
+        } catch (e:any) {
+            result.setError(500, OINO_ERROR_PREFIX + " (validate): OINODbMariadb.validate exception in _db.query: " + e.message, "OINODbMariadb.validate")
+        }
+        OINOBenchmark.end("OINODb", "validate")
+        return result
+    }
+
     /**
      * Execute a select operation.
      * 
@@ -357,6 +388,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.