@oino-ts/db-mariadb 0.0.11

package/dist/esm/OINODbMariadb.js

@@ -0,0 +1,358 @@
+/*
+ * 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 mariadb from "mariadb";
+/**
+ * Implmentation of OINODbDataSet for MariaDb.
+ *
+ */
+class OINOMariadbData extends OINODbDataSet {
+    _rows = OINODB_EMPTY_ROWS;
+    /**
+     * OINOMariadbData 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)) {
+            this._rows = data;
+        }
+        // OINOLog.debug("OINOMariadbData.constructor", {_rows:this._rows})
+        if (this.isEmpty()) {
+            this._currentRow = -1;
+            this._eof = true;
+        }
+        else {
+            this._currentRow = 0;
+            this._eof = false;
+        }
+    }
+    _currentRow;
+    _eof;
+    isEmpty() {
+        return (this._rows.length == 0);
+    }
+    // EOF means "there is no more content", i.e. either dataset is empty or we have moved beyond last line
+    isEof() {
+        return (this._eof);
+    }
+    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 {
+            this._eof = true;
+        }
+        return !this._eof;
+    }
+    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 OINODbMariadb extends OINODb {
+    static _fieldLengthRegex = /([^\(\)]+)(\s?\((\d+)\s?\,?\s?(\d*)?\))?/i;
+    static _exceptionMessageRegex = /\(([^\)]*)\) (.*)\nsql\:(.*)?/i;
+    static _tableSchemaSql = `SHOW COLUMNS from `;
+    _pool;
+    /**
+     * Constructor of `OINODbMariadb`
+     * @param params database parameters
+     */
+    constructor(params) {
+        super(params);
+        // OINOLog.debug("OINODbMariadb.constructor", {params:params})
+        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.on("acquire", (conn: mariadb.Connection) => {
+        //     OINOLog.info("OINODbMariadb acquire", {conn:conn})
+        // })
+        // this._pool.on("connection", (conn: mariadb.Connection) => {
+        //     OINOLog.info("OINODbMariadb connection", {conn:conn})
+        // })
+        // this._pool.on("release", (conn: mariadb.Connection) => {
+        //     OINOLog.info("OINODbMariadb release", {conn:conn})
+        // })
+        // this._pool.on("enqueue", () => {
+        //     OINOLog.info("OINODbMariadb enqueue", {})
+        // })
+    }
+    _parseFieldLength(fieldLengthStr) {
+        let result = parseInt(fieldLengthStr);
+        if (Number.isNaN(result)) {
+            result = 0;
+        }
+        return result;
+    }
+    async _query(sql) {
+        // OINOLog.debug("OINODbMariadb._query", {sql:sql})
+        let connection = null;
+        try {
+            connection = await this._pool.getConnection();
+            const result = await connection.query(sql);
+            // console.log("OINODbMariadb._query rows="+result)
+            return Promise.resolve(result);
+        }
+        catch (err) {
+            // console.log("OINODbMariadb._query err=" + err); 
+            throw err;
+        }
+        finally {
+            if (connection) {
+                await connection.end();
+            }
+        }
+        // OINOLog.debug("OINODbMariadb._query", {result:query_result})
+    }
+    async _exec(sql) {
+        // OINOLog.debug("OINODbMariadb._exec", {sql:sql})
+        let connection = null;
+        try {
+            connection = await this._pool.getConnection();
+            const result = await connection.query(sql);
+            // console.log(result); 
+            return Promise.resolve(result);
+        }
+        catch (err) {
+            const msg_parts = err.message.match(OINODbMariadb._exceptionMessageRegex) || [];
+            // 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 {
+            if (connection) {
+                await connection.end();
+            }
+        }
+        // OINOLog.debug("OINODbMariadb._query", {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("OINODbMariadb.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")) {
+            return "\"" + cellValue + "\"";
+        }
+        else if (((sqlType == "date") || (sqlType == "datetime") || (sqlType == "timestamp")) && (cellValue instanceof Date)) {
+            return "\"" + cellValue.toISOString().replace('T', ' ').substring(0, 23) + "\"";
+        }
+        else if ((sqlType == "bit")) {
+            if ((cellValue === false) || (cellValue == null) || (cellValue == "") || (cellValue.toString().toLowerCase() == "false") || (cellValue == "0")) {
+                return "b'0'";
+            }
+            else if ((cellValue === true) || (cellValue.toString().toLowerCase() == "true")) {
+                return "b'1'";
+            }
+            else {
+                return "b'" + cellValue.toString() + "'"; // rest is assumed to be a valid bitstring
+            }
+        }
+        else {
+            return "\"" + cellValue?.toString().replaceAll("\\", "\\\\").replaceAll("\"", "\\\"").replaceAll("\r", "\\r").replaceAll("\n", "\\n").replaceAll("\t", "\\t") + "\"";
+        }
+    }
+    /**
+     * 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("OINODbMariadb.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 if ((sqlType == "bit") && (sqlValue instanceof Buffer)) { // mariadb returns a buffer for bit-fields
+            const buf = sqlValue;
+            let result = "";
+            for (let i = 0; i < buf.length; i++) {
+                result += buf[i].toString(2).padStart(8, '0');
+            }
+            return result;
+        }
+        else {
+            return sqlValue;
+        }
+    }
+    /**
+     * Connect to database.
+     *
+     */
+    async connect() {
+        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);
+        }
+        catch (err) {
+            // ... error checks
+            throw new Error(OINO_ERROR_PREFIX + ": Error connecting to Postgresql server: " + err);
+        }
+    }
+    /**
+     * Execute a select operation.
+     *
+     * @param sql SQL statement.
+     *
+     */
+    async sqlSelect(sql) {
+        OINOBenchmark.start("sqlSelect");
+        let result;
+        try {
+            const sql_res = await this._query(sql);
+            // OINOLog.debug("OINODbMariadb.sqlSelect", {sql_res:sql_res})
+            result = new OINOMariadbData(sql_res, []);
+        }
+        catch (e) {
+            result = new OINOMariadbData([[]], [OINO_ERROR_PREFIX + " (sqlSelect): OINODbMariadb.sqlSelect exception in _db.query: " + e.message]);
+        }
+        OINOBenchmark.end("sqlSelect");
+        return result;
+    }
+    /**
+     * Execute other sql operations.
+     *
+     * @param sql SQL statement.
+     *
+     */
+    async sqlExec(sql) {
+        OINOBenchmark.start("sqlExec");
+        let result;
+        try {
+            const sql_res = await this._exec(sql);
+            // OINOLog.debug("OINODbMariadb.sqlExec", {sql_res:sql_res})
+            result = new OINOMariadbData(sql_res, []);
+        }
+        catch (e) {
+            result = new OINOMariadbData([[]], [OINO_ERROR_PREFIX + " (sqlExec): exception in _db.exec [" + e.message + "]"]);
+        }
+        OINOBenchmark.end("sqlExec");
+        return result;
+    }
+    /**
+     * 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) {
+        const res = await this.sqlSelect(OINODbMariadb._tableSchemaSql + this._params.database + "." + api.params.tableName + ";");
+        while (!res.isEof()) {
+            const row = res.getRow();
+            // OINOLog.debug("OINODbMariadb.initializeApiDatamodel", { description:row })
+            const field_name = row[0]?.toString() || "";
+            const field_matches = OINODbMariadb._fieldLengthRegex.exec(row[1]?.toString() || "") || [];
+            // OINOLog.debug("OINODbMariadb.initializeApiDatamodel", { field_matches:field_matches })
+            const sql_type = field_matches[1] || "";
+            const field_length1 = this._parseFieldLength(field_matches[3] || "0");
+            const field_length2 = this._parseFieldLength(field_matches[4] || "0");
+            const extra = row[5]?.toString() || "";
+            const field_params = {
+                isPrimaryKey: row[3] == "PRI",
+                isAutoInc: extra.indexOf('auto_increment') >= 0,
+                isNotNull: row[2] == "NO"
+            };
+            if (((api.params.excludeFieldPrefix) && field_name.startsWith(api.params.excludeFieldPrefix)) || ((api.params.excludeFields) && (api.params.excludeFields.indexOf(field_name) < 0))) {
+                OINOLog.info("OINODbMariadb.initializeApiDatamodel: field excluded in API parameters.", { field: field_name });
+            }
+            else {
+                // OINOLog.debug("OINODbMariadb.initializeApiDatamodel: next field ", {field_name: field_name, sql_type:sql_type, field_length1:field_length1, field_length2:field_length2, field_params:field_params })
+                if ((sql_type == "int") || (sql_type == "smallint") || (sql_type == "float") || (sql_type == "double")) {
+                    api.datamodel.addField(new OINONumberDataField(this, field_name, sql_type, field_params));
+                }
+                else if ((sql_type == "date") || (sql_type == "datetime") || (sql_type == "timestamp")) {
+                    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 == "char") || (sql_type == "varchar") || (sql_type == "tinytext") || (sql_type == "tinytext") || (sql_type == "mediumtext") || (sql_type == "longtext")) {
+                    api.datamodel.addField(new OINOStringDataField(this, field_name, sql_type, field_params, field_length1));
+                }
+                else if ((sql_type == "longblob") || (sql_type == "binary") || (sql_type == "varbinary")) {
+                    api.datamodel.addField(new OINOBlobDataField(this, field_name, sql_type, field_params, field_length1));
+                }
+                else if ((sql_type == "decimal")) {
+                    api.datamodel.addField(new OINOStringDataField(this, field_name, sql_type, field_params, field_length1 + field_length2 + 1));
+                }
+                else if ((sql_type == "bit")) {
+                    if (field_length1 == 1) {
+                        api.datamodel.addField(new OINOBooleanDataField(this, field_name, sql_type, field_params));
+                    }
+                    else {
+                        api.datamodel.addField(new OINOStringDataField(this, field_name, sql_type, field_params, field_length1 * 8));
+                    }
+                }
+                else {
+                    OINOLog.info("OINODbMariadb.initializeApiDatamodel: unrecognized field type treated as string", { field_name: field_name, sql_type: sql_type, field_length1: field_length1, field_length2: field_length2, field_params: field_params });
+                    api.datamodel.addField(new OINOStringDataField(this, field_name, sql_type, field_params, 0));
+                }
+            }
+            res.next();
+        }
+        OINOLog.debug("OINODbMariadb.initializeDatasetModel:\n" + api.datamodel.printDebug("\n"));
+        return Promise.resolve();
+    }
+}

package/dist/esm/index.js

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

package/dist/types/OINODbMariadb.d.ts

@@ -0,0 +1,78 @@
+import { OINODb, OINODbParams, OINODbDataSet, OINODbApi, OINODataCell } from "@oino-ts/db";
+/**
+ * Implementation of MariaDb/MySql-database.
+ *
+ */
+export declare class OINODbMariadb extends OINODb {
+    private static _fieldLengthRegex;
+    private static _exceptionMessageRegex;
+    private static _tableSchemaSql;
+    private _pool;
+    /**
+     * Constructor of `OINODbMariadb`
+     * @param params database parameters
+     */
+    constructor(params: OINODbParams);
+    private _parseFieldLength;
+    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>;
+    /**
+     * 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 { OINODbMariadb } from "./OINODbMariadb.js";

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@oino-ts/db-mariadb",
+  "version": "0.0.11",
+  "description": "OINO TS package for using Mariadb 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",
+    "mariadb",
+    "mysql"
+  ],
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.js",
+  "types": "./dist/types/index.d.ts",
+  "dependencies": {
+    "@oino-ts/db": "^0.0.11",
+    "mariadb": "3.2.3"
+  },
+  "devDependencies": {
+    "@types/node": "^20.12.7",
+    "@types/bun": "latest"
+  },
+  "files": [
+    "src/*.ts",
+    "dist/cjs/*.js",
+    "dist/esm/*.js",
+    "dist/types/*.d.ts"
+  ]
+}