@oino-ts/db-mssql 0.0.16

package/dist/esm/OINODbMsSql.js

@@ -0,0 +1,373 @@
+/*
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * 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 { ConnectionPool } from "mssql";
+/**
+ * Implmentation of OINODbDataSet for MariaDb.
+ *
+ */
+class OINOMsSqlData extends OINODbDataSet {
+    _recordsets = [OINODB_EMPTY_ROWS];
+    _rows = OINODB_EMPTY_ROWS;
+    _currentRecordset;
+    _currentRow;
+    _eof;
+    /**
+     * OINOMsSqlData constructor
+     * @param params database parameters
+     */
+    constructor(data, messages = []) {
+        super(data, messages);
+        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]))) {
+            throw new Error(OINO_ERROR_PREFIX + ": OINOMsSqlData constructor: invalid data!");
+        }
+        else {
+            this._recordsets = data;
+            this._rows = this._recordsets[0];
+        }
+        // OINOLog.debug("OINOMsSqlData.constructor", {_rows:this._rows})
+        if (this.isEmpty()) {
+            this._currentRecordset = -1;
+            this._currentRow = -1;
+            this._eof = true;
+        }
+        else {
+            this._currentRecordset = 0;
+            this._currentRow = 0;
+            this._eof = false;
+        }
+    }
+    /**
+     * Is data set empty.
+     *
+     */
+    isEmpty() {
+        return (this._rows.length == 0);
+    }
+    /**
+     * Is there no more content, i.e. either dataset is empty or we have moved beyond last line
+     *
+     */
+    isEof() {
+        return (this._eof);
+    }
+    /**
+     * Attempts to moves dataset to the next row, possibly waiting for more data to become available. Returns !isEof().
+     *
+     */
+    async next() {
+        // OINOLog.debug("OINODbDataSet.next", {currentRow:this._currentRow, length:this.sqlResult.data.length})
+        if (this._currentRow < this._rows.length - 1) {
+            this._currentRow = this._currentRow + 1;
+        }
+        else if (this._currentRecordset < this._recordsets.length - 1) {
+            this._currentRecordset = this._currentRecordset + 1;
+            this._rows = this._recordsets[this._currentRecordset];
+            this._currentRow = 0;
+        }
+        else {
+            this._eof = true;
+        }
+        return Promise.resolve(!this._eof);
+    }
+    /**
+     * Gets current row of data.
+     *
+     */
+    getRow() {
+        if ((this._currentRow >= 0) && (this._currentRow < this._rows.length)) {
+            return this._rows[this._currentRow];
+        }
+        else {
+            return OINODB_EMPTY_ROW;
+        }
+    }
+}
+/**
+ * Implementation of MariaDb/MySql-database.
+ *
+ */
+export class OINODbMsSql extends OINODb {
+    _pool;
+    /**
+     * Constructor of `OINODbMsSql`
+     * @param params database parameters
+     */
+    constructor(params) {
+        super(params);
+        // OINOLog.debug("OINODbMsSql.constructor", {params:params})
+        if (this._params.type !== "OINODbMsSql") {
+            throw new Error(OINO_ERROR_PREFIX + ": Not OINODbMsSql-type: " + this._params.type);
+        }
+        this._pool = new ConnectionPool({
+            user: params.user,
+            password: params.password,
+            server: params.url,
+            port: params.port,
+            database: params.database,
+            arrayRowMode: true,
+            options: {
+                encrypt: true, // Use encryption for Azure SQL Database
+                rowCollectionOnRequestCompletion: false,
+                rowCollectionOnDone: false,
+                trustServerCertificate: true // Change to false for production
+            }
+        });
+        //this._pool = new ConnectionPool({connectionString: "Server=localhost,1433;Database=database;User Id=username;Password=" + params.password + ";Encrypt=true"})
+        this._pool.on("error", (conn) => {
+            // console.log("OINODbMsSql error", conn)
+        });
+        this._pool.on("debug", (event) => {
+            // console.log("OINODbMsSql debug",event)
+        });
+    }
+    async _query(sql) {
+        // OINOLog.debug("OINODbMsSql._query", {sql:sql})
+        try {
+            const sql_res = await this._pool.request().query(sql);
+            // console.log("OINODbMsSql._query result:" + JSON.stringify(sql_res.recordsets))
+            const result = new OINOMsSqlData(sql_res.recordsets);
+            return Promise.resolve(result);
+        }
+        catch (err) {
+            OINOLog.error("OINODbMsSql._query exception", { err: err });
+            throw err;
+        }
+        finally {
+            // console.log("OINODbMsSql._query finally");
+        }
+        // OINOLog.debug("OINODbMsSql._query", {result:query_result})
+    }
+    async _exec(sql) {
+        // OINOLog.debug("OINODbMsSql._exec", {sql:sql})
+        try {
+            const sql_res = await this._pool.request().query(sql);
+            // console.log("OINODbMsSql._exec result", sql_res); 
+            return Promise.resolve(new OINOMsSqlData([[]]));
+        }
+        catch (err) {
+            OINOLog.error("OINODbMsSql._exec exception", { err: err });
+            throw err;
+        }
+        finally {
+        }
+        // OINOLog.debug("OINODbMsSql._exec", {result:query_result})
+    }
+    /**
+     * Print a table name using database specific SQL escaping.
+     *
+     * @param sqlTable name of the table
+     *
+     */
+    printSqlTablename(sqlTable) {
+        return "[" + sqlTable + "]";
+    }
+    /**
+     * Print a column name with correct SQL escaping.
+     *
+     * @param sqlColumn name of the column
+     *
+     */
+    printSqlColumnname(sqlColumn) {
+        return "[" + sqlColumn + "]";
+    }
+    /**
+     * Print a single data value from serialization using the context of the native data
+     * type with the correct SQL escaping.
+     *
+     * @param cellValue data from sql results
+     * @param sqlType native type name for table column
+     *
+     */
+    printCellAsSqlValue(cellValue, sqlType) {
+        // OINOLog.debug("OINODbMsSql.printCellAsSqlValue", {cellValue:cellValue, sqlType:sqlType})
+        if (cellValue === null) {
+            return "NULL";
+        }
+        else if (cellValue === undefined) {
+            return "UNDEFINED";
+        }
+        else if ((sqlType == "int") || (sqlType == "smallint") || (sqlType == "float")) {
+            return cellValue.toString();
+        }
+        else if ((sqlType == "longblob") || (sqlType == "binary") || (sqlType == "varbinary")) {
+            if (cellValue instanceof Buffer) {
+                return "0x" + cellValue.toString("hex") + "";
+            }
+            else if (cellValue instanceof Uint8Array) {
+                return "0x" + Buffer.from(cellValue).toString("hex") + "";
+            }
+            else {
+                return "'" + cellValue?.toString() + "'";
+            }
+        }
+        else if (((sqlType == "date") || (sqlType == "datetime") || (sqlType == "timestamp")) && (cellValue instanceof Date)) {
+            return "'" + cellValue.toISOString().substring(0, 23) + "'";
+        }
+        else {
+            // return "'" + cellValue?.toString().replaceAll("\\", "\\\\").replaceAll("\'", "''").replaceAll("\r", "\\r").replaceAll("\n", "\\n").replaceAll("\t", "\\t") + "'"
+            return "'" + cellValue?.toString().replaceAll("\'", "''") + "'";
+        }
+    }
+    /**
+     * Parse a single SQL result value for serialization using the context of the native data
+     * type.
+     *
+     * @param sqlValue data from serialization
+     * @param sqlType native type name for table column
+     *
+     */
+    parseSqlValueAsCell(sqlValue, sqlType) {
+        // OINOLog.debug("OINODbMsSql.parseSqlValueAsCell", {sqlValue:sqlValue, sqlType:sqlType})
+        if ((sqlValue === null) || (sqlValue == "NULL")) {
+            return null;
+        }
+        else if (sqlValue === undefined) {
+            return undefined;
+        }
+        else if (((sqlType == "date")) && (typeof (sqlValue) == "string")) {
+            return new Date(sqlValue);
+        }
+        else {
+            return sqlValue;
+        }
+    }
+    /**
+     * Connect to database.
+     *
+     */
+    async connect() {
+        try {
+            // make sure that any items are correctly URL encoded in the connection string
+            await this._pool.connect();
+            // OINOLog.info("OINODbMsSql.connect: Connected to database server.")
+            await this._pool.request().query("SELECT 1 as test");
+            return Promise.resolve(true);
+        }
+        catch (err) {
+            // ... error checks
+            throw new Error(OINO_ERROR_PREFIX + ": Error connecting to OINODbMsSql server: " + err);
+        }
+    }
+    /**
+     * Execute a select operation.
+     *
+     * @param sql SQL statement.
+     *
+     */
+    async sqlSelect(sql) {
+        OINOBenchmark.start("OINODb", "sqlSelect");
+        let result;
+        try {
+            // OINOLog.debug("OINODbMsSql.sqlSelect", {sql_rows:sql_rows})
+            result = await this._query(sql);
+        }
+        catch (e) {
+            result = new OINOMsSqlData([[]], [OINO_ERROR_PREFIX + " (sqlSelect): OINODbMsSql.sqlSelect exception in _db.query: " + e.message]);
+        }
+        OINOBenchmark.end("OINODb", "sqlSelect");
+        return result;
+    }
+    /**
+     * Execute other sql operations.
+     *
+     * @param sql SQL statement.
+     *
+     */
+    async sqlExec(sql) {
+        OINOBenchmark.start("OINODb", "sqlExec");
+        let result;
+        try {
+            result = await this._exec(sql);
+        }
+        catch (e) {
+            result = new OINOMsSqlData([[]], [OINO_ERROR_PREFIX + " (sqlExec): exception in _db.exec [" + e.message + "]"]);
+        }
+        OINOBenchmark.end("OINODb", "sqlExec");
+        return result;
+    }
+    _getSchemaSql(dbName, tableName) {
+        const sql = 
+        //      0              1              2            3                           4                    5                          6                       7                                                                                                                 8
+        `SELECT C.COLUMN_NAME, C.IS_NULLABLE, C.DATA_TYPE, C.CHARACTER_MAXIMUM_LENGTH, C.NUMERIC_PRECISION, C.NUMERIC_PRECISION_RADIX, CONST.CONSTRAINT_TYPES, COLUMNPROPERTY(OBJECT_ID(C.TABLE_SCHEMA + '.' + C.TABLE_NAME), C.COLUMN_NAME, 'IsIdentity') AS IS_AUTO_INCREMENT, COLUMNPROPERTY(OBJECT_ID(C.TABLE_SCHEMA + '.' + C.TABLE_NAME), C.COLUMN_NAME, 'IsComputed') AS IS_COMPUTED
+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}' AND C.TABLE_NAME = '${tableName}';`;
+        return sql;
+    }
+    /**
+     * Initialize a data model by getting the SQL schema and populating OINODbDataFields of
+     * the model.
+     *
+     * @param api api which data model to initialize.
+     *
+     */
+    async initializeApiDatamodel(api) {
+        //"SELECT COLUMN_NAME, IS_NULLABLE, DATA_TYPE, CHARACTER_MAXIMUM_LENGTH, NUMERIC_PRECISION, NUMERIC_PRECISION_RADIX 
+        const res = await this.sqlSelect(this._getSchemaSql(this._params.database, api.params.tableName));
+        while (!res.isEof()) {
+            const row = res.getRow();
+            // OINOLog.debug("OINODbMsSql.initializeApiDatamodel", { description:row })
+            const field_name = row[0]?.toString() || "";
+            const sql_type = row[2] || "";
+            const char_field_length = row[3] || 0;
+            const numeric_field_length1 = row[4] || 0;
+            const numeric_field_length2 = row[5] || 0;
+            const constraint_types = row[6] || "";
+            const field_params = {
+                isPrimaryKey: constraint_types.indexOf("PRIMARY KEY") >= 0,
+                isAutoInc: row[7] == 1,
+                isNotNull: row[1] == "NO"
+            };
+            if (((api.params.excludeFieldPrefix) && field_name.startsWith(api.params.excludeFieldPrefix)) || ((api.params.excludeFields) && (api.params.excludeFields.indexOf(field_name) < 0))) {
+                OINOLog.info("OINODbMsSql.initializeApiDatamodel: field excluded in API parameters.", { field: field_name });
+            }
+            else {
+                // OINOLog.debug("OINODbMsSql.initializeApiDatamodel: next field ", {field_name: field_name, sql_type:sql_type, char_field_length:char_field_length, numeric_field_length1:numeric_field_length1, numeric_field_length2:numeric_field_length2, field_params:field_params })
+                if ((sql_type == "tinyint") || (sql_type == "smallint") || (sql_type == "int") || (sql_type == "bigint") || (sql_type == "float") || (sql_type == "real")) {
+                    api.datamodel.addField(new OINONumberDataField(this, field_name, sql_type, field_params));
+                }
+                else if ((sql_type == "date") || (sql_type == "datetime") || (sql_type == "datetime2")) {
+                    if (api.params.useDatesAsString) {
+                        api.datamodel.addField(new OINOStringDataField(this, field_name, sql_type, field_params, 0));
+                    }
+                    else {
+                        api.datamodel.addField(new OINODatetimeDataField(this, field_name, sql_type, field_params));
+                    }
+                }
+                else if ((sql_type == "ntext") || (sql_type == "nchar") || (sql_type == "nvarchar") || (sql_type == "text") || (sql_type == "char") || (sql_type == "varchar")) {
+                    api.datamodel.addField(new OINOStringDataField(this, field_name, sql_type, field_params, char_field_length));
+                }
+                else if ((sql_type == "binary") || (sql_type == "varbinary") || (sql_type == "image")) {
+                    api.datamodel.addField(new OINOBlobDataField(this, field_name, sql_type, field_params, char_field_length));
+                }
+                else if ((sql_type == "numeric") || (sql_type == "decimal") || (sql_type == "money")) {
+                    api.datamodel.addField(new OINOStringDataField(this, field_name, sql_type, field_params, numeric_field_length1 + numeric_field_length2 + 1));
+                }
+                else if ((sql_type == "bit")) {
+                    api.datamodel.addField(new OINOBooleanDataField(this, field_name, sql_type, field_params));
+                }
+                else {
+                    OINOLog.info("OINODbMsSql.initializeApiDatamodel: unrecognized field type treated as string", { field_name: field_name, sql_type: sql_type, char_length: char_field_length, numeric_field_length1: numeric_field_length1, numeric_field_length2: numeric_field_length2, field_params: field_params });
+                    api.datamodel.addField(new OINOStringDataField(this, field_name, sql_type, field_params, 0));
+                }
+            }
+            await res.next();
+        }
+        OINOLog.debug("OINODbMsSql.initializeDatasetModel:\n" + api.datamodel.printDebug("\n"));
+        return Promise.resolve();
+    }
+}

