@oino-ts/db-postgresql 0.16.1 → 0.17.1

package/dist/cjs/OINODbPostgresql.js

@@ -306,47 +306,47 @@ class OINODbPostgresql extends db_1.OINODb {
         return result;
     }
     _getSchemaSql(dbName, tableName) {
-        const sql = `SELECT 
-    col.column_name, 
-    col.data_type, 
-    col.character_maximum_length, 
-    col.is_nullable, 
-    con.constraint_type,
-    col.numeric_precision,
-    col.numeric_scale,
-    col.column_default
-FROM information_schema.columns col
-LEFT JOIN LATERAL
-    (select kcu.column_name, STRING_AGG(tco.constraint_type,',') as constraint_type
-    from 
-        information_schema.table_constraints tco,
-        information_schema.key_column_usage kcu 	 
-    where 
-        kcu.constraint_name = tco.constraint_name
-        and kcu.constraint_schema = tco.constraint_schema
-		and tco.table_catalog = col.table_catalog
-		and tco.table_name = col.table_name
-        and (tco.constraint_type = 'PRIMARY KEY' OR tco.constraint_type = 'FOREIGN KEY')
-	group by kcu.column_name) con on col.column_name = con.column_name
+        const sql = `SELECT 
+    col.column_name, 
+    col.data_type, 
+    col.character_maximum_length, 
+    col.is_nullable, 
+    con.constraint_type,
+    col.numeric_precision,
+    col.numeric_scale,
+    col.column_default
+FROM information_schema.columns col
+LEFT JOIN LATERAL
+    (select kcu.column_name, STRING_AGG(tco.constraint_type,',') as constraint_type
+    from 
+        information_schema.table_constraints tco,
+        information_schema.key_column_usage kcu 	 
+    where 
+        kcu.constraint_name = tco.constraint_name
+        and kcu.constraint_schema = tco.constraint_schema
+		and tco.table_catalog = col.table_catalog
+		and tco.table_name = col.table_name
+        and (tco.constraint_type = 'PRIMARY KEY' OR tco.constraint_type = 'FOREIGN KEY')
+	group by kcu.column_name) con on col.column_name = con.column_name
 WHERE col.table_catalog = '${dbName}' AND col.table_name = '${tableName}'`;
         return sql;
     }
     _getValidateSql(dbName) {
-        const sql = `SELECT 
-    count(col.column_name) AS column_count
-FROM information_schema.columns col
-LEFT JOIN LATERAL
-    (select kcu.column_name, STRING_AGG(tco.constraint_type,',') as constraint_type
-    from 
-        information_schema.table_constraints tco,
-        information_schema.key_column_usage kcu 	 
-    where 
-        kcu.constraint_name = tco.constraint_name
-        and kcu.constraint_schema = tco.constraint_schema
-		and tco.table_catalog = col.table_catalog
-		and tco.table_name = col.table_name
-        and (tco.constraint_type = 'PRIMARY KEY' OR tco.constraint_type = 'FOREIGN KEY')
-	group by kcu.column_name) con on col.column_name = con.column_name
+        const sql = `SELECT 
+    count(col.column_name) AS column_count
+FROM information_schema.columns col
+LEFT JOIN LATERAL
+    (select kcu.column_name, STRING_AGG(tco.constraint_type,',') as constraint_type
+    from 
+        information_schema.table_constraints tco,
+        information_schema.key_column_usage kcu 	 
+    where 
+        kcu.constraint_name = tco.constraint_name
+        and kcu.constraint_schema = tco.constraint_schema
+		and tco.table_catalog = col.table_catalog
+		and tco.table_name = col.table_name
+        and (tco.constraint_type = 'PRIMARY KEY' OR tco.constraint_type = 'FOREIGN KEY')
+	group by kcu.column_name) con on col.column_name = con.column_name
 WHERE col.table_catalog = '${dbName}'`;
         return sql;
     }

package/dist/esm/OINODbPostgresql.js

