@oino-ts/db-postgresql 0.0.15 → 0.0.16

package/README.md

@@ -10,15 +10,15 @@
  # GETTING STARTED
  
  ### Setup
- Install the `@oino-ts/core` npm package and necessary database packages and import them in your code.
+ Install the `@oino-ts/db` npm package and necessary database packages and import them in your code.
  ```
- bun install @oino-ts/core
- bun install @oino-ts/bunsqlite
+ bun install @oino-ts/db
+ bun install @oino-ts/db-bunsqlite
  ```
  
  ```
- import { OINODb, OINOApi, OINOFactory } from "@oino-ts/core";
- import { OINODbBunSqlite } from "@oino-ts/bunsqlite"
+ import { OINODb, OINOApi, OINOFactory } from "@oino-ts/db";
+ import { OINODbBunSqlite } from "@oino-ts/db-bunsqlite"
  ```
  
  ### Register database and logger
@@ -51,7 +51,7 @@
  ### 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.modelset.writeString(OINOContentType.json))
+ return new Response(result.data.writeString(OINOContentType.json))
  ```
  
  
@@ -129,12 +129,13 @@
  - 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
 
  ## Complex 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 controls the SQL, WHERE-conditions can be defined with [`OINOSqlFilter`](https://pragmatta.github.io/oino-ts/classes/db_src.OINODbSqlFilter.html) and order with [`OINOSqlOrder`](https://pragmatta.github.io/oino-ts/classes/db_src.OINODbSqlOrder.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.
+ Since OINO is just generating SQL, WHERE-conditions can be defined with [`OINOSqlFilter`](https://pragmatta.github.io/oino-ts/classes/db_src.OINODbSqlFilter.html) and order with [`OINOSqlOrder`](https://pragmatta.github.io/oino-ts/classes/db_src.OINODbSqlOrder.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.
@@ -158,7 +159,7 @@
  # 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
+ ## Beta 
  For a beta status following milestones are planned:
 
  ### Realistic app
@@ -205,14 +206,16 @@
  # 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 support by [node-postgres package](https://www.npmjs.com/package/pg)
- - Mariadb / Mysql-support by [mariadb package](https://www.npmjs.com/package/mariadb)
+ - 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.

package/dist/cjs/OINODbPostgresql.js

@@ -36,14 +36,25 @@ class OINOPostgresqlData extends db_1.OINODbDataSet {
     }
     _currentRow;
     _eof;
+    /**
+     * Is data set empty.
+     *
+     */
     isEmpty() {
         return (this._rows.length == 0);
     }
-    // EOF means "there is no more content", i.e. either dataset is empty or we have moved beyond last line
+    /**
+     * Is there no more content, i.e. either dataset is empty or we have moved beyond last line
+     *
+     */
     isEof() {
         return (this._eof);
     }
-    next() {
+    /**
+     * Attempts to moves dataset to the next row, possibly waiting for more data to become available. Returns !isEof().
+     *
+     */
+    async next() {
         // OINOLog.debug("OINODbDataSet.next", {currentRow:this._currentRow, length:this.sqlResult.data.length})
         if (this._currentRow < this._rows.length - 1) {
             this._currentRow = this._currentRow + 1;
@@ -51,8 +62,12 @@ class OINOPostgresqlData extends db_1.OINODbDataSet {
         else {
             this._eof = true;
         }
-        return !this._eof;
+        return Promise.resolve(!this._eof);
     }
+    /**
+     * Gets current row of data.
+     *
+     */
     getRow() {
         if ((this._currentRow >= 0) && (this._currentRow < this._rows.length)) {
             return this._rows[this._currentRow];
@@ -67,29 +82,6 @@ class OINOPostgresqlData extends db_1.OINODbDataSet {
  *
  */
 class OINODbPostgresql extends db_1.OINODb {
-    static table_schema_sql = `SELECT 
-    col.column_name, 
-    col.data_type, 
-    col.character_maximum_length, 
-    col.is_nullable, 
-    pk.primary_key,
-    col.numeric_precision,
-    col.numeric_scale,
-    col.column_default
-FROM information_schema.columns col
-LEFT JOIN LATERAL
-	(select kcu.column_name, 'YES' as primary_key
-	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_name = col.table_name
-		and tco.constraint_type = 'PRIMARY KEY'
-	) pk on col.column_name = pk.column_name
-WHERE table_name = `;
-    // private _client:Client
     _pool;
     /**
      * Constructor of `OINODbPostgresql`
@@ -275,6 +267,31 @@ WHERE table_name = `;
         db_1.OINOBenchmark.end("OINODb", "sqlExec");
         return result;
     }