package/dist/esm/index.js

@@ -0,0 +1 @@
+export { OINODbMsSql } from "./OINODbMsSql.js";

package/dist/types/OINODbMsSql.d.ts

@@ -0,0 +1,75 @@
+import { OINODb, OINODbParams, OINODbDataSet, OINODbApi, OINODataCell } from "@oino-ts/db";
+/**
+ * Implementation of MariaDb/MySql-database.
+ *
+ */
+export declare class OINODbMsSql extends OINODb {
+    private _pool;
+    /**
+     * Constructor of `OINODbMsSql`
+     * @param params database parameters
+     */
+    constructor(params: OINODbParams);
+    private _query;
+    private _exec;
+    /**
+     * Print a table name using database specific SQL escaping.
+     *
+     * @param sqlTable name of the table
+     *
+     */
+    printSqlTablename(sqlTable: string): string;
+    /**
+     * Print a column name with correct SQL escaping.
+     *
+     * @param sqlColumn name of the column
+     *
+     */
+    printSqlColumnname(sqlColumn: string): string;
+    /**
+     * Print a single data value from serialization using the context of the native data
+     * type with the correct SQL escaping.
+     *
+     * @param cellValue data from sql results
+     * @param sqlType native type name for table column
+     *
+     */
+    printCellAsSqlValue(cellValue: OINODataCell, sqlType: string): string;
+    /**
+     * Parse a single SQL result value for serialization using the context of the native data
+     * type.
+     *
+     * @param sqlValue data from serialization
+     * @param sqlType native type name for table column
+     *
+     */
+    parseSqlValueAsCell(sqlValue: OINODataCell, sqlType: string): OINODataCell;
+    /**
+     * Connect to database.
+     *
+     */
+    connect(): Promise<boolean>;
+    /**
+     * Execute a select operation.
+     *
+     * @param sql SQL statement.
+     *
+     */
+    sqlSelect(sql: string): Promise<OINODbDataSet>;
+    /**
+     * Execute other sql operations.
+     *
+     * @param sql SQL statement.
+     *
+     */
+    sqlExec(sql: string): Promise<OINODbDataSet>;
+    private _getSchemaSql;
+    /**
+     * Initialize a data model by getting the SQL schema and populating OINODbDataFields of
+     * the model.
+     *
+     * @param api api which data model to initialize.
+     *
+     */
+    initializeApiDatamodel(api: OINODbApi): Promise<void>;
+}

package/dist/types/index.d.ts

@@ -0,0 +1 @@
+export { OINODbMsSql } from "./OINODbMsSql.js";

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@oino-ts/db-mssql",
+  "version": "0.0.16",
+  "description": "OINO TS package for using Microsoft Sql databases.",
+  "author": "Matias Kiviniemi (pragmatta)",
+  "license": "MPL-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/pragmatta/oino-ts.git"
+  },
+  "keywords": [
+    "sql",
+    "database",
+    "rest-api",
+    "typescript",
+    "library",
+    "mssql",
+    "sql-server",
+    "azure-sql"
+  ],
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.js",
+  "types": "./dist/types/index.d.ts",
+  "dependencies": {
+    "@oino-ts/db": "latest",
+    "mssql": "^11.0.1"
+  },
+  "devDependencies": {
+    "@types/bun": "latest",
+    "@types/mssql": "^9.1.5",
+    "@types/node": "^20.12.7"
+  },
+  "files": [
+    "src/*.ts",
+    "dist/cjs/*.js",
+    "dist/esm/*.js",
+    "dist/types/*.d.ts"
+  ]
+}