@oino-ts/db-mssql 0.19.0 → 0.20.0

package/dist/cjs/OINODbMsSql.js

@@ -14,7 +14,7 @@ const mssql_1 = require("mssql");
  *
  */
 class OINOMsSqlData extends db_1.OINODbDataSet {
-    _recordsets = [db_1.OINODB_EMPTY_ROWS];
+    _recordsets;
     _rows = db_1.OINODB_EMPTY_ROWS;
     _currentRecordset;
     _currentRow;
@@ -28,7 +28,7 @@ class OINOMsSqlData extends db_1.OINODbDataSet {
         if (data == null) {
             this.messages.push(common_1.OINO_INFO_PREFIX + "SQL result is empty");
         }
-        else if (!(Array.isArray(data) && (data.length > 0) && Array.isArray(data[0]))) {
+        else if (!(Array.isArray(data)) && (data.length > 0)) {
             throw new Error(common_1.OINO_ERROR_PREFIX + ": OINOMsSqlData constructor: invalid data!");
         }
         else {
@@ -51,7 +51,7 @@ class OINOMsSqlData extends db_1.OINODbDataSet {
      *
      */
     isEmpty() {
-        return (this._rows.length == 0);
+        return (this._recordsets.length == 0) || (this._rows == undefined) || (this._rows.length == 0);
     }
     /**
      * Is there no more content, i.e. either dataset is empty or we have moved beyond last line
@@ -133,14 +133,28 @@ class OINODbMsSql extends db_1.OINODb {
         });
     }
     async _query(sql) {
-        const request = this._pool.request(); // this does not need to be released but the pool will handle it
-        const sql_res = await request.query(sql);
-        const result = new OINOMsSqlData(sql_res.recordsets);
-        return result;
+        try {
+            const request = this._pool.request(); // this does not need to be released but the pool will handle it
+            const sql_res = await request.query(sql);
+            // console.log("_query: result=", sql_res.recordsets, sql_res.recordsets?.length) // TODO: remove
+            return new OINOMsSqlData(sql_res.recordsets, []);
+        }
+        catch (e) {
+            common_1.OINOLog.exception("@oino-ts/db-mssql", "OINODbMsSql", "_query", "exception in SQL query", { message: e.message, stack: e.stack, sql: sql });
+            return new OINOMsSqlData(db_1.OINODB_EMPTY_ROWS, []).setError(500, common_1.OINO_ERROR_PREFIX + ": Exception in db query: " + e.message, "OINODbMsSql._query");
+        }
     }
     async _exec(sql) {
-        const sql_res = await this._pool.request().query(sql);
-        return new OINOMsSqlData(db_1.OINODB_EMPTY_ROWS);
+        try {
+            const request = this._pool.request(); // this does not need to be released but the pool will handle it
+            const sql_res = await request.query(sql);
+            // console.log("_exec: result=", sql_res.recordsets, sql_res.recordsets?.length) // TODO: remove
+            return new OINOMsSqlData(sql_res.recordsets, []);
+        }
+        catch (e) {
+            common_1.OINOLog.exception("@oino-ts/db-mssql", "OINODbMsSql", "_exec", "exception in SQL exec", { message: e.message, stack: e.stack, sql: sql });
+            return new OINOMsSqlData(db_1.OINODB_EMPTY_ROWS, []).setError(500, common_1.OINO_ERROR_PREFIX + ": Exception in db exec: " + e.message, "OINODbMsSql._exec");
+        }
     }
     /**
      * Print a table name using database specific SQL escaping.
@@ -270,12 +284,32 @@ class OINODbMsSql extends db_1.OINODb {
         common_1.OINOLog.debug("@oino-ts/db-mssql", "OINODbMsSql", "printSqlSelect", "Result", { sql: result });
         return result;
     }
+    /**
+     * Print SQL select statement with DB specific formatting.
+     *
+     * @param tableName - The name of the table to select from.
+     * @param columns - The columns to be selected.
+     * @param values - The values to be inserted.
+     * @param returnIdFields - the id fields to return if returnIds is true (if supported by the database)
+     *
+     */
+    printSqlInsert(tableName, columns, values, returnIdFields) {
+        let result = "INSERT INTO " + tableName + " (" + columns + ")";
+        if (returnIdFields) {
+            result += " OUTPUT " + returnIdFields.map(f => "INSERTED." + f).join(", ");
+        }
+        result += " VALUES (" + values + ");";
+        return result;
+    }
     /**
      * Connect to database.
      *
      */
     async connect() {
         let result = new common_1.OINOResult();
+        if (this.isConnected) {
+            return result;
+        }
         try {
             // make sure that any items are correctly URL encoded in the connection string
             await this._pool.connect();
@@ -301,7 +335,7 @@ class OINODbMsSql extends db_1.OINODb {
         common_1.OINOBenchmark.startMetric("OINODb", "validate");
         try {
             const sql = this._getValidateSql(this._params.database);
-            const sql_res = await this.sqlSelect(sql);
+            const sql_res = await this._query(sql);
             if (sql_res.isEmpty()) {
                 result.setError(400, "DB returned no rows for select!", "OINODbMsSql.validate");
             }
@@ -323,6 +357,22 @@ class OINODbMsSql extends db_1.OINODb {
         common_1.OINOBenchmark.endMetric("OINODb", "validate");
         return result;
     }
+    /**
+     * Disconnect from database.
+     *
+     */
+    async disconnect() {
+        if (this._pool) {
+            try {
+                await this._pool.close();
+            }
+            catch (e) {
+                common_1.OINOLog.exception("@oino-ts/db-mssql", "OINODbMsSql", "disconnect", "exception in disconnect", { message: e.message, stack: e.stack });
+            }
+        }
+        this.isConnected = false;
+        this.isValidated = false;
+    }
     /**
      * Execute a select operation.
      *
@@ -330,15 +380,11 @@ class OINODbMsSql extends db_1.OINODb {
      *
      */
     async sqlSelect(sql) {
-        common_1.OINOBenchmark.startMetric("OINODb", "sqlSelect");
-        let result;
-        try {
-            result = await this._query(sql);
-        }
-        catch (e) {
-            common_1.OINOLog.exception("@oino-ts/db-mssql", "OINODbMsSql", "sqlSelect", "exception in SQL select", { message: e.message, stack: e.stack });
-            result = new OINOMsSqlData(db_1.OINODB_EMPTY_ROWS, [common_1.OINO_ERROR_PREFIX + " (sqlSelect): OINODbMsSql.sqlSelect exception in _db.query: " + e.message]);
+        if (!this.isValidated) {
+            throw new Error(common_1.OINO_ERROR_PREFIX + ": Database connection not validated!");
         }
+        common_1.OINOBenchmark.startMetric("OINODb", "sqlSelect");
+        let result = await this._query(sql);
         common_1.OINOBenchmark.endMetric("OINODb", "sqlSelect");
         return result;
     }
@@ -349,15 +395,11 @@ class OINODbMsSql extends db_1.OINODb {
      *
      */
     async sqlExec(sql) {
-        common_1.OINOBenchmark.startMetric("OINODb", "sqlExec");
-        let result;
-        try {
-            result = await this._exec(sql);
-        }
-        catch (e) {
-            common_1.OINOLog.exception("@oino-ts/db-mssql", "OINODbMsSql", "sqlExec", "exception in SQL exec", { message: e.message, stack: e.stack });
-            result = new OINOMsSqlData(db_1.OINODB_EMPTY_ROWS, [common_1.OINO_ERROR_PREFIX + " (sqlExec): exception in _db.exec [" + e.message + "]"]);
+        if (!this.isValidated) {
+            throw new Error(common_1.OINO_ERROR_PREFIX + ": Database connection not validated!");
         }
+        common_1.OINOBenchmark.startMetric("OINODb", "sqlExec");
+        let result = await this._exec(sql);
         common_1.OINOBenchmark.endMetric("OINODb", "sqlExec");
         return result;
     }

package/dist/esm/OINODbMsSql.js

@@ -11,7 +11,7 @@ import { ConnectionPool } from "mssql";
  *
  */
 class OINOMsSqlData extends OINODbDataSet {
-    _recordsets = [OINODB_EMPTY_ROWS];
+    _recordsets;
     _rows = OINODB_EMPTY_ROWS;
     _currentRecordset;
     _currentRow;
@@ -25,7 +25,7 @@ class OINOMsSqlData extends OINODbDataSet {
         if (data == null) {
             this.messages.push(OINO_INFO_PREFIX + "SQL result is empty");
         }
-        else if (!(Array.isArray(data) && (data.length > 0) && Array.isArray(data[0]))) {
+        else if (!(Array.isArray(data)) && (data.length > 0)) {
             throw new Error(OINO_ERROR_PREFIX + ": OINOMsSqlData constructor: invalid data!");
         }
         else {
@@ -48,7 +48,7 @@ class OINOMsSqlData extends OINODbDataSet {
      *
      */
     isEmpty() {
-        return (this._rows.length == 0);
+        return (this._recordsets.length == 0) || (this._rows == undefined) || (this._rows.length == 0);
     }
     /**
      * Is there no more content, i.e. either dataset is empty or we have moved beyond last line
@@ -130,14 +130,28 @@ export class OINODbMsSql extends OINODb {
         });
     }
     async _query(sql) {
-        const request = this._pool.request(); // this does not need to be released but the pool will handle it
-        const sql_res = await request.query(sql);
-        const result = new OINOMsSqlData(sql_res.recordsets);
-        return result;
+        try {
+            const request = this._pool.request(); // this does not need to be released but the pool will handle it
+            const sql_res = await request.query(sql);
+            // console.log("_query: result=", sql_res.recordsets, sql_res.recordsets?.length) // TODO: remove
+            return new OINOMsSqlData(sql_res.recordsets, []);
+        }
+        catch (e) {
+            OINOLog.exception("@oino-ts/db-mssql", "OINODbMsSql", "_query", "exception in SQL query", { message: e.message, stack: e.stack, sql: sql });
+            return new OINOMsSqlData(OINODB_EMPTY_ROWS, []).setError(500, OINO_ERROR_PREFIX + ": Exception in db query: " + e.message, "OINODbMsSql._query");
+        }
     }
     async _exec(sql) {
-        const sql_res = await this._pool.request().query(sql);
-        return new OINOMsSqlData(OINODB_EMPTY_ROWS);
+        try {
+            const request = this._pool.request(); // this does not need to be released but the pool will handle it
+            const sql_res = await request.query(sql);
+            // console.log("_exec: result=", sql_res.recordsets, sql_res.recordsets?.length) // TODO: remove
+            return new OINOMsSqlData(sql_res.recordsets, []);
+        }
+        catch (e) {
+            OINOLog.exception("@oino-ts/db-mssql", "OINODbMsSql", "_exec", "exception in SQL exec", { message: e.message, stack: e.stack, sql: sql });
+            return new OINOMsSqlData(OINODB_EMPTY_ROWS, []).setError(500, OINO_ERROR_PREFIX + ": Exception in db exec: " + e.message, "OINODbMsSql._exec");
+        }
     }
     /**
      * Print a table name using database specific SQL escaping.
@@ -267,12 +281,32 @@ export class OINODbMsSql extends OINODb {
         OINOLog.debug("@oino-ts/db-mssql", "OINODbMsSql", "printSqlSelect", "Result", { sql: result });
         return result;
     }
+    /**
+     * Print SQL select statement with DB specific formatting.
+     *
+     * @param tableName - The name of the table to select from.
+     * @param columns - The columns to be selected.
+     * @param values - The values to be inserted.
+     * @param returnIdFields - the id fields to return if returnIds is true (if supported by the database)
+     *
+     */
+    printSqlInsert(tableName, columns, values, returnIdFields) {
+        let result = "INSERT INTO " + tableName + " (" + columns + ")";
+        if (returnIdFields) {
+            result += " OUTPUT " + returnIdFields.map(f => "INSERTED." + f).join(", ");
+        }
+        result += " VALUES (" + values + ");";
+        return result;
+    }
     /**
      * Connect to database.
      *
      */
     async connect() {
         let result = new OINOResult();
+        if (this.isConnected) {
+            return result;
+        }
         try {
             // make sure that any items are correctly URL encoded in the connection string
             await this._pool.connect();
@@ -298,7 +332,7 @@ export class OINODbMsSql extends OINODb {
         OINOBenchmark.startMetric("OINODb", "validate");
         try {
             const sql = this._getValidateSql(this._params.database);
-            const sql_res = await this.sqlSelect(sql);
+            const sql_res = await this._query(sql);
             if (sql_res.isEmpty()) {
                 result.setError(400, "DB returned no rows for select!", "OINODbMsSql.validate");
             }
@@ -320,6 +354,22 @@ export class OINODbMsSql extends OINODb {
         OINOBenchmark.endMetric("OINODb", "validate");
         return result;
     }
+    /**
+     * Disconnect from database.
+     *
+     */
+    async disconnect() {
+        if (this._pool) {
+            try {
+                await this._pool.close();
+            }
+            catch (e) {
+                OINOLog.exception("@oino-ts/db-mssql", "OINODbMsSql", "disconnect", "exception in disconnect", { message: e.message, stack: e.stack });
+            }
+        }
+        this.isConnected = false;
+        this.isValidated = false;
+    }
     /**
      * Execute a select operation.
      *
@@ -327,15 +377,11 @@ export class OINODbMsSql extends OINODb {
      *
      */
     async sqlSelect(sql) {
-        OINOBenchmark.startMetric("OINODb", "sqlSelect");
-        let result;
-        try {
-            result = await this._query(sql);
-        }
-        catch (e) {
-            OINOLog.exception("@oino-ts/db-mssql", "OINODbMsSql", "sqlSelect", "exception in SQL select", { message: e.message, stack: e.stack });
-            result = new OINOMsSqlData(OINODB_EMPTY_ROWS, [OINO_ERROR_PREFIX + " (sqlSelect): OINODbMsSql.sqlSelect exception in _db.query: " + e.message]);
+        if (!this.isValidated) {
+            throw new Error(OINO_ERROR_PREFIX + ": Database connection not validated!");
         }
+        OINOBenchmark.startMetric("OINODb", "sqlSelect");
+        let result = await this._query(sql);
         OINOBenchmark.endMetric("OINODb", "sqlSelect");
         return result;
     }
@@ -346,15 +392,11 @@ export class OINODbMsSql extends OINODb {
      *
      */
     async sqlExec(sql) {
-        OINOBenchmark.startMetric("OINODb", "sqlExec");
-        let result;
-        try {
-            result = await this._exec(sql);
-        }
-        catch (e) {
-            OINOLog.exception("@oino-ts/db-mssql", "OINODbMsSql", "sqlExec", "exception in SQL exec", { message: e.message, stack: e.stack });
-            result = new OINOMsSqlData(OINODB_EMPTY_ROWS, [OINO_ERROR_PREFIX + " (sqlExec): exception in _db.exec [" + e.message + "]"]);
+        if (!this.isValidated) {
+            throw new Error(OINO_ERROR_PREFIX + ": Database connection not validated!");
         }
+        OINOBenchmark.startMetric("OINODb", "sqlExec");
+        let result = await this._exec(sql);
         OINOBenchmark.endMetric("OINODb", "sqlExec");
         return result;
     }

package/dist/types/OINODbMsSql.d.ts

@@ -64,6 +64,16 @@ export declare class OINODbMsSql extends OINODb {
      *
      */
     printSqlSelect(tableName: string, columnNames: string, whereCondition: string, orderCondition: string, limitCondition: string, groupByCondition: string): string;
+    /**
+     * Print SQL select statement with DB specific formatting.
+     *
+     * @param tableName - The name of the table to select from.
+     * @param columns - The columns to be selected.
+     * @param values - The values to be inserted.
+     * @param returnIdFields - the id fields to return if returnIds is true (if supported by the database)
+     *
+     */
+    printSqlInsert(tableName: string, columns: string, values: string, returnIdFields?: string[]): string;
     /**
      * Connect to database.
      *
@@ -74,6 +84,11 @@ export declare class OINODbMsSql extends OINODb {
      *
      */
     validate(): Promise<OINOResult>;
+    /**
+     * Disconnect from database.
+     *
+     */
+    disconnect(): Promise<void>;
     /**
      * Execute a select operation.
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oino-ts/db-mssql",
-  "version": "0.19.0",
+  "version": "0.20.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.19.0",
+    "@oino-ts/db": "0.20.0",
     "mssql": "^11.0.1"
   },
   "devDependencies": {

package/src/OINODbMsSql.ts

@@ -14,7 +14,7 @@ import {ConnectionPool, config} from "mssql";
  * 
  */
 class OINOMsSqlData extends OINODbDataSet {
-    private _recordsets:OINODataRow[][] = [OINODB_EMPTY_ROWS]
+    private _recordsets:any
     private _rows:OINODataRow[] = OINODB_EMPTY_ROWS
 
     private _currentRecordset: number
@@ -30,11 +30,11 @@ class OINOMsSqlData extends OINODbDataSet {
         if (data == null) {
             this.messages.push(OINO_INFO_PREFIX + "SQL result is empty")
 
-        } else if (!(Array.isArray(data) && (data.length>0) && Array.isArray(data[0]))) {
+        } else if (!(Array.isArray(data)) && (data.length > 0)) {
             throw new Error(OINO_ERROR_PREFIX + ": OINOMsSqlData constructor: invalid data!")
 
         } else {
-            this._recordsets = data as OINODataRow[][]
+            this._recordsets = data
             this._rows = this._recordsets[0]
         }
         if (this.isEmpty()) {
@@ -53,7 +53,7 @@ class OINOMsSqlData extends OINODbDataSet {
      *
      */
     isEmpty():boolean {
-        return (this._rows.length == 0)
+        return (this._recordsets.length == 0) || (this._rows == undefined) || (this._rows.length == 0)
     }
 
     /**
@@ -145,15 +145,27 @@ export class OINODbMsSql extends OINODb {
     }
 
     private async _query(sql:string):Promise<OINOMsSqlData> {
-        const request = this._pool.request() // this does not need to be released but the pool will handle it
-        const sql_res = await request.query(sql)
-        const result:OINOMsSqlData = new OINOMsSqlData(sql_res.recordsets)
-        return result
+        try {
+            const request = this._pool.request() // this does not need to be released but the pool will handle it
+            const sql_res = await request.query(sql)
+            // console.log("_query: result=", sql_res.recordsets, sql_res.recordsets?.length) // TODO: remove
+            return new OINOMsSqlData(sql_res.recordsets, [])
+        } catch (e:any) {
+            OINOLog.exception("@oino-ts/db-mssql", "OINODbMsSql", "_query", "exception in SQL query", {message:e.message, stack:e.stack, sql:sql})
+            return new OINOMsSqlData(OINODB_EMPTY_ROWS, []).setError(500, OINO_ERROR_PREFIX + ": Exception in db query: " + e.message, "OINODbMsSql._query") as OINOMsSqlData
+        }
     }
 
     private async _exec(sql:string):Promise<OINOMsSqlData> {
-        const sql_res = await this._pool.request().query(sql);
-        return new OINOMsSqlData(OINODB_EMPTY_ROWS)
+        try {
+            const request = this._pool.request() // this does not need to be released but the pool will handle it
+            const sql_res = await request.query(sql)
+            // console.log("_exec: result=", sql_res.recordsets, sql_res.recordsets?.length) // TODO: remove
+            return new OINOMsSqlData(sql_res.recordsets, [])
+        } catch (e:any) {
+            OINOLog.exception("@oino-ts/db-mssql", "OINODbMsSql", "_exec", "exception in SQL exec", {message:e.message, stack:e.stack, sql:sql})
+            return new OINOMsSqlData(OINODB_EMPTY_ROWS, []).setError(500, OINO_ERROR_PREFIX + ": Exception in db exec: " + e.message, "OINODbMsSql._exec") as OINOMsSqlData
+        }
     }
 
     /**
@@ -289,12 +301,34 @@ export class OINODbMsSql extends OINODb {
         return result;
     }
 
+    /**
+     * Print SQL select statement with DB specific formatting.
+     * 
+     * @param tableName - The name of the table to select from.
+     * @param columns - The columns to be selected.
+     * @param values - The values to be inserted.
+     * @param returnIdFields - the id fields to return if returnIds is true (if supported by the database)
+     * 
+     */
+    printSqlInsert(tableName:string, columns:string, values:string, returnIdFields?:string[]): string {
+        let result = "INSERT INTO " + tableName + " (" + columns + ")"
+        if (returnIdFields) {
+            result += " OUTPUT " + returnIdFields.map(f => "INSERTED."+f ).join(", ") 
+        }
+        result += " VALUES (" + values + ");"
+        return result;
+    }
+
+
     /**
      * Connect to database.
      *
      */
     async connect(): Promise<OINOResult> {
         let result:OINOResult = new OINOResult()
+        if (this.isConnected) {
+            return result
+        }
         try {
             // make sure that any items are correctly URL encoded in the connection string
             await this._pool.connect()
@@ -321,7 +355,7 @@ export class OINODbMsSql extends OINODb {
         OINOBenchmark.startMetric("OINODb", "validate")
         try {
             const sql = this._getValidateSql(this._params.database)
-            const sql_res:OINODbDataSet = await this.sqlSelect(sql)
+            const sql_res:OINODbDataSet = await this._query(sql)
             if (sql_res.isEmpty()) {
                 result.setError(400, "DB returned no rows for select!", "OINODbMsSql.validate")
 
@@ -343,6 +377,23 @@ export class OINODbMsSql extends OINODb {
         return result
     }
 
+    /**
+     * Disconnect from database.
+     *
+     */
+    async disconnect(): Promise<void> {
+        if (this._pool) {
+            try {
+                await this._pool.close()
+
+            } catch (e:any) {
+                OINOLog.exception("@oino-ts/db-mssql", "OINODbMsSql", "disconnect", "exception in disconnect", {message:e.message, stack:e.stack}) 
+            }
+        }
+        this.isConnected = false
+        this.isValidated = false
+    }
+
     /**
      * Execute a select operation.
      * 
@@ -350,15 +401,11 @@ export class OINODbMsSql extends OINODb {
      *
      */
     async sqlSelect(sql:string): Promise<OINODbDataSet> {
-        OINOBenchmark.startMetric("OINODb", "sqlSelect")
-        let result:OINODbDataSet
-        try {
-            result = await this._query(sql)
-
-        } catch (e:any) {
-            OINOLog.exception("@oino-ts/db-mssql", "OINODbMsSql", "sqlSelect", "exception in SQL select", {message:e.message, stack:e.stack})
-            result = new OINOMsSqlData(OINODB_EMPTY_ROWS, [OINO_ERROR_PREFIX + " (sqlSelect): OINODbMsSql.sqlSelect exception in _db.query: " + e.message])
+        if (!this.isValidated) {
+            throw new Error(OINO_ERROR_PREFIX + ": Database connection not validated!")
         }
+        OINOBenchmark.startMetric("OINODb", "sqlSelect")
+        let result:OINODbDataSet = await this._query(sql)
         OINOBenchmark.endMetric("OINODb", "sqlSelect")
         return result
     }
@@ -370,15 +417,11 @@ export class OINODbMsSql extends OINODb {
      *
      */
     async sqlExec(sql:string): Promise<OINODbDataSet> {
-        OINOBenchmark.startMetric("OINODb", "sqlExec")
-        let result:OINODbDataSet
-        try {
-            result = await this._exec(sql)
-
-        } catch (e:any) {
-            OINOLog.exception("@oino-ts/db-mssql", "OINODbMsSql", "sqlExec", "exception in SQL exec", {message:e.message, stack:e.stack})
-            result = new OINOMsSqlData(OINODB_EMPTY_ROWS, [OINO_ERROR_PREFIX + " (sqlExec): exception in _db.exec [" + e.message + "]"])
+        if (!this.isValidated) {
+            throw new Error(OINO_ERROR_PREFIX + ": Database connection not validated!")
         }
+        OINOBenchmark.startMetric("OINODb", "sqlExec")
+        let result:OINODbDataSet = await this._exec(sql)
         OINOBenchmark.endMetric("OINODb", "sqlExec")
         return result
     }