+    _getSchemaSql(dbName, tableName) {
+        const sql = `SELECT 
+    col.column_name, 
+    col.data_type, 
+    col.character_maximum_length, 
+    col.is_nullable, 
+    pk.primary_key,
+    col.numeric_precision,
+    col.numeric_scale,
+    col.column_default
+FROM information_schema.columns col
+LEFT JOIN LATERAL
+    (select kcu.column_name, 'YES' as primary_key
+    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_name = col.table_name
+        and tco.constraint_type = 'PRIMARY KEY'
+    ) pk on col.column_name = pk.column_name
+WHERE col.table_catalog = '${dbName}' AND col.table_name = '${tableName}'`;
+        return sql;
+    }
     /**
      * Initialize a data model by getting the SQL schema and populating OINODbDataFields of
      * the model.
@@ -283,7 +300,7 @@ WHERE table_name = `;
      *
      */
     async initializeApiDatamodel(api) {
-        const res = await this.sqlSelect(OINODbPostgresql.table_schema_sql + "'" + api.params.tableName.toLowerCase() + "';");
+        const res = await this.sqlSelect(this._getSchemaSql(this._params.database, api.params.tableName.toLowerCase()));
         // OINOLog.debug("OINODbPostgresql.initializeApiDatamodel: table description ", {res: res })
         while (!res.isEof()) {
             const row = res.getRow();
@@ -329,7 +346,7 @@ WHERE table_name = `;
                     api.datamodel.addField(new db_1.OINOStringDataField(this, field_name, sql_type, field_params, 0));
                 }
             }
-            res.next();
+            await res.next();
         }
         db_1.OINOLog.debug("OINODbPostgresql.initializeDatasetModel:\n" + api.datamodel.printDebug("\n"));
         return Promise.resolve();

package/dist/esm/OINODbPostgresql.js

@@ -33,14 +33,25 @@ class OINOPostgresqlData extends OINODbDataSet {
     }
     _currentRow;
     _eof;
+    /**
+     * Is data set empty.
+     *
+     */
     isEmpty() {
         return (this._rows.length == 0);
     }
-    // EOF means "there is no more content", i.e. either dataset is empty or we have moved beyond last line
+    /**
+     * Is there no more content, i.e. either dataset is empty or we have moved beyond last line
+     *
+     */
     isEof() {
         return (this._eof);
     }
-    next() {
+    /**
+     * Attempts to moves dataset to the next row, possibly waiting for more data to become available. Returns !isEof().
+     *
+     */
+    async next() {
         // OINOLog.debug("OINODbDataSet.next", {currentRow:this._currentRow, length:this.sqlResult.data.length})
         if (this._currentRow < this._rows.length - 1) {
             this._currentRow = this._currentRow + 1;
@@ -48,8 +59,12 @@ class OINOPostgresqlData extends OINODbDataSet {
         else {
             this._eof = true;
         }
-        return !this._eof;
+        return Promise.resolve(!this._eof);
     }
+    /**
+     * Gets current row of data.
+     *
+     */
     getRow() {
         if ((this._currentRow >= 0) && (this._currentRow < this._rows.length)) {
             return this._rows[this._currentRow];
@@ -64,29 +79,6 @@ class OINOPostgresqlData extends OINODbDataSet {
  *
  */
 export class OINODbPostgresql extends OINODb {
-    static table_schema_sql = `SELECT 
-    col.column_name, 
-    col.data_type, 
-    col.character_maximum_length, 
-    col.is_nullable, 
-    pk.primary_key,
-    col.numeric_precision,
-    col.numeric_scale,
-    col.column_default
-FROM information_schema.columns col
-LEFT JOIN LATERAL
-	(select kcu.column_name, 'YES' as primary_key
-	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_name = col.table_name
-		and tco.constraint_type = 'PRIMARY KEY'
-	) pk on col.column_name = pk.column_name
-WHERE table_name = `;
-    // private _client:Client
     _pool;
     /**
      * Constructor of `OINODbPostgresql`
@@ -272,6 +264,31 @@ WHERE table_name = `;
         OINOBenchmark.end("OINODb", "sqlExec");
         return result;
     }
+    _getSchemaSql(dbName, tableName) {
+        const sql = `SELECT 
+    col.column_name, 
+    col.data_type, 
+    col.character_maximum_length, 
+    col.is_nullable, 
+    pk.primary_key,
+    col.numeric_precision,
+    col.numeric_scale,
+    col.column_default
+FROM information_schema.columns col
+LEFT JOIN LATERAL
+    (select kcu.column_name, 'YES' as primary_key
+    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_name = col.table_name
+        and tco.constraint_type = 'PRIMARY KEY'
+    ) pk on col.column_name = pk.column_name
+WHERE col.table_catalog = '${dbName}' AND col.table_name = '${tableName}'`;
+        return sql;
+    }
     /**
      * Initialize a data model by getting the SQL schema and populating OINODbDataFields of
      * the model.
@@ -280,7 +297,7 @@ WHERE table_name = `;
      *
      */
     async initializeApiDatamodel(api) {
-        const res = await this.sqlSelect(OINODbPostgresql.table_schema_sql + "'" + api.params.tableName.toLowerCase() + "';");
+        const res = await this.sqlSelect(this._getSchemaSql(this._params.database, api.params.tableName.toLowerCase()));
         // OINOLog.debug("OINODbPostgresql.initializeApiDatamodel: table description ", {res: res })
         while (!res.isEof()) {
             const row = res.getRow();
@@ -326,7 +343,7 @@ WHERE table_name = `;
                     api.datamodel.addField(new OINOStringDataField(this, field_name, sql_type, field_params, 0));
                 }
             }
-            res.next();
+            await res.next();
         }
         OINOLog.debug("OINODbPostgresql.initializeDatasetModel:\n" + api.datamodel.printDebug("\n"));
         return Promise.resolve();

package/dist/types/OINODbPostgresql.d.ts

@@ -4,7 +4,6 @@ import { OINODb, OINODbParams, OINODbDataSet, OINODbApi, OINODataCell } from "@o
  *
  */
 export declare class OINODbPostgresql extends OINODb {
-    private static table_schema_sql;
     private _pool;
     /**
      * Constructor of `OINODbPostgresql`
@@ -65,6 +64,7 @@ export declare class OINODbPostgresql extends OINODb {
      *
      */
     sqlExec(sql: string): Promise<OINODbDataSet>;
+    private _getSchemaSql;
     /**
      * Initialize a data model by getting the SQL schema and populating OINODbDataFields of
      * the model.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oino-ts/db-postgresql",
-  "version": "0.0.15",
+  "version": "0.0.16",
   "description": "OINO TS package for using Postgresql databases.",
   "author": "Matias Kiviniemi (pragmatta)",
   "license": "MPL-2.0",
@@ -20,7 +20,7 @@
   "module": "./dist/esm/index.js",
   "types": "./dist/types/index.d.ts",
   "dependencies": {
-    "@oino-ts/db": "^0.0.15",
+    "@oino-ts/db": "^0.0.16",
     "pg": "^8.11.3"
   },
   "devDependencies": {

package/src/OINODbPostgresql.ts

@@ -38,25 +38,41 @@ class OINOPostgresqlData extends OINODbDataSet {
     }
     private _currentRow: number
     private _eof: boolean
+
+    /**
+     * Is data set empty.
+     *
+     */
     isEmpty():boolean {
         return (this._rows.length == 0)
     }
 
-    // EOF means "there is no more content", i.e. either dataset is empty or we have moved beyond last line
+    /**
+     * Is there no more content, i.e. either dataset is empty or we have moved beyond last line
+     *
+     */
     isEof():boolean {
         return (this._eof)
     }
 
-    next():boolean {
+    /**
+     * 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 !this._eof
+        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]
@@ -72,31 +88,6 @@ class OINOPostgresqlData extends OINODbDataSet {
  */
 export class OINODbPostgresql extends OINODb {
     
-    private static table_schema_sql:string =
-`SELECT 
-    col.column_name, 
-    col.data_type, 
-    col.character_maximum_length, 
-    col.is_nullable, 
-    pk.primary_key,
-    col.numeric_precision,
-    col.numeric_scale,
-    col.column_default
-FROM information_schema.columns col
-LEFT JOIN LATERAL
-	(select kcu.column_name, 'YES' as primary_key
-	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_name = col.table_name
-		and tco.constraint_type = 'PRIMARY KEY'
-	) pk on col.column_name = pk.column_name
-WHERE table_name = `
-    
-    // private _client:Client
     private _pool:Pool
 
     /**
@@ -292,6 +283,33 @@ WHERE table_name = `
         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, 
+    pk.primary_key,
+    col.numeric_precision,
+    col.numeric_scale,
+    col.column_default
+FROM information_schema.columns col
+LEFT JOIN LATERAL
+    (select kcu.column_name, 'YES' as primary_key
+    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_name = col.table_name
+        and tco.constraint_type = 'PRIMARY KEY'
+    ) pk on col.column_name = pk.column_name
+WHERE col.table_catalog = '${dbName}' AND col.table_name = '${tableName}'`
+        return sql
+    }
+
     /**
      * Initialize a data model by getting the SQL schema and populating OINODbDataFields of 
      * the model.
@@ -301,7 +319,7 @@ WHERE table_name = `
      */
     async initializeApiDatamodel(api:OINODbApi): Promise<void> {
         
-        const res:OINODbDataSet = await this.sqlSelect(OINODbPostgresql.table_schema_sql + "'" + api.params.tableName.toLowerCase() + "';")
+        const res:OINODbDataSet = await this.sqlSelect(this._getSchemaSql(this._params.database, api.params.tableName.toLowerCase()))
         // OINOLog.debug("OINODbPostgresql.initializeApiDatamodel: table description ", {res: res })
         while (!res.isEof()) {
             const row:OINODataRow = res.getRow()
@@ -346,7 +364,7 @@ WHERE table_name = `
                     api.datamodel.addField(new OINOStringDataField(this, field_name, sql_type, field_params, 0))
                 }   
             }
-            res.next()
+            await res.next()
         }
         OINOLog.debug("OINODbPostgresql.initializeDatasetModel:\n" + api.datamodel.printDebug("\n"))
         return Promise.resolve()