@oino-ts/db-mssql 0.5.2 → 0.6.0

package/dist/cjs/OINODbMsSql.js

@@ -271,6 +271,9 @@ class OINODbMsSql extends db_1.OINODb {
         if (whereCondition != "") {
             result += " WHERE " + whereCondition;
         }
+        if (groupByCondition != "") {
+            result += " GROUP BY " + groupByCondition;
+        }
         if (orderCondition != "") {
             result += " ORDER BY " + orderCondition;
         }
@@ -282,9 +285,6 @@ class OINODbMsSql extends db_1.OINODb {
                 result += " OFFSET " + limit_parts[1] + " ROWS FETCH NEXT " + limit_parts[0] + " ROWS ONLY";
             }
         }
-        if (groupByCondition != "") {
-            result += " GROUP BY " + groupByCondition;
-        }
         result += ";";
         // OINOLog.debug("OINODb.printSqlSelect", {result:result})
         return result;
@@ -306,6 +306,37 @@ class OINODbMsSql extends db_1.OINODb {
             throw new Error(db_1.OINO_ERROR_PREFIX + ": Error connecting to OINODbMsSql 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("OINODbBunSqlite.validate", {sql:sql})
+            const sql_res = await this.sqlSelect(sql);
+            // OINOLog.debug("OINODbBunSqlite.validate", {sql_res:sql_res})
+            if (sql_res.isEmpty()) {
+                result.setError(400, "DB returned no rows for select!", "OINODbBunSqlite.validate");
+            }
+            else if (sql_res.getRow().length == 0) {
+                result.setError(400, "DB returned no values for database!", "OINODbBunSqlite.validate");
+            }
+            else if (sql_res.getRow()[0] == "0") {
+                result.setError(400, "DB returned no schema for database!", "OINODbBunSqlite.validate");
+            }
+            else {
+                // connection is working
+            }
+        }
+        catch (e) {
+            result.setError(500, db_1.OINO_ERROR_PREFIX + " (validate): OINODbBunSqlite.validate exception in _db.query: " + e.message, "OINODbBunSqlite.validate");
+        }
+        db_1.OINOBenchmark.end("OINODb", "validate");
+        return result;
+    }
     /**
      * Execute a select operation.
      *
@@ -316,7 +347,7 @@ class OINODbMsSql extends db_1.OINODb {
         db_1.OINOBenchmark.start("OINODb", "sqlSelect");
         let result;
         try {
-            // OINOLog.debug("OINODbMsSql.sqlSelect", {sql_rows:sql_rows})
+            // OINOLog.debug("OINODbMsSql.sqlSelect", {sql:sql})
             result = await this._query(sql);
         }
         catch (e) {
@@ -367,6 +398,21 @@ WHERE C.TABLE_CATALOG = '${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 as C LEFT JOIN 
+    (
+    SELECT TC.TABLE_NAME, KU.COLUMN_NAME, STRING_AGG(TC.CONSTRAINT_TYPE, ',') as CONSTRAINT_TYPES
+    FROM INFORMATION_SCHEMA.TABLE_CONSTRAINTS AS TC 
+    INNER JOIN INFORMATION_SCHEMA.KEY_COLUMN_USAGE AS KU ON TC.CONSTRAINT_NAME = KU.CONSTRAINT_NAME
+    GROUP BY TC.TABLE_NAME, KU.COLUMN_NAME
+    ) as CONST
+    ON C.TABLE_NAME = CONST.TABLE_NAME AND C.COLUMN_NAME = CONST.COLUMN_NAME
+WHERE C.TABLE_CATALOG = '${dbName}';`;
+        return sql;
+    }
     /**
      * Initialize a data model by getting the SQL schema and populating OINODbDataFields of
      * the model.

package/dist/esm/OINODbMsSql.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 { ConnectionPool } from "mssql";
 /**
  * Implmentation of OINODbDataSet for MariaDb.
@@ -268,6 +268,9 @@ export class OINODbMsSql extends OINODb {
         if (whereCondition != "") {
             result += " WHERE " + whereCondition;
         }
+        if (groupByCondition != "") {
+            result += " GROUP BY " + groupByCondition;
+        }
         if (orderCondition != "") {
             result += " ORDER BY " + orderCondition;
         }
@@ -279,9 +282,6 @@ export class OINODbMsSql extends OINODb {
                 result += " OFFSET " + limit_parts[1] + " ROWS FETCH NEXT " + limit_parts[0] + " ROWS ONLY";
             }
         }
-        if (groupByCondition != "") {
-            result += " GROUP BY " + groupByCondition;
-        }
         result += ";";
         // OINOLog.debug("OINODb.printSqlSelect", {result:result})
         return result;
@@ -303,6 +303,37 @@ export class OINODbMsSql extends OINODb {
             throw new Error(OINO_ERROR_PREFIX + ": Error connecting to OINODbMsSql 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("OINODbBunSqlite.validate", {sql:sql})
+            const sql_res = await this.sqlSelect(sql);
+            // OINOLog.debug("OINODbBunSqlite.validate", {sql_res:sql_res})
+            if (sql_res.isEmpty()) {
+                result.setError(400, "DB returned no rows for select!", "OINODbBunSqlite.validate");
+            }
+            else if (sql_res.getRow().length == 0) {
+                result.setError(400, "DB returned no values for database!", "OINODbBunSqlite.validate");
+            }
+            else if (sql_res.getRow()[0] == "0") {
+                result.setError(400, "DB returned no schema for database!", "OINODbBunSqlite.validate");
+            }
+            else {
+                // connection is working
+            }
+        }
+        catch (e) {
+            result.setError(500, OINO_ERROR_PREFIX + " (validate): OINODbBunSqlite.validate exception in _db.query: " + e.message, "OINODbBunSqlite.validate");
+        }
+        OINOBenchmark.end("OINODb", "validate");
+        return result;
+    }
     /**
      * Execute a select operation.
      *
@@ -313,7 +344,7 @@ export class OINODbMsSql extends OINODb {
         OINOBenchmark.start("OINODb", "sqlSelect");
         let result;
         try {
-            // OINOLog.debug("OINODbMsSql.sqlSelect", {sql_rows:sql_rows})
+            // OINOLog.debug("OINODbMsSql.sqlSelect", {sql:sql})
             result = await this._query(sql);
         }
         catch (e) {
@@ -364,6 +395,21 @@ WHERE C.TABLE_CATALOG = '${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 as C LEFT JOIN 
+    (
+    SELECT TC.TABLE_NAME, KU.COLUMN_NAME, STRING_AGG(TC.CONSTRAINT_TYPE, ',') as CONSTRAINT_TYPES
+    FROM INFORMATION_SCHEMA.TABLE_CONSTRAINTS AS TC 
+    INNER JOIN INFORMATION_SCHEMA.KEY_COLUMN_USAGE AS KU ON TC.CONSTRAINT_NAME = KU.CONSTRAINT_NAME
+    GROUP BY TC.TABLE_NAME, KU.COLUMN_NAME
+    ) as CONST
+    ON C.TABLE_NAME = CONST.TABLE_NAME AND C.COLUMN_NAME = CONST.COLUMN_NAME
+WHERE C.TABLE_CATALOG = '${dbName}';`;
+        return sql;
+    }
     /**
      * Initialize a data model by getting the SQL schema and populating OINODbDataFields of
      * the model.

package/dist/types/OINODbMsSql.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.
  *
@@ -68,6 +68,11 @@ export declare class OINODbMsSql extends OINODb {
      *
      */
     connect(): Promise<boolean>;