@@ -303,47 +303,47 @@ export class OINODbPostgresql extends OINODb {
         return result;
     }
     _getSchemaSql(dbName, tableName) {
-        const sql = `SELECT 
-    col.column_name, 
-    col.data_type, 
-    col.character_maximum_length, 
-    col.is_nullable, 
-    con.constraint_type,
-    col.numeric_precision,
-    col.numeric_scale,
-    col.column_default
-FROM information_schema.columns col
-LEFT JOIN LATERAL
-    (select kcu.column_name, STRING_AGG(tco.constraint_type,',') as constraint_type
-    from 
-        information_schema.table_constraints tco,
-        information_schema.key_column_usage kcu 	 
-    where 
-        kcu.constraint_name = tco.constraint_name
-        and kcu.constraint_schema = tco.constraint_schema
-		and tco.table_catalog = col.table_catalog
-		and tco.table_name = col.table_name
-        and (tco.constraint_type = 'PRIMARY KEY' OR tco.constraint_type = 'FOREIGN KEY')
-	group by kcu.column_name) con on col.column_name = con.column_name
+        const sql = `SELECT 
+    col.column_name, 
+    col.data_type, 
+    col.character_maximum_length, 
+    col.is_nullable, 
+    con.constraint_type,
+    col.numeric_precision,
+    col.numeric_scale,
+    col.column_default
+FROM information_schema.columns col
+LEFT JOIN LATERAL
+    (select kcu.column_name, STRING_AGG(tco.constraint_type,',') as constraint_type
+    from 
+        information_schema.table_constraints tco,
+        information_schema.key_column_usage kcu 	 
+    where 
+        kcu.constraint_name = tco.constraint_name
+        and kcu.constraint_schema = tco.constraint_schema
+		and tco.table_catalog = col.table_catalog
+		and tco.table_name = col.table_name
+        and (tco.constraint_type = 'PRIMARY KEY' OR tco.constraint_type = 'FOREIGN KEY')
+	group by kcu.column_name) con on col.column_name = con.column_name
 WHERE col.table_catalog = '${dbName}' AND col.table_name = '${tableName}'`;
         return sql;
     }
     _getValidateSql(dbName) {
-        const sql = `SELECT 
-    count(col.column_name) AS column_count
-FROM information_schema.columns col
-LEFT JOIN LATERAL
-    (select kcu.column_name, STRING_AGG(tco.constraint_type,',') as constraint_type
-    from 
-        information_schema.table_constraints tco,
-        information_schema.key_column_usage kcu 	 
-    where 
-        kcu.constraint_name = tco.constraint_name
-        and kcu.constraint_schema = tco.constraint_schema
-		and tco.table_catalog = col.table_catalog
-		and tco.table_name = col.table_name
-        and (tco.constraint_type = 'PRIMARY KEY' OR tco.constraint_type = 'FOREIGN KEY')
-	group by kcu.column_name) con on col.column_name = con.column_name
+        const sql = `SELECT 
+    count(col.column_name) AS column_count
+FROM information_schema.columns col
+LEFT JOIN LATERAL
+    (select kcu.column_name, STRING_AGG(tco.constraint_type,',') as constraint_type
+    from 
+        information_schema.table_constraints tco,
+        information_schema.key_column_usage kcu 	 
+    where 
+        kcu.constraint_name = tco.constraint_name
+        and kcu.constraint_schema = tco.constraint_schema
+		and tco.table_catalog = col.table_catalog
+		and tco.table_name = col.table_name
+        and (tco.constraint_type = 'PRIMARY KEY' OR tco.constraint_type = 'FOREIGN KEY')
+	group by kcu.column_name) con on col.column_name = con.column_name
 WHERE col.table_catalog = '${dbName}'`;
         return sql;
     }

package/package.json

@@ -1,38 +1,38 @@
-{
-  "name": "@oino-ts/db-postgresql",
-  "version": "0.16.1",
-  "description": "OINO TS package for using Postgresql 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",
-    "postgresql"
-  ],
-  "main": "./dist/cjs/index.js",
-  "module": "./dist/esm/index.js",
-  "types": "./dist/types/index.d.ts",
-  "dependencies": {
-    "@oino-ts/db": "0.16.1",
-    "pg": "^8.11.3"
-  },
-  "devDependencies": {
-    "@types/bun": "latest",
-    "@types/node": "^20.12.7",
-    "@types/pg": "^8.11.5",
-    "typescript": "~5.9.0"
-  },
-  "files": [
-    "src/*.ts",
-    "dist/cjs/*.js",
-    "dist/esm/*.js",
-    "dist/types/*.d.ts"
-  ]
-}
+{
+  "name": "@oino-ts/db-postgresql",
+  "version": "0.17.1",
+  "description": "OINO TS package for using Postgresql 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",
+    "postgresql"
+  ],
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.js",
+  "types": "./dist/types/index.d.ts",
+  "dependencies": {
+    "@oino-ts/db": "0.17.1",
+    "pg": "^8.11.3"
+  },
+  "devDependencies": {
+    "@types/bun": "latest",
+    "@types/node": "^20.12.7",
+    "@types/pg": "^8.11.5",
+    "typescript": "~5.9.0"
+  },
+  "files": [
+    "src/*.ts",
+    "dist/cjs/*.js",
+    "dist/esm/*.js",
+    "dist/types/*.d.ts"
+  ]
+}

