@oino-ts/db-mariadb 0.3.3 → 0.4.0

package/dist/cjs/OINODbMariadb.js

@@ -222,9 +222,18 @@ class OINODbMariadb extends db_1.OINODb {
             }
         }
         else {
-            return "\"" + cellValue?.toString().replaceAll("\\", "\\\\").replaceAll("\"", "\\\"").replaceAll("\r", "\\r").replaceAll("\n", "\\n").replaceAll("\t", "\\t") + "\"";
+            return this.printSqlString(cellValue?.toString());
         }
     }
+    /**
+     * Print a single string value as valid sql literal
+     *
+     * @param sqlString string value
+     *
+     */
+    printSqlString(sqlString) {
+        return "\"" + sqlString.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.
@@ -314,17 +323,17 @@ class OINODbMariadb extends db_1.OINODb {
         return result;
     }
     _getSchemaSql(dbName, tableName) {
-        const sql = `SELECT
-    c.COLUMN_NAME,
-    c.COLUMN_TYPE,
-    c.IS_NULLABLE,
-    c.COLUMN_KEY,
-    c.COLUMN_DEFAULT,
-    c.EXTRA,
-    KCU.CONSTRAINT_NAME AS ForeignKeyName 
-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}' AND C.TABLE_NAME = '${tableName}'
+        const sql = `SELECT
+    c.COLUMN_NAME,
+    c.COLUMN_TYPE,
+    c.IS_NULLABLE,
+    c.COLUMN_KEY,
+    c.COLUMN_DEFAULT,
+    c.EXTRA,
+    KCU.CONSTRAINT_NAME AS ForeignKeyName 
+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}' AND C.TABLE_NAME = '${tableName}'
 ORDER BY C.ORDINAL_POSITION;`;
         return sql;
     }

package/dist/esm/OINODbMariadb.js

@@ -219,9 +219,18 @@ export class OINODbMariadb extends OINODb {
             }
         }
         else {
-            return "\"" + cellValue?.toString().replaceAll("\\", "\\\\").replaceAll("\"", "\\\"").replaceAll("\r", "\\r").replaceAll("\n", "\\n").replaceAll("\t", "\\t") + "\"";
+            return this.printSqlString(cellValue?.toString());
         }
     }
+    /**
+     * Print a single string value as valid sql literal
+     *
+     * @param sqlString string value
+     *
+     */
+    printSqlString(sqlString) {
+        return "\"" + sqlString.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.
@@ -311,17 +320,17 @@ export class OINODbMariadb extends OINODb {
         return result;
     }
     _getSchemaSql(dbName, tableName) {
-        const sql = `SELECT
-    c.COLUMN_NAME,
-    c.COLUMN_TYPE,
-    c.IS_NULLABLE,
-    c.COLUMN_KEY,
-    c.COLUMN_DEFAULT,
-    c.EXTRA,
-    KCU.CONSTRAINT_NAME AS ForeignKeyName 
-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}' AND C.TABLE_NAME = '${tableName}'
+        const sql = `SELECT
+    c.COLUMN_NAME,
+    c.COLUMN_TYPE,
+    c.IS_NULLABLE,
+    c.COLUMN_KEY,
+    c.COLUMN_DEFAULT,
+    c.EXTRA,
+    KCU.CONSTRAINT_NAME AS ForeignKeyName 
+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}' AND C.TABLE_NAME = '${tableName}'
 ORDER BY C.ORDINAL_POSITION;`;
         return sql;
     }

package/dist/types/OINODbMariadb.d.ts