+    /**
+     * Validate connection to database is working.
+     *
+     */
+    validate(): Promise<OINOResult>;
     /**
      * Execute a select operation.
      *
@@ -83,6 +88,7 @@ export declare class OINODbMsSql 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-mssql",
-  "version": "0.5.2",
+  "version": "0.6.0",
   "description": "OINO TS package for using Microsoft Sql databases.",
   "author": "Matias Kiviniemi (pragmatta)",
   "license": "MPL-2.0",
@@ -22,7 +22,7 @@
   "module": "./dist/esm/index.js",
   "types": "./dist/types/index.d.ts",
   "dependencies": {
-    "@oino-ts/db": "0.5.2",
+    "@oino-ts/db": "0.6.0",
     "mssql": "^11.0.1"
   },
   "devDependencies": {

package/src/OINODbMsSql.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 {ConnectionPool, config} from "mssql";
 
@@ -287,6 +287,9 @@ export class OINODbMsSql extends OINODb {
         if (whereCondition != "")  {
             result += " WHERE " + whereCondition
         }
+        if (groupByCondition != "") {
+            result += " GROUP BY " + groupByCondition 
+        }
         if (orderCondition != "") {
             result += " ORDER BY " + orderCondition 
         }
@@ -297,9 +300,6 @@ export class OINODbMsSql extends OINODb {
                 result += " OFFSET " + limit_parts[1] + " ROWS FETCH NEXT " + limit_parts[0] + " ROWS ONLY"
             }
         }
-        if (groupByCondition != "") {
-            result += " GROUP BY " + groupByCondition 
-        }
         result += ";"
         // OINOLog.debug("OINODb.printSqlSelect", {result:result})
         return result;
@@ -322,6 +322,37 @@ export class OINODbMsSql 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("OINODbBunSqlite.validate", {sql:sql})
+            const sql_res:OINODbDataSet = await this.sqlSelect(sql)
+            // OINOLog.debug("OINODbBunSqlite.validate", {sql_res:sql_res})
+            if (sql_res.isEmpty()) {
+                result.setError(400, "DB returned no rows for select!", "OINODbBunSqlite.validate")
+
+            } else if (sql_res.getRow().length == 0) {
+                result.setError(400, "DB returned no values for database!", "OINODbBunSqlite.validate")
+
+            } else if (sql_res.getRow()[0] == "0") {
+                result.setError(400, "DB returned no schema for database!", "OINODbBunSqlite.validate")
+
+            } else {
+                // connection is working
+            }
+        } catch (e:any) {
+            result.setError(500, OINO_ERROR_PREFIX + " (validate): OINODbBunSqlite.validate exception in _db.query: " + e.message, "OINODbBunSqlite.validate")
+        }
+        OINOBenchmark.end("OINODb", "validate")
+        return result
+    }
+
     /**
      * Execute a select operation.
      * 
@@ -332,7 +363,7 @@ export class OINODbMsSql extends OINODb {
         OINOBenchmark.start("OINODb", "sqlSelect")
         let result:OINODbDataSet
         try {
-            // OINOLog.debug("OINODbMsSql.sqlSelect", {sql_rows:sql_rows})
+            // OINOLog.debug("OINODbMsSql.sqlSelect", {sql:sql})
             result = await this._query(sql)
 
         } catch (e:any) {
@@ -386,6 +417,24 @@ WHERE C.TABLE_CATALOG = '${dbName}' AND C.TABLE_NAME = '${tableName}'
 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 as C LEFT JOIN 
+    (
+    SELECT TC.TABLE_NAME, KU.COLUMN_NAME, STRING_AGG(TC.CONSTRAINT_TYPE, ',') as CONSTRAINT_TYPES
+    FROM INFORMATION_SCHEMA.TABLE_CONSTRAINTS AS TC 
+    INNER JOIN INFORMATION_SCHEMA.KEY_COLUMN_USAGE AS KU ON TC.CONSTRAINT_NAME = KU.CONSTRAINT_NAME
+    GROUP BY TC.TABLE_NAME, KU.COLUMN_NAME
+    ) as CONST
+    ON C.TABLE_NAME = CONST.TABLE_NAME AND C.COLUMN_NAME = CONST.COLUMN_NAME
+WHERE C.TABLE_CATALOG = '${dbName}';`
+        return sql
+    }
+
     /**
      * Initialize a data model by getting the SQL schema and populating OINODbDataFields of 
      * the model.