package/src/OINODbPostgresql.ts

@@ -1,443 +1,443 @@
-/*
- * 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, OINOLog, OINOResult, OINODB_EMPTY_ROW, OINODB_EMPTY_ROWS } from "@oino-ts/db";
-
-import { Pool, QueryResult } from "pg";
-
-
-/**
- * Implmentation of OINODbDataSet for Postgresql.
- * 
- */
-class OINOPostgresqlData extends OINODbDataSet {
-    private _rows:OINODataRow[]
-    
-    /**
-     * OINOPostgresqlData constructor
-     * @param params database parameters
-     */
-    constructor(data: unknown, messages:string[]=[]) {
-        super(data, messages)
-
-        if ((data != null) && !(Array.isArray(data))) {
-            throw new Error(OINO_ERROR_PREFIX + ": Invalid Posgresql data type!") // TODO: maybe check all rows
-        }
-        this._rows = data as OINODataRow[]
-        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> {
-        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
-        }
-    }
-
-    /**
-     * Gets all rows of data.
-     *
-     */
-    async getAllRows(): Promise<OINODataRow[]> {
-        return this._rows // at the moment theres no result streaming, so we can just return the rows
-    }    
-}
-
-/**
- * Implementation of Postgresql-database.
- * 
- */
-export class OINODbPostgresql extends OINODb {
-    
-    private _pool:Pool
-
-    /**
-     * Constructor of `OINODbPostgresql`
-     * @param params database paraneters
-     */
-    constructor(params:OINODbParams) {
-        super(params)
-
-        if (this._params.type !== "OINODbPostgresql") {
-            throw new Error(OINO_ERROR_PREFIX + ": Not OINODbPostgresql-type: " + this._params.type)
-        } 
-        const ssl_enabled:boolean = !(this._params.url == "localhost" || this._params.url == "127.0.0.1")
-        this._pool = new Pool({ host: this._params.url, database: this._params.database, port: this._params.port, user: this._params.user, password: this._params.password, ssl: ssl_enabled })
-        delete this._params.password
-
-        this._pool.on("error", (err: any) => {
-            OINOLog.error("@oino-ts/db-postgresql", "OINODbPostgresql", ".on(error)", "Error-event", {err:err}) 
-        })
-    }
-
-    private _parseFieldLength(fieldLength:OINODataCell):number {
-        let result:number = parseInt((fieldLength || "0").toString())
-        if (Number.isNaN(result)) {
-            result = 0
-        }
-        return result
-    }
-
-    private async _query(sql:string):Promise<OINODataRow[]> {
-        const query_result:QueryResult = await this._pool.query({rowMode: "array", text: sql})
-        return Promise.resolve(query_result.rows)
-    }
-
-    private async _exec(sql:string):Promise<OINODataRow[]> {
-        const query_result:QueryResult = await this._pool.query({rowMode: "array", text: sql})
-        if (Array.isArray(query_result) == true) {
-            return Promise.resolve(query_result.flatMap((q) => q.rows))
-        } else if (query_result.rows) {
-            return Promise.resolve(query_result.rows)
-        } else {
-            return Promise.resolve(OINODB_EMPTY_ROWS) // return empty row if no rows returned
-        }
-    }
-
-    /**
-     * Print a table name using database specific SQL escaping.
-     * 
-     * @param sqlTable name of the table
-     *
-     */
-    printSqlTablename(sqlTable:string): string {
-        return "\""+sqlTable.toLowerCase()+"\""
-    }
-
-    /**
-     * 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 {
-        if (cellValue === null) {
-            return "NULL"
-
-        } else if (cellValue === undefined) {
-            return "UNDEFINED"
-
-        } else if ((sqlType == "integer") || (sqlType == "smallint") || (sqlType == "real")) {
-            return cellValue.toString()
-
-        } else if (sqlType == "bytea") {
-            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 == "boolean") {
-            if (cellValue == null || cellValue == "" || cellValue.toString().toLowerCase() == "false" || cellValue == "0") { 
-                return "false"
-            } else {
-                return "true"
-            }
-
-        } else if ((sqlType == "date") && (cellValue instanceof Date)) {
-            return "\'" + cellValue.toISOString() + "\'"
-
-        } 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("'", "''") + "\'"
-    }
-
-
-    /**
-     * 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 {
-        if ((sqlValue === null) || (sqlValue == "NULL")) {
-            return null
-
-        } else if (sqlValue === undefined) {
-            return undefined
-
-        } else if (((sqlType == "date")) && (typeof(sqlValue) == "string") && (sqlValue != "")) {
-            return new Date(sqlValue)
-
-        } else {
-            return sqlValue
-        }
-
-    }
-
-    /**
-     * Connect to database.
-     *
-     */
-    async connect(): Promise<OINOResult> {
-        let result:OINOResult = new OINOResult()
-        try {
-            // make sure that any items are correctly URL encoded in the connection string
-            await this._pool.connect()
-            this.isConnected = true
-
-        } catch (e:any) {
-            result.setError(500, "Exception connecting to database: " + e.message, "OINODbPostgresql.connect")
-            OINOLog.exception("@oino-ts/db-postgresql", "OINODbMsSql", "connect", "exception in connect", {message:e.message, stack:e.stack}) 
-        }        
-        return result
-    }
-
-    /**
-     * Validate connection to database is working. 
-     *
-     */
-    async validate(): Promise<OINOResult> {
-        OINOBenchmark.startMetric("OINODb", "validate")
-        let result:OINOResult = new OINOResult()
-        try {
-            const sql = this._getValidateSql(this._params.database)
-            const sql_res:OINODbDataSet = await this.sqlSelect(sql)
-            if (sql_res.isEmpty()) {
-                result.setError(400, "DB returned no rows for select!", "OINODbPostgresql.validate")
-
-            } else if (sql_res.getRow().length == 0) {
-                result.setError(400, "DB returned no values for database!", "OINODbPostgresql.validate")
-
-            } else if (sql_res.getRow()[0] == "0") {
-                result.setError(400, "DB returned no schema for database!", "OINODbPostgresql.validate")
-
-            } else {
-                this.isValidated = true
-            }
-        } catch (e:any) {
-            result.setError(500, "Exception validating connection: " + e.message, "OINODbPostgresql.validate")
-            OINOLog.exception("@oino-ts/db-postgresql", "OINODbMsSql", "validate", "exception in validate", {message:e.message, stack:e.stack}) 
-        }
-        OINOBenchmark.endMetric("OINODb", "validate")
-        return result
-    }
-
-    /**
-     * Execute a select operation.
-     * 
-     * @param sql SQL statement.
-     *
-     */
-    async sqlSelect(sql:string): Promise<OINODbDataSet> {
-        OINOBenchmark.startMetric("OINODb", "sqlSelect")
-        let result:OINODbDataSet
-        try {
-            const rows:OINODataRow[] = await this._query(sql)
-            result = new OINOPostgresqlData(rows, [])
-
-        } catch (e:any) {
-            result = new OINOPostgresqlData(OINODB_EMPTY_ROWS, [OINO_ERROR_PREFIX + " (sqlSelect): exception in _db.query [" + e.message + "]"])
-        }
-        OINOBenchmark.endMetric("OINODb", "sqlSelect")
-        return result
-    }
-
-    /**
-     * Execute other sql operations.
-     * 
-     * @param sql SQL statement.
-     *
-     */
-    async sqlExec(sql:string): Promise<OINODbDataSet> {
-        OINOBenchmark.startMetric("OINODb", "sqlExec")
-        let result:OINODbDataSet
-        try {
-            const rows:OINODataRow[] = await this._exec(sql)
-            result = new OINOPostgresqlData(rows, [])
-
-        } catch (e:any) {
-            result = new OINOPostgresqlData(OINODB_EMPTY_ROWS, [OINO_ERROR_PREFIX + " (sqlExec): exception in _db.exec [" + e.message + "]"])
-        }
-        OINOBenchmark.endMetric("OINODb", "sqlExec")
-        return result
-    }
-
-    private _getSchemaSql(dbName:string, tableName:string):string {
-        const sql = 
-`SELECT 
-    col.column_name, 
-    col.data_type, 
-    col.character_maximum_length, 
-    col.is_nullable, 
-    con.constraint_type,
-    col.numeric_precision,
-    col.numeric_scale,
-    col.column_default
-FROM information_schema.columns col
-LEFT JOIN LATERAL
-    (select kcu.column_name, STRING_AGG(tco.constraint_type,',') as constraint_type
-    from 
-        information_schema.table_constraints tco,
-        information_schema.key_column_usage kcu 	 
-    where 
-        kcu.constraint_name = tco.constraint_name
-        and kcu.constraint_schema = tco.constraint_schema
-		and tco.table_catalog = col.table_catalog
-		and tco.table_name = col.table_name
-        and (tco.constraint_type = 'PRIMARY KEY' OR tco.constraint_type = 'FOREIGN KEY')
-	group by kcu.column_name) con on col.column_name = con.column_name
-WHERE col.table_catalog = '${dbName}' AND col.table_name = '${tableName}'`
-        return sql
-    }
-
-    private _getValidateSql(dbName:string):string {
-        const sql = 
-`SELECT 
-    count(col.column_name) AS column_count
-FROM information_schema.columns col
-LEFT JOIN LATERAL
-    (select kcu.column_name, STRING_AGG(tco.constraint_type,',') as constraint_type
-    from 
-        information_schema.table_constraints tco,
-        information_schema.key_column_usage kcu 	 
-    where 
-        kcu.constraint_name = tco.constraint_name
-        and kcu.constraint_schema = tco.constraint_schema
-		and tco.table_catalog = col.table_catalog
-		and tco.table_name = col.table_name
-        and (tco.constraint_type = 'PRIMARY KEY' OR tco.constraint_type = 'FOREIGN KEY')
-	group by kcu.column_name) con on col.column_name = con.column_name
-WHERE col.table_catalog = '${dbName}'`
-        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 schema_res:OINODbDataSet = await this.sqlSelect(this._getSchemaSql(this._params.database, api.params.tableName.toLowerCase()))
-        while (!schema_res.isEof()) {
-            const row:OINODataRow = schema_res.getRow()
-            const field_name:string = row[0]?.toString() || ""
-            const sql_type:string = row[1]?.toString() || ""
-            const field_length:number = this._parseFieldLength(row[2])
-            const constraints = row[4]?.toString() || ""
-            const numeric_precision:number = this._parseFieldLength(row[5])
-            const numeric_scale:number = this._parseFieldLength(row[6])
-            const default_val:string = row[7]?.toString() || ""
-            const field_params:OINODbDataFieldParams = {
-                isPrimaryKey: constraints.indexOf('PRIMARY KEY') >= 0 || false,
-                isForeignKey: constraints.indexOf('FOREIGN KEY') >= 0 || false,
-                isNotNull: row[3] == "NO",
-                isAutoInc: default_val.startsWith("nextval(")
-            }            
-            if (api.isFieldIncluded(field_name) == false) {
-                OINOLog.info("@oino-ts/db-postgresql", "OINODbPostgresql", "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 {
-                if ((sql_type == "integer") || (sql_type == "smallint") || (sql_type == "real")) {
-                    api.datamodel.addField(new OINONumberDataField(this, field_name, sql_type, field_params ))
-
-                } else if ((sql_type == "date")) {
-                    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 == "character") || (sql_type == "character varying") || (sql_type == "varchar") || (sql_type == "text")) {
-                    api.datamodel.addField(new OINOStringDataField(this, field_name, sql_type, field_params, field_length))
-
-                } else if ((sql_type == "bytea")) {
-                    api.datamodel.addField(new OINOBlobDataField(this, field_name, sql_type, field_params, field_length))
-
-                } else if ((sql_type == "boolean")) {
-                    api.datamodel.addField(new OINOBooleanDataField(this, field_name, sql_type, field_params))
-
-                } else if ((sql_type == "decimal") || (sql_type == "numeric")) {
-                    api.datamodel.addField(new OINOStringDataField(this, field_name, sql_type, field_params, numeric_precision + numeric_scale + 1))
-
-                } else {
-                    OINOLog.info("@oino-ts/db-postgresql", "OINODbPostgresql", "initializeApiDatamodel", "Unrecognized field type treated as string", {field_name: field_name, sql_type:sql_type, field_length:field_length, field_params:field_params })
-                    api.datamodel.addField(new OINOStringDataField(this, field_name, sql_type, field_params, 0))
-                }
-            }
-            await schema_res.next()
-        }
-        OINOLog.info("@oino-ts/db-postgresql", "OINODbPostgresql", "initializeApiDatamodel", "\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, OINOLog, OINOResult, OINODB_EMPTY_ROW, OINODB_EMPTY_ROWS } from "@oino-ts/db";
+
+import { Pool, QueryResult } from "pg";
+
+
+/**
+ * Implmentation of OINODbDataSet for Postgresql.
+ * 
+ */
+class OINOPostgresqlData extends OINODbDataSet {
+    private _rows:OINODataRow[]
+    
+    /**
+     * OINOPostgresqlData constructor
+     * @param params database parameters
+     */
+    constructor(data: unknown, messages:string[]=[]) {
+        super(data, messages)
+
+        if ((data != null) && !(Array.isArray(data))) {
+            throw new Error(OINO_ERROR_PREFIX + ": Invalid Posgresql data type!") // TODO: maybe check all rows
+        }
+        this._rows = data as OINODataRow[]
+        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> {
+        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
+        }
+    }
+
+    /**
+     * Gets all rows of data.
+     *
+     */
+    async getAllRows(): Promise<OINODataRow[]> {
+        return this._rows // at the moment theres no result streaming, so we can just return the rows
+    }    
+}
+
+/**
+ * Implementation of Postgresql-database.
+ * 
+ */
+export class OINODbPostgresql extends OINODb {
+    
+    private _pool:Pool
+
+    /**
+     * Constructor of `OINODbPostgresql`
+     * @param params database paraneters
+     */
+    constructor(params:OINODbParams) {
+        super(params)
+
+        if (this._params.type !== "OINODbPostgresql") {
+            throw new Error(OINO_ERROR_PREFIX + ": Not OINODbPostgresql-type: " + this._params.type)
+        } 
+        const ssl_enabled:boolean = !(this._params.url == "localhost" || this._params.url == "127.0.0.1")
+        this._pool = new Pool({ host: this._params.url, database: this._params.database, port: this._params.port, user: this._params.user, password: this._params.password, ssl: ssl_enabled })
+        delete this._params.password
+
+        this._pool.on("error", (err: any) => {
+            OINOLog.error("@oino-ts/db-postgresql", "OINODbPostgresql", ".on(error)", "Error-event", {err:err}) 
+        })
+    }
+
+    private _parseFieldLength(fieldLength:OINODataCell):number {
+        let result:number = parseInt((fieldLength || "0").toString())
+        if (Number.isNaN(result)) {
+            result = 0
+        }
+        return result
+    }
+
+    private async _query(sql:string):Promise<OINODataRow[]> {
+        const query_result:QueryResult = await this._pool.query({rowMode: "array", text: sql})
+        return Promise.resolve(query_result.rows)
+    }
+
+    private async _exec(sql:string):Promise<OINODataRow[]> {
+        const query_result:QueryResult = await this._pool.query({rowMode: "array", text: sql})
+        if (Array.isArray(query_result) == true) {
+            return Promise.resolve(query_result.flatMap((q) => q.rows))
+        } else if (query_result.rows) {
+            return Promise.resolve(query_result.rows)
+        } else {
+            return Promise.resolve(OINODB_EMPTY_ROWS) // return empty row if no rows returned
+        }
+    }
+
+    /**
+     * Print a table name using database specific SQL escaping.
+     * 
+     * @param sqlTable name of the table
+     *
+     */
+    printSqlTablename(sqlTable:string): string {
+        return "\""+sqlTable.toLowerCase()+"\""
+    }
+
+    /**
+     * 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 {
+        if (cellValue === null) {
+            return "NULL"
+
+        } else if (cellValue === undefined) {
+            return "UNDEFINED"
+
+        } else if ((sqlType == "integer") || (sqlType == "smallint") || (sqlType == "real")) {
+            return cellValue.toString()
+
+        } else if (sqlType == "bytea") {
+            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 == "boolean") {
+            if (cellValue == null || cellValue == "" || cellValue.toString().toLowerCase() == "false" || cellValue == "0") { 
+                return "false"
+            } else {
+                return "true"
+            }
+
+        } else if ((sqlType == "date") && (cellValue instanceof Date)) {
+            return "\'" + cellValue.toISOString() + "\'"
+
+        } 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("'", "''") + "\'"
+    }
+
+
+    /**
+     * 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 {
+        if ((sqlValue === null) || (sqlValue == "NULL")) {
+            return null
+
+        } else if (sqlValue === undefined) {
+            return undefined
+
+        } else if (((sqlType == "date")) && (typeof(sqlValue) == "string") && (sqlValue != "")) {
+            return new Date(sqlValue)
+
+        } else {
+            return sqlValue
+        }
+
+    }
+
+    /**
+     * Connect to database.
+     *
+     */
+    async connect(): Promise<OINOResult> {
+        let result:OINOResult = new OINOResult()
+        try {
+            // make sure that any items are correctly URL encoded in the connection string
+            await this._pool.connect()
+            this.isConnected = true
+
+        } catch (e:any) {
+            result.setError(500, "Exception connecting to database: " + e.message, "OINODbPostgresql.connect")
+            OINOLog.exception("@oino-ts/db-postgresql", "OINODbMsSql", "connect", "exception in connect", {message:e.message, stack:e.stack}) 
+        }        
+        return result
+    }
+
+    /**
+     * Validate connection to database is working. 
+     *
+     */
+    async validate(): Promise<OINOResult> {
+        OINOBenchmark.startMetric("OINODb", "validate")
+        let result:OINOResult = new OINOResult()
+        try {
+            const sql = this._getValidateSql(this._params.database)
+            const sql_res:OINODbDataSet = await this.sqlSelect(sql)
+            if (sql_res.isEmpty()) {
+                result.setError(400, "DB returned no rows for select!", "OINODbPostgresql.validate")
+
+            } else if (sql_res.getRow().length == 0) {
+                result.setError(400, "DB returned no values for database!", "OINODbPostgresql.validate")
+
+            } else if (sql_res.getRow()[0] == "0") {
+                result.setError(400, "DB returned no schema for database!", "OINODbPostgresql.validate")
+
+            } else {
+                this.isValidated = true
+            }
+        } catch (e:any) {
+            result.setError(500, "Exception validating connection: " + e.message, "OINODbPostgresql.validate")
+            OINOLog.exception("@oino-ts/db-postgresql", "OINODbMsSql", "validate", "exception in validate", {message:e.message, stack:e.stack}) 
+        }
+        OINOBenchmark.endMetric("OINODb", "validate")
+        return result
+    }
+
+    /**
+     * Execute a select operation.
+     * 
+     * @param sql SQL statement.
+     *
+     */
+    async sqlSelect(sql:string): Promise<OINODbDataSet> {
+        OINOBenchmark.startMetric("OINODb", "sqlSelect")
+        let result:OINODbDataSet
+        try {
+            const rows:OINODataRow[] = await this._query(sql)
+            result = new OINOPostgresqlData(rows, [])
+
+        } catch (e:any) {
+            result = new OINOPostgresqlData(OINODB_EMPTY_ROWS, [OINO_ERROR_PREFIX + " (sqlSelect): exception in _db.query [" + e.message + "]"])
+        }
+        OINOBenchmark.endMetric("OINODb", "sqlSelect")
+        return result
+    }
+
+    /**
+     * Execute other sql operations.
+     * 
+     * @param sql SQL statement.
+     *
+     */
+    async sqlExec(sql:string): Promise<OINODbDataSet> {
+        OINOBenchmark.startMetric("OINODb", "sqlExec")
+        let result:OINODbDataSet
+        try {
+            const rows:OINODataRow[] = await this._exec(sql)
+            result = new OINOPostgresqlData(rows, [])
+
+        } catch (e:any) {
+            result = new OINOPostgresqlData(OINODB_EMPTY_ROWS, [OINO_ERROR_PREFIX + " (sqlExec): exception in _db.exec [" + e.message + "]"])
+        }
+        OINOBenchmark.endMetric("OINODb", "sqlExec")
+        return result
+    }
+
+    private _getSchemaSql(dbName:string, tableName:string):string {
+        const sql = 
+`SELECT 
+    col.column_name, 
+    col.data_type, 
+    col.character_maximum_length, 
+    col.is_nullable, 
+    con.constraint_type,
+    col.numeric_precision,
+    col.numeric_scale,
+    col.column_default
+FROM information_schema.columns col
+LEFT JOIN LATERAL
+    (select kcu.column_name, STRING_AGG(tco.constraint_type,',') as constraint_type
+    from 
+        information_schema.table_constraints tco,
+        information_schema.key_column_usage kcu 	 
+    where 
+        kcu.constraint_name = tco.constraint_name
+        and kcu.constraint_schema = tco.constraint_schema
+		and tco.table_catalog = col.table_catalog
+		and tco.table_name = col.table_name
+        and (tco.constraint_type = 'PRIMARY KEY' OR tco.constraint_type = 'FOREIGN KEY')
+	group by kcu.column_name) con on col.column_name = con.column_name
+WHERE col.table_catalog = '${dbName}' AND col.table_name = '${tableName}'`
+        return sql
+    }
+
+    private _getValidateSql(dbName:string):string {
+        const sql = 
+`SELECT 
+    count(col.column_name) AS column_count
+FROM information_schema.columns col
+LEFT JOIN LATERAL
+    (select kcu.column_name, STRING_AGG(tco.constraint_type,',') as constraint_type
+    from 
+        information_schema.table_constraints tco,
+        information_schema.key_column_usage kcu 	 
+    where 
+        kcu.constraint_name = tco.constraint_name
+        and kcu.constraint_schema = tco.constraint_schema
+		and tco.table_catalog = col.table_catalog
+		and tco.table_name = col.table_name
+        and (tco.constraint_type = 'PRIMARY KEY' OR tco.constraint_type = 'FOREIGN KEY')
+	group by kcu.column_name) con on col.column_name = con.column_name
+WHERE col.table_catalog = '${dbName}'`
+        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 schema_res:OINODbDataSet = await this.sqlSelect(this._getSchemaSql(this._params.database, api.params.tableName.toLowerCase()))
+        while (!schema_res.isEof()) {
+            const row:OINODataRow = schema_res.getRow()
+            const field_name:string = row[0]?.toString() || ""
+            const sql_type:string = row[1]?.toString() || ""
+            const field_length:number = this._parseFieldLength(row[2])
+            const constraints = row[4]?.toString() || ""
+            const numeric_precision:number = this._parseFieldLength(row[5])
+            const numeric_scale:number = this._parseFieldLength(row[6])
+            const default_val:string = row[7]?.toString() || ""
+            const field_params:OINODbDataFieldParams = {
+                isPrimaryKey: constraints.indexOf('PRIMARY KEY') >= 0 || false,
+                isForeignKey: constraints.indexOf('FOREIGN KEY') >= 0 || false,
+                isNotNull: row[3] == "NO",
+                isAutoInc: default_val.startsWith("nextval(")
+            }            
+            if (api.isFieldIncluded(field_name) == false) {
+                OINOLog.info("@oino-ts/db-postgresql", "OINODbPostgresql", "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 {
+                if ((sql_type == "integer") || (sql_type == "smallint") || (sql_type == "real")) {
+                    api.datamodel.addField(new OINONumberDataField(this, field_name, sql_type, field_params ))
+
+                } else if ((sql_type == "date")) {
+                    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 == "character") || (sql_type == "character varying") || (sql_type == "varchar") || (sql_type == "text")) {
+                    api.datamodel.addField(new OINOStringDataField(this, field_name, sql_type, field_params, field_length))
+
+                } else if ((sql_type == "bytea")) {
+                    api.datamodel.addField(new OINOBlobDataField(this, field_name, sql_type, field_params, field_length))
+
+                } else if ((sql_type == "boolean")) {
+                    api.datamodel.addField(new OINOBooleanDataField(this, field_name, sql_type, field_params))
+
+                } else if ((sql_type == "decimal") || (sql_type == "numeric")) {
+                    api.datamodel.addField(new OINOStringDataField(this, field_name, sql_type, field_params, numeric_precision + numeric_scale + 1))
+
+                } else {
+                    OINOLog.info("@oino-ts/db-postgresql", "OINODbPostgresql", "initializeApiDatamodel", "Unrecognized field type treated as string", {field_name: field_name, sql_type:sql_type, field_length:field_length, field_params:field_params })
+                    api.datamodel.addField(new OINOStringDataField(this, field_name, sql_type, field_params, 0))
+                }
+            }
+            await schema_res.next()
+        }
+        OINOLog.info("@oino-ts/db-postgresql", "OINODbPostgresql", "initializeApiDatamodel", "\n" + api.datamodel.printDebug("\n"))
+        return Promise.resolve()
+    }
+}
+
+
+

package/src/index.ts

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