@@ -38,6 +38,13 @@ export declare class OINODbMariadb extends OINODb {
      *
      */
     printCellAsSqlValue(cellValue: OINODataCell, sqlType: string): string;
+    /**
+     * Print a single string value as valid sql literal
+     *
+     * @param sqlString string value
+     *
+     */
+    printSqlString(sqlString: string): string;
     /**
      * Parse a single SQL result value for serialization using the context of the native data
      * type.

package/package.json

@@ -1,37 +1,37 @@
-{
-  "name": "@oino-ts/db-mariadb",
-  "version": "0.3.3",
-  "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.3.3",
-    "mariadb": "^3.2.3"
-  },
-  "devDependencies": {
-    "@types/node": "^20.12.7",
-    "@types/bun": "^1.1.14"
-  },
-  "files": [
-    "src/*.ts",
-    "dist/cjs/*.js",
-    "dist/esm/*.js",
-    "dist/types/*.d.ts"
-  ]
-}
+{
+  "name": "@oino-ts/db-mariadb",
+  "version": "0.4.0",
+  "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.4.0",
+    "mariadb": "^3.2.3"
+  },
+  "devDependencies": {
+    "@types/node": "^20.12.7",
+    "@types/bun": "^1.1.14"
+  },
+  "files": [
+    "src/*.ts",
+    "dist/cjs/*.js",
+    "dist/esm/*.js",
+    "dist/types/*.d.ts"
+  ]
+}

package/src/OINODbMariadb.ts

@@ -1,422 +1,433 @@
-/*
- * 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, 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 mariadb from "mariadb";
-
-/**
- * Implmentation of OINODbDataSet for MariaDb.
- * 
- */
-class OINOMariadbData extends OINODbDataSet {
-    private _rows:OINODataRow[] = OINODB_EMPTY_ROWS
-    
-    /**
-     * OINOMariadbData constructor
-     * @param params database parameters
-     */
-    constructor(data: any, messages:string[]=[]) {
-        super(data, messages)
-
-        if (data == null) {
-            this.messages.push(OINO_INFO_PREFIX + "SQL result is empty")
-
-        } else if (Array.isArray(data)) {
-            this._rows = data as OINODataRow[]
-
-        }
-        // OINOLog.debug("OINOMariadbData.constructor", {_rows:this._rows})
-        if (this.isEmpty()) {
-            this._currentRow = -1
-            this._eof = true
-        } else {
-            this._currentRow = 0
-            this._eof = false
-        }
-    }
-    private _currentRow: number
-    private _eof: boolean
-    
-    /**
-     * Is data set empty.
-     *
-     */
-    isEmpty():boolean {
-        return (this._rows.length == 0)
-    }
-
-    /**
-     * Is there no more content, i.e. either dataset is empty or we have moved beyond last line
-     *
-     */
-    isEof():boolean {
-        return (this._eof)
-    }
-
-    /**
-     * Attempts to moves dataset to the next row, possibly waiting for more data to become available. Returns !isEof().
-     *
-     */
-    async next():Promise<boolean> {
-        // 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 Promise.resolve(!this._eof)
-    }
-
-    /**
-     * Gets current row of data.
-     *
-     */
-    getRow(): OINODataRow {
-        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 {
-    
-    private static _fieldLengthRegex = /([^\(\)]+)(\s?\((\d+)\s?\,?\s?(\d*)?\))?/i
-    private static _exceptionMessageRegex = /\(([^\)]*)\) (.*)\nsql\:(.*)?/i
-    
-    private _pool:mariadb.Pool
-
-    /**
-     * Constructor of `OINODbMariadb` 
-     * @param params database parameters
-     */
-    constructor(params:OINODbParams) {
-        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", {})
-        // })
-    }
-
-    private _parseFieldLength(fieldLengthStr:string):number {
-        let result:number = parseInt(fieldLengthStr)
-        if (Number.isNaN(result)) {
-            result = 0
-        }
-        return result
-    }
-
-    private async _query(sql:string):Promise<OINODataRow[]> {
-        // OINOLog.debug("OINODbMariadb._query", {sql:sql})
-        let connection:mariadb.Connection|null = 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})
-    }
-
-    private async _exec(sql:string):Promise<any> {
-        // OINOLog.debug("OINODbMariadb._exec", {sql:sql})
-        let connection:mariadb.Connection|null = 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 as Error).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:string): string {
-        return "`"+sqlTable+"`"
-    }
-
-    /**
-     * Print a column name with correct SQL escaping.
-     * 
-     * @param sqlColumn name of the column
-     *
-     */
-    printSqlColumnname(sqlColumn:string): string {
-        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:OINODataCell, sqlType: string): string {
-        // 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")) {
-            if (cellValue instanceof Buffer) {
-                return "x'" + (cellValue as Buffer).toString("hex") + "'"
-            } else if (cellValue instanceof Uint8Array) {
-                return "x'" + Buffer.from(cellValue as Uint8Array).toString("hex") + "'"
-            } else {
-                return "\"" + cellValue?.toString() + "\""
-            }
-
-        } 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:OINODataCell, sqlType: string): OINODataCell {
-        // 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:Buffer = sqlValue as Buffer
-            let result:string = ""
-            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(): Promise<boolean> {
-        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 OINODbMariadb server: " + err)
-        }        
-    }
-
-    /**
-     * Execute a select operation.
-     * 
-     * @param sql SQL statement.
-     *
-     */
-    async sqlSelect(sql:string): Promise<OINODbDataSet> {
-        OINOBenchmark.start("OINODb", "sqlSelect")
-        let result:OINODbDataSet
-        try {
-            const sql_res:OINODataRow[] = await this._query(sql)
-            // OINOLog.debug("OINODbMariadb.sqlSelect", {sql_res:sql_res})
-            result = new OINOMariadbData(sql_res, [])
-
-        } catch (e:any) {
-            result = new OINOMariadbData([[]], [OINO_ERROR_PREFIX + " (sqlSelect): OINODbMariadb.sqlSelect exception in _db.query: " + e.message])
-        }
-        OINOBenchmark.end("OINODb", "sqlSelect")
-        return result
-    }
-
-    /**
-     * Execute other sql operations.
-     * 
-     * @param sql SQL statement.
-     *
-     */
-    async sqlExec(sql:string): Promise<OINODbDataSet> {
-        OINOBenchmark.start("OINODb", "sqlExec")
-        let result:OINODbDataSet
-        try {
-            const sql_res:OINODataRow[] = await this._exec(sql)
-            // OINOLog.debug("OINODbMariadb.sqlExec", {sql_res:sql_res})
-            result = new OINOMariadbData(sql_res, [])
-
-        } catch (e:any) {
-            result = new OINOMariadbData([[]], [OINO_ERROR_PREFIX + " (sqlExec): exception in _db.exec [" + e.message + "]"])
-        }
-        OINOBenchmark.end("OINODb", "sqlExec")
-        return result
-    }
-
-    private _getSchemaSql(dbName:string, tableName:string):string {
-        const sql = 
-`SELECT
-    c.COLUMN_NAME,
-    c.COLUMN_TYPE,
-    c.IS_NULLABLE,
-    c.COLUMN_KEY,
-    c.COLUMN_DEFAULT,
-    c.EXTRA,
-    KCU.CONSTRAINT_NAME AS ForeignKeyName 
-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}' AND C.TABLE_NAME = '${tableName}'
-ORDER BY C.ORDINAL_POSITION;`
-        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:OINODbApi): Promise<void> {
-        
-        const res:OINODbDataSet = await this.sqlSelect(this._getSchemaSql(this._params.database, api.params.tableName))
-        while (!res.isEof()) {
-            const row:OINODataRow = res.getRow()
-            // OINOLog.debug("OINODbMariadb.initializeApiDatamodel", { description:row })
-            const field_name:string = row[0]?.toString() || ""
-            const field_matches = OINODbMariadb._fieldLengthRegex.exec(row[1]?.toString() || "") || []
-            // OINOLog.debug("OINODbMariadb.initializeApiDatamodel", { field_matches:field_matches })
-            const sql_type:string = field_matches[1] || ""
-            const field_length1:number = this._parseFieldLength(field_matches[3] || "0")
-            const field_length2:number = this._parseFieldLength(field_matches[4] || "0")
-            const extra:string = row[5]?.toString() || ""
-            const field_params:OINODbDataFieldParams = {
-                isPrimaryKey: row[3] == "PRI",
-                isForeignKey: row[6] != null,
-                isAutoInc: extra.indexOf('auto_increment') >= 0,
-                isNotNull: row[2] == "NO"
-            }            
-            if (api.isFieldIncluded(field_name)==false) {
-                OINOLog.info("OINODbMariadb.initializeApiDatamodel: field excluded in API parameters.", {field:field_name})
-                if (field_params.isPrimaryKey) {
-                    throw new Error(OINO_ERROR_PREFIX + "Primary key field excluded in API parameters: " + 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))
-                }   
-            }
-            await res.next()
-        }
-        OINOLog.debug("OINODbMariadb.initializeDatasetModel:\n" + api.datamodel.printDebug("\n"))
-        return Promise.resolve()
-    }
-}
-
-
-
+/*
+ * 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, 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 mariadb from "mariadb";
+
+/**
+ * Implmentation of OINODbDataSet for MariaDb.
+ * 
+ */
+class OINOMariadbData extends OINODbDataSet {
+    private _rows:OINODataRow[] = OINODB_EMPTY_ROWS
+    
+    /**
+     * OINOMariadbData constructor
+     * @param params database parameters
+     */
+    constructor(data: any, messages:string[]=[]) {
+        super(data, messages)
+
+        if (data == null) {
+            this.messages.push(OINO_INFO_PREFIX + "SQL result is empty")
+
+        } else if (Array.isArray(data)) {
+            this._rows = data as OINODataRow[]
+
+        }
+        // OINOLog.debug("OINOMariadbData.constructor", {_rows:this._rows})
+        if (this.isEmpty()) {
+            this._currentRow = -1
+            this._eof = true
+        } else {
+            this._currentRow = 0
+            this._eof = false
+        }
+    }
+    private _currentRow: number
+    private _eof: boolean
+    
+    /**
+     * Is data set empty.
+     *
+     */
+    isEmpty():boolean {
+        return (this._rows.length == 0)
+    }
+
+    /**
+     * Is there no more content, i.e. either dataset is empty or we have moved beyond last line
+     *
+     */
+    isEof():boolean {
+        return (this._eof)
+    }
+
+    /**
+     * Attempts to moves dataset to the next row, possibly waiting for more data to become available. Returns !isEof().
+     *
+     */
+    async next():Promise<boolean> {
+        // 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 Promise.resolve(!this._eof)
+    }
+
+    /**
+     * Gets current row of data.
+     *
+     */
+    getRow(): OINODataRow {
+        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 {
+    
+    private static _fieldLengthRegex = /([^\(\)]+)(\s?\((\d+)\s?\,?\s?(\d*)?\))?/i
+    private static _exceptionMessageRegex = /\(([^\)]*)\) (.*)\nsql\:(.*)?/i
+    
+    private _pool:mariadb.Pool
+
+    /**
+     * Constructor of `OINODbMariadb` 
+     * @param params database parameters
+     */
+    constructor(params:OINODbParams) {
+        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", {})
+        // })
+    }
+
+    private _parseFieldLength(fieldLengthStr:string):number {
+        let result:number = parseInt(fieldLengthStr)
+        if (Number.isNaN(result)) {
+            result = 0
+        }
+        return result
+    }
+
+    private async _query(sql:string):Promise<OINODataRow[]> {
+        // OINOLog.debug("OINODbMariadb._query", {sql:sql})
+        let connection:mariadb.Connection|null = 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})
+    }
+
+    private async _exec(sql:string):Promise<any> {
+        // OINOLog.debug("OINODbMariadb._exec", {sql:sql})
+        let connection:mariadb.Connection|null = 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 as Error).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:string): string {
+        return "`"+sqlTable+"`"
+    }
+
+    /**
+     * Print a column name with correct SQL escaping.
+     * 
+     * @param sqlColumn name of the column
+     *
+     */
+    printSqlColumnname(sqlColumn:string): string {
+        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:OINODataCell, sqlType: string): string {
+        // 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")) {
+            if (cellValue instanceof Buffer) {
+                return "x'" + (cellValue as Buffer).toString("hex") + "'"
+            } else if (cellValue instanceof Uint8Array) {
+                return "x'" + Buffer.from(cellValue as Uint8Array).toString("hex") + "'"
+            } else {
+                return "\"" + cellValue?.toString() + "\""
+            }
+
+        } 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 this.printSqlString(cellValue?.toString())
+        }
+    }
+
+    /**
+     * Print a single string value as valid sql literal
+     * 
+     * @param sqlString string value
+     *
+     */
+    printSqlString(sqlString:string): string {
+        return "\"" + sqlString.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:OINODataCell, sqlType: string): OINODataCell {
+        // 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:Buffer = sqlValue as Buffer
+            let result:string = ""
+            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(): Promise<boolean> {
+        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 OINODbMariadb server: " + err)
+        }        
+    }
+
+    /**
+     * Execute a select operation.
+     * 
+     * @param sql SQL statement.
+     *
+     */
+    async sqlSelect(sql:string): Promise<OINODbDataSet> {
+        OINOBenchmark.start("OINODb", "sqlSelect")
+        let result:OINODbDataSet
+        try {
+            const sql_res:OINODataRow[] = await this._query(sql)
+            // OINOLog.debug("OINODbMariadb.sqlSelect", {sql_res:sql_res})
+            result = new OINOMariadbData(sql_res, [])
+
+        } catch (e:any) {
+            result = new OINOMariadbData([[]], [OINO_ERROR_PREFIX + " (sqlSelect): OINODbMariadb.sqlSelect exception in _db.query: " + e.message])
+        }
+        OINOBenchmark.end("OINODb", "sqlSelect")
+        return result
+    }
+
+    /**
+     * Execute other sql operations.
+     * 
+     * @param sql SQL statement.
+     *
+     */
+    async sqlExec(sql:string): Promise<OINODbDataSet> {
+        OINOBenchmark.start("OINODb", "sqlExec")
+        let result:OINODbDataSet
+        try {
+            const sql_res:OINODataRow[] = await this._exec(sql)
+            // OINOLog.debug("OINODbMariadb.sqlExec", {sql_res:sql_res})
+            result = new OINOMariadbData(sql_res, [])
+
+        } catch (e:any) {
+            result = new OINOMariadbData([[]], [OINO_ERROR_PREFIX + " (sqlExec): exception in _db.exec [" + e.message + "]"])
+        }
+        OINOBenchmark.end("OINODb", "sqlExec")
+        return result
+    }
+
+    private _getSchemaSql(dbName:string, tableName:string):string {
+        const sql = 
+`SELECT
+    c.COLUMN_NAME,
+    c.COLUMN_TYPE,
+    c.IS_NULLABLE,
+    c.COLUMN_KEY,
+    c.COLUMN_DEFAULT,
+    c.EXTRA,
+    KCU.CONSTRAINT_NAME AS ForeignKeyName 
+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}' AND C.TABLE_NAME = '${tableName}'
+ORDER BY C.ORDINAL_POSITION;`
+        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:OINODbApi): Promise<void> {
+        
+        const res:OINODbDataSet = await this.sqlSelect(this._getSchemaSql(this._params.database, api.params.tableName))
+        while (!res.isEof()) {
+            const row:OINODataRow = res.getRow()
+            // OINOLog.debug("OINODbMariadb.initializeApiDatamodel", { description:row })
+            const field_name:string = row[0]?.toString() || ""
+            const field_matches = OINODbMariadb._fieldLengthRegex.exec(row[1]?.toString() || "") || []
+            // OINOLog.debug("OINODbMariadb.initializeApiDatamodel", { field_matches:field_matches })
+            const sql_type:string = field_matches[1] || ""
+            const field_length1:number = this._parseFieldLength(field_matches[3] || "0")
+            const field_length2:number = this._parseFieldLength(field_matches[4] || "0")
+            const extra:string = row[5]?.toString() || ""
+            const field_params:OINODbDataFieldParams = {
+                isPrimaryKey: row[3] == "PRI",
+                isForeignKey: row[6] != null,
+                isAutoInc: extra.indexOf('auto_increment') >= 0,
+                isNotNull: row[2] == "NO"
+            }            
+            if (api.isFieldIncluded(field_name)==false) {
+                OINOLog.info("OINODbMariadb.initializeApiDatamodel: field excluded in API parameters.", {field:field_name})
+                if (field_params.isPrimaryKey) {
+                    throw new Error(OINO_ERROR_PREFIX + "Primary key field excluded in API parameters: " + 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))
+                }   
+            }
+            await res.next()
+        }
+        OINOLog.debug("OINODbMariadb.initializeDatasetModel:\n" + api.datamodel.printDebug("\n"))
+        return Promise.resolve()
+    }
+}
+
+
+

package/src/index.ts

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

package/README.md

@@ -1,190 +0,0 @@
-# OINO TS
- OINO Is Not an ORM but it's trying to solve a similar problem for API development. Instead of mirroring your DB schema in code that needs manual updates, OINO will get the data schema from DBMS using SQL in real time. Every time your app starts, it has an updated data model which enables automatic (de)serialize SQL results to JSON/CSV and back. OINO works on the level below routing where you pass the method, URL ID, body and request parameters to the API-object. OINO will parse and validate the data against the data model and generate proper SQL for your DB. Because OINO knows how data is serialized (e.g. JSON), what column it belongs to (e.g. floating point number) and what the target database is, it knows how to parse, format and escape the value as valid SQL.
- 
- ```
- const result:OINOApiResult = await api_orderdetails.doRequest("GET", id, body, params)
- return new Response(result.modelset.writeString(OINOContentType.json))
- ```
- 
-
- # GETTING STARTED
- 
- ### Setup
- Install the `@oino-ts/db` npm package and necessary database packages and import them in your code.
- ```
- bun install @oino-ts/db
- bun install @oino-ts/db-bunsqlite
- ```
- 
- ```
- import { OINODb, OINOApi, OINOFactory } from "@oino-ts/db";
- import { OINODbBunSqlite } from "@oino-ts/db-bunsqlite"
- ```
- 
- ### Register database and logger
- Register your database implementation and logger (see [`OINOConsoleLog`](https://pragmatta.github.io/oino-ts/classes/types_src.OINOConsoleLog.html) how to implement your own)
-
- ```
- OINOLog.setLogger(new OINOConsoleLog())
- OINOFactory.registerDb("OINODbBunSqlite", OINODbBunSqlite)
- ```
-
- ### Create a database
- Creating a database connection [`OINODb`](https://pragmatta.github.io/oino-ts/classes/db_src.OINODb.html) is done by passing [`OINODbParams`](https://pragmatta.github.io/oino-ts/types/db_src.OINODbParams.html) to the factory method. For [`OINODbBunSqlite`](https://pragmatta.github.io/oino-ts/classes/db_bunsqlite_src.OINODbBunSqlite.html) that means a file url for the database file, for others network host, port, credentials etc.
- ```
- const db:OINODb = await OINOFactory.createDb( { type: "OINODbBunSqlite", url: "file://../localDb/northwind.sqlite" } )
- ```
-
- ### Create an API
- From a database you can create an [`OINOApi`](https://pragmatta.github.io/oino-ts/classes/db_src.OINODbApi.html) by passing [`OINOApiParams`](https://pragmatta.github.io/oino-ts/types/db_src.OINODbApiParams.html) with table name and preferences to the factory method.
- ```
- const api_employees:OINOApi = await OINOFactory.createApi(db, { tableName: "Employees", excludeFields:["BirthDate"] })
- ```
-
- ### Pass HTTP requests to API
- When you receive a HTTP request, just pass the method, URL ID, body and params to the correct API, which will parse and validate input and return results.
-
- ```
- const result:OINOApiResult = await api_orderdetails.doRequest("GET", id, body, params)
- ```
-
- ### Write results back to HTTP Response
- The results for a GET request will contain [`OINOModelSet`](https://pragmatta.github.io/oino-ts/classes/db_src.OINODbModelSet.html) data that can be written out as JSON or CSV as needed. For other requests result is just success or error with messages.
- ```
- return new Response(result.data.writeString(OINOContentType.json))
- ```
- 
- 
- # FEATURES
- 
- ## RESTfull
- OINO maps HTTP methods GET/POST/PUT/DELETE to SQL operations SELECT/INSERT/UPDATE/DELETE. The GET/POST requests can be made without URL ID to get all rows or insert new ones and others target a single row using URL ID. 
-
- For example HTTP POST 
- ```
- Request and response:
- > curl.exe -X POST http://localhost:3001/orderdetails -H "Content-Type: application/json" --data '[{\"OrderID\":11077,\"ProductID\":99,\"UnitPrice\":19,\"Quantity\":1,\"Discount\":0}]'
- {"success":true,"statusCode":200,"statusMessage":"OK","messages":[]}
-
- SQL:
- INSERT INTO [OrderDetails] ("OrderID","ProductID","UnitPrice","Quantity","Discount") VALUES (11077,99,19,1,0);
- ```
-
-
- ## Universal Serialization
- OINO handles serialization of data to JSON/CSV/etc. and back based on the data model. It knows what columns exist, what is their data type and how to convert each to JSON/CSV and back. This allows also partial data to be sent, i.e. you can send only columns that need updating or even send extra columns and have them ignored.
-
- ### Features
- - Files can be sent to BLOB fields using BASE64 or MIME multipart encoding. Also supports standard HTML form file submission to blob fields and returning them data url images.
- - Datetimes are (optionally) normalized to ISO 8601 format.
- - Extended JSON-encoding
-   - Unquoted literal `undefined` can be used to represent non-existent values (leaving property out works too but preserving structure might be easier e.g. when translating data).
- - CSV
-   - Comma-separated, doublequotes.
-   - Unquoted literal `null` represents null values.
-   - Unquoted empty string represents undefined values.
- - Form data
-   - Multipart-mixed and binary files not supported.
-   - Non-existent value line (i.e. nothing after the empty line) treated as a null value.
- - Url-encoded
-   - No null values, missing properties treated as undefined.
-   - Multiple lines could be used to post multiple rows.
-
-
- ## Database Abstraction
- OINO functions as a database abstraction, providing a consistent interface for working with different databases. It abstracts out different conventions in connecting, making queries and formatting data.
-
- Currently supported databases:
- - Bun Sqlite through Bun native implementation
- - Postgresql through [pg](https://www.npmjs.com/package/pg)-package
- - Mariadb / Mysql-support through [mariadb](https://www.npmjs.com/package/mariadb)-package
- - Sql Server through [mssql](https://www.npmjs.com/package/mssql)-package
-
- ## Composite Keys
- To support tables with multipart primary keys OINO generates a composite key `_OINOID_` that is included in the result and can be used as the REST ID. For example in the example above table `OrderDetails` has two primary keys `OrderID` and `ProductID` making the `_OINOID_` of form `11077:99`. 
-
- ## Power Of SQL
- Since OINO is just generating SQL, WHERE-conditions can be defined with [`OINOSqlFilter`](https://pragmatta.github.io/oino-ts/classes/db_src.OINODbSqlFilter.html), order with [`OINOSqlOrder`](https://pragmatta.github.io/oino-ts/classes/db_src.OINODbSqlOrder.html) and limits/paging with [`OINOSqlLimit`](https://pragmatta.github.io/oino-ts/classes/db_src.OINODbSqlLimit.html) that are passed as HTTP request parameters. No more API development where you make unique API endpoints for each filter that fetch all data with original API and filter in backend code. Every API can be filtered when and as needed without unnessecary data tranfer and utilizing SQL indexing when available.
-
- ## Swagger Support
- Swagger is great as long as the definitions are updated and with OINO you can automatically get a Swagger definition including a data model schema.
- ```
- if (url.pathname == "/swagger.json") {
-    return new Response(JSON.stringify(OINOSwagger.getApiDefinition(api_array)))
- }
- ```
- ![Swagger definition with a data model schema](img/readme-swagger.png)
-
- ## Node support
- OINO is developped Typescript first but compiles to standard CommonJS and the NPM packages should work on either ESM / CommonJS. Checkout sample apps `readmeApp` (ESM) and `nodeApp` (CommonJS).
-
- ## HTMX support
- OINO is [htmx.org](https://htmx.org) friendly, allowing easy translation of [`OINODataRow`](https://pragmatta.github.io/oino-ts/types/db_src.OINODataRow.html) to HTML output using templates (cf. the [htmx sample app](https://github.com/pragmatta/oino-ts/tree/main/samples/htmxApp)).
-
- ## Hashids
- Autoinc numeric id's are very pragmatic and fit well with OINO (e.g. using a form without primary key fields to insert new rows with database assigned ids). However it's not always sensible to share information about the sequence. Hashids solve this by masking the original values by encrypting the ids using AES-128 and some randomness. Length of the hashid can be chosen from 12-32 characters where longer ids provide more security. However this should not be considereded a cryptographic solution for keeping ids secret but rather making it infeasible to iterate all ids.
-
-
- # STATUS
- OINO is currently a hobby project which should and should considered in alpha status. That also means compatibility breaking changes can be made without prior notice when architectual issues are discovered.
-
- ## Beta 
- For a beta status following milestones are planned:
-
- ### Realistic app
- There needs to be a realistic app built on top of OINO to get a better grasp of the edge cases.
- 
- ## Roadmap
- Things that need to happen in some order before beta-status are at least following:
- 
- ### Support for views
- Simple cases of views would work already in some databases but edge cases might get complicated. For example 
- - How to handle a view which does not have a complete private key?
- - What edge cases exist in updating views?
-
- ### Batch updates
- Supporting batch updates similar to batch inserts is slightly bending the RESTfull principles but would still be a useful optional feature.
-
- ### Aggregation
- Similar to filtering, ordering and limits, aggregation could be implemented as HTTP request parameters telling what column is aggregated or used for ordering or how many results to return.
-
- ### Streaming
- One core idea is to be efficient in not making unnecessary copies of the data and minimizing garbage collection debt. This can be taken further by implementing streaming, allowing large dataset to be written to HTTP response as SQL result rows are received.
-
- ### SQL generation callbacks
- It would be useful to allow developer to validate / override SQL generation to cover cases OINO does not support or even workaround issues.
-
- ### Transactions
- Even though the basic case for OINO is executing SQL operations on individual rows, having an option to use SQL transactions could make sense at least for batch operations.
-
-
- # HELP
- 
- ## Bug reports
- Fixing bugs is a priority and getting good quality bug reports helps. It's recommended to use the sample Northwind database included with project to replicate issues or make an SQL script export of the relevant table.
-  
- ## Feedback
- Understanding and prioritizing the use cases for OINO is also important and feedback about how you'd use OINO is interesting. Feel free to raise issues and feature requests in Github, but understand that short term most of the effort goes towards reaching the beta stage.
-
- ## Typescript / Javascript architecture
- Typescript building with different targets and module-systemts and a ton of configuration is a complex domain and something I have little experience un so help in fixing problems and how thing ought to be done is appreciated.
- 
- # LINKS
- - [Github repository](https://github.com/pragmatta/oino-ts)
- - [NPM repository](https://www.npmjs.com/org/oino-ts) 
- 
- 
- # ACKNOWLEDGEMENTS
- 
- ## Libraries
- OINO uses the following open source libraries and npm packages and I would like to thank everyone for their contributions:
- - Postgresql [node-postgres package](https://www.npmjs.com/package/pg)
- - Mariadb / Mysql [mariadb package](https://www.npmjs.com/package/mariadb)
- - Sql Server [mssql package](https://www.npmjs.com/package/mssql)
- - Custom base encoding [base-x package](https://www.npmjs.com/package/base-x)
-
- ## Bun
- OINO has been developed using the Bun runtime, not because of the speed improvements but for the first class Typescript support and integrated developper experience. Kudos on the bun team for making Typescript work more exiting again.
- 
- ## SQL Scripts
- The SQL scripts for creating the sample Northwind database are based on [Google Code archive](https://code.google.com/archive/p/northwindextended/downloads) and have been further customized to ensure they would have identical data (in the scope of the automated testing).