@bdkinc/knex-ibmi 0.0.11 → 0.0.13

package/README.md

@@ -17,9 +17,9 @@ This is an external dialect for [knex](https://github.com/tgriesser/knex). This
 Currently, this dialect has limited functionality compared to the Knex built-in dialects. Below are some of the limitations:
 
 - No streaming support
-- Updates return the value of the first column in that row. Make sure your identifier is the first column in the table. The returning option does not work on updates. 
+- Updates return the value of the first column in that row. Make sure your identifier is the first column in the table. The returning option does not work on updates.
 - Possibly other missing functionality
-- Journaling must be handled separately. After a migration is ran journaling can be configured on the newly created tables. I recommend using the schema utility in the i access client solutions software. 
+- Journaling must be handled separately. After a migration is ran journaling can be configured on the newly created tables. I recommend using the schema utility in the i access client solutions software.
 
 ## Installing
 
@@ -105,6 +105,98 @@ try {
 }
 ```
 
+or as Typescript
+
+```typescript
+import knex from "knex";
+import { Db2Dialect, DB2Config } from "knex-ibmi";
+
+const config: DB2Config = {
+  client: Db2Dialect,
+  connection: {
+    host: "localhost",
+    database: "knextest",
+    port: 50000,
+    user: "<user>",
+    password: "<password>",
+    driver: "IBM i Access ODBC Driver",
+    connectionStringParams: {
+      ALLOWPROCCALLS: 1,
+      CMT: 0,
+    },
+  },
+  pool: {
+    min: 2,
+    max: 10,
+  },
+}
+
+const db = knex(config);
+
+try {
+  const data = await db.select("*").from("table").where({ foo: "bar" });
+  console.log(data);
+} catch (err) {
+  throw new Error(err);
+} finally {
+  process.exit();
+}
+```
+
+## Pooling
+
+There are 2 different pooling configurations, Tarn pooling and the Node-ODBC pooling. 
+Where the pool property is positioned dictates which pooling is used. To use node-odbc pooling the pool object needs to 
+be a property inside the connection object. Examples below
+
+Tarn Pooling Configuration
+
+```javascript
+const db = knex({
+  client: Db2Dialect,
+  connection: {
+    host: "localhost",
+    database: "knextest",
+    port: 50000,
+    user: "<user>",
+    password: "<password>",
+    driver: "IBM i Access ODBC Driver",
+    connectionStringParams: {
+      ALLOWPROCCALLS: 1,
+      CMT: 0,
+    },
+  },
+  pool: {
+    min: 2,
+    max: 10,
+  },
+});
+```
+
+Node-ODBC Pooling Configuration
+
+```javascript
+const db = knex({
+  client: Db2Dialect,
+  connection: {
+    host: "localhost",
+    database: "knextest",
+    port: 50000,
+    user: "<user>",
+    password: "<password>",
+    driver: "IBM i Access ODBC Driver",
+    connectionStringParams: {
+      ALLOWPROCCALLS: 1,
+      CMT: 0,
+    },
+    pool: {
+      min: 2,
+      max: 10,
+    },
+  },
+});
+```
+
 ## Configuring your driver
 
 If you don't know the name of your installed driver, then look in `odbcinst.ini`. You can find the full path of the file by running `odbcinst -j`.

package/dist/index.d.mts

@@ -0,0 +1,91 @@
+import * as odbc from 'odbc';
+import { Connection } from 'odbc';
+import { knex, Knex } from 'knex';
+import SchemaCompiler from 'knex/lib/schema/compiler';
+import TableCompiler from 'knex/lib/schema/tablecompiler';
+import ColumnCompiler from 'knex/lib/schema/columncompiler';
+import QueryCompiler from 'knex/lib/query/querycompiler';
+
+declare class IBMiSchemaCompiler extends SchemaCompiler {
+    hasTable(tableName: any): void;
+    toSQL(): any;
+}
+
+declare class IBMiTableCompiler extends TableCompiler {
+    createQuery(columns: any, ifNot: any, like: any): void;
+    dropUnique(columns: any, indexName: any): void;
+    unique(columns: any, indexName: any): void;
+    addColumns(columns: any, prefix: any): void;
+    commit(conn: any, value: any): Promise<any>;
+}
+
+declare class IBMiColumnCompiler extends ColumnCompiler {
+    increments(options?: {
+        primaryKey: boolean;
+    }): string;
+}
+
+declare class IBMiQueryCompiler extends QueryCompiler {
+    insert(): "" | {
+        sql: string;
+        returning: any;
+    };
+    _buildInsertData(insertValues: any, returningSql: any): string;
+    _prepInsert(data: any): any;
+    _returning(method: any, value: any, withTrigger: any): string | undefined;
+    columnizeWithPrefix(prefix: any, target: any): string;
+}
+
+declare class DB2Client extends knex.Client {
+    constructor(config: any);
+    _driver(): typeof odbc;
+    printDebug(message: string): void;
+    acquireRawConnection(): Promise<any>;
+    destroyRawConnection(connection: Connection): Promise<void>;
+    _getConnectionString(connectionConfig: any): string;
+    _query(connection: any, obj: any): Promise<any>;
+    _selectAfterUpdate(): string;
+    transaction(container: any, config: any, outerTx: any): Knex.Transaction;
+    schemaCompiler(): IBMiSchemaCompiler;
+    tableCompiler(): IBMiTableCompiler;
+    columnCompiler(): IBMiColumnCompiler;
+    queryCompiler(): IBMiQueryCompiler;
+    processResponse(obj: any, runner: any): any;
+}
+interface DB2PoolConfig {
+    min: number;
+    max: number;
+}
+interface DB2ConnectionParams {
+    CMT?: number;
+    CONNTYPE?: number;
+    DBQ?: string;
+    MAXDECPREC?: 31 | 63;
+    MAXDECSCALE?: number;
+    MINDIVSCALE?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9;
+    NAM?: 0 | 1;
+    DFT?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
+    DSP?: 0 | 1 | 2 | 3 | 4;
+    DEC?: 0 | 1;
+    DECFLOATERROROPTION?: 0 | 1;
+    DECFLOATROUNDMODE?: 0 | 1 | 2 | 3 | 4 | 5 | 6;
+    MAPDECIMALFLOATDESCRIBE?: 1 | 3;
+}
+interface DB2ConnectionConfig {
+    database: string;
+    host: string;
+    port: 50000 | number;
+    user: string;
+    password: string;
+    driver: "IBM i Access ODBC Driver" | string;
+    connectionStringParams?: DB2ConnectionParams;
+    pool?: DB2PoolConfig;
+}
+interface DB2Config {
+    client: any;
+    connection: DB2ConnectionConfig;
+    pool?: DB2PoolConfig;
+}
+declare const DB2Dialect: typeof DB2Client;
+
+export { DB2Config, DB2Dialect, DB2Client as default };

package/dist/index.d.ts

@@ -0,0 +1,91 @@
+import * as odbc from 'odbc';
+import { Connection } from 'odbc';
+import { knex, Knex } from 'knex';
+import SchemaCompiler from 'knex/lib/schema/compiler';
+import TableCompiler from 'knex/lib/schema/tablecompiler';
+import ColumnCompiler from 'knex/lib/schema/columncompiler';
+import QueryCompiler from 'knex/lib/query/querycompiler';
+
+declare class IBMiSchemaCompiler extends SchemaCompiler {
+    hasTable(tableName: any): void;
+    toSQL(): any;
+}
+
+declare class IBMiTableCompiler extends TableCompiler {
+    createQuery(columns: any, ifNot: any, like: any): void;
+    dropUnique(columns: any, indexName: any): void;
+    unique(columns: any, indexName: any): void;
+    addColumns(columns: any, prefix: any): void;
+    commit(conn: any, value: any): Promise<any>;
+}
+
+declare class IBMiColumnCompiler extends ColumnCompiler {
+    increments(options?: {
+        primaryKey: boolean;
+    }): string;
+}
+
+declare class IBMiQueryCompiler extends QueryCompiler {
+    insert(): "" | {
+        sql: string;
+        returning: any;
+    };
+    _buildInsertData(insertValues: any, returningSql: any): string;
+    _prepInsert(data: any): any;
+    _returning(method: any, value: any, withTrigger: any): string | undefined;
+    columnizeWithPrefix(prefix: any, target: any): string;
+}
+
+declare class DB2Client extends knex.Client {
+    constructor(config: any);
+    _driver(): typeof odbc;
+    printDebug(message: string): void;
+    acquireRawConnection(): Promise<any>;
+    destroyRawConnection(connection: Connection): Promise<void>;
+    _getConnectionString(connectionConfig: any): string;
+    _query(connection: any, obj: any): Promise<any>;
+    _selectAfterUpdate(): string;
+    transaction(container: any, config: any, outerTx: any): Knex.Transaction;
+    schemaCompiler(): IBMiSchemaCompiler;
+    tableCompiler(): IBMiTableCompiler;
+    columnCompiler(): IBMiColumnCompiler;
+    queryCompiler(): IBMiQueryCompiler;
+    processResponse(obj: any, runner: any): any;
+}
+interface DB2PoolConfig {
+    min: number;
+    max: number;
+}
+interface DB2ConnectionParams {
+    CMT?: number;
+    CONNTYPE?: number;
+    DBQ?: string;
+    MAXDECPREC?: 31 | 63;
+    MAXDECSCALE?: number;
+    MINDIVSCALE?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9;
+    NAM?: 0 | 1;
+    DFT?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
+    DSP?: 0 | 1 | 2 | 3 | 4;
+    DEC?: 0 | 1;
+    DECFLOATERROROPTION?: 0 | 1;
+    DECFLOATROUNDMODE?: 0 | 1 | 2 | 3 | 4 | 5 | 6;
+    MAPDECIMALFLOATDESCRIBE?: 1 | 3;
+}
+interface DB2ConnectionConfig {
+    database: string;
+    host: string;
+    port: 50000 | number;
+    user: string;
+    password: string;
+    driver: "IBM i Access ODBC Driver" | string;
+    connectionStringParams?: DB2ConnectionParams;
+    pool?: DB2PoolConfig;
+}
+interface DB2Config {
+    client: any;
+    connection: DB2ConnectionConfig;
+    pool?: DB2PoolConfig;
+}
+declare const DB2Dialect: typeof DB2Client;
+
+export { DB2Config, DB2Dialect, DB2Client as default };

package/dist/index.js

@@ -361,15 +361,20 @@ var DB2Client = class extends import_knex.knex.Client {
     this.printDebug("acquiring raw connection");
     const connectionConfig = this.config.connection;
     console.log(this._getConnectionString(connectionConfig));
-    if (this.pool) {
+    console.log({ config: this.config, pool: this.pool });
+    if (this.config?.connection?.pool) {
       const poolConfig = {
         connectionString: this._getConnectionString(connectionConfig),
-        connectionTimeout: this.config.connection?.acquireConnectionTimeout || 6e4,
-        initialSize: this.config.connection?.pool?.min || 2,
-        maxSize: this.config.connection?.pool?.max || 10,
+        connectionTimeout: (
+          // @ts-ignore
+          this.config?.connection?.acquireConnectionTimeout || 6e4
+        ),
+        // @ts-ignore
+        initialSize: this.config?.connection?.pool?.min || 2,
+        // @ts-ignore
+        maxSize: this.config?.connection?.pool?.max || 10,
         reuseConnection: true
       };
-      console.log({ config: this.config, pool: this.pool, poolConfig });
       const pool = await this.driver.pool(poolConfig);
       return await pool.connect();
     }

package/dist/index.mjs

@@ -326,15 +326,20 @@ var DB2Client = class extends knex.Client {
     this.printDebug("acquiring raw connection");
     const connectionConfig = this.config.connection;
     console.log(this._getConnectionString(connectionConfig));
-    if (this.pool) {
+    console.log({ config: this.config, pool: this.pool });
+    if (this.config?.connection?.pool) {
       const poolConfig = {
         connectionString: this._getConnectionString(connectionConfig),
-        connectionTimeout: this.config.connection?.acquireConnectionTimeout || 6e4,
-        initialSize: this.config.connection?.pool?.min || 2,
-        maxSize: this.config.connection?.pool?.max || 10,
+        connectionTimeout: (
+          // @ts-ignore
+          this.config?.connection?.acquireConnectionTimeout || 6e4
+        ),
+        // @ts-ignore
+        initialSize: this.config?.connection?.pool?.min || 2,
+        // @ts-ignore
+        maxSize: this.config?.connection?.pool?.max || 10,
         reuseConnection: true
       };
-      console.log({ config: this.config, pool: this.pool, poolConfig });
       const pool = await this.driver.pool(poolConfig);
       return await pool.connect();
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bdkinc/knex-ibmi",
-  "version": "0.0.11",
+  "version": "0.0.13",
   "description": "Knex dialect for IBMi",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -13,7 +13,7 @@
   },
   "engineStrict": true,
   "scripts": {
-    "build": "tsup src/index.ts --format esm,cjs",
+    "build": "tsup src/index.ts --dts --format esm,cjs",
     "lint:scripts": "eslint . --ext .ts",
     "format:scripts": "prettier . --write"
   },

package/src/index.ts

@@ -62,15 +62,21 @@ class DB2Client extends knex.Client {
     const connectionConfig = this.config.connection;
     console.log(this._getConnectionString(connectionConfig));
 
-    if (this.pool) {
+    console.log({ config: this.config, pool: this.pool });
+
+    // @ts-ignore
+    if (this.config?.connection?.pool) {
       const poolConfig = {
         connectionString: this._getConnectionString(connectionConfig),
-        connectionTimeout: this.config.connection?.acquireConnectionTimeout || 60000,
-        initialSize: this.config.connection?.pool?.min || 2,
-        maxSize: this.config.connection?.pool?.max || 10,
+        connectionTimeout:
+        // @ts-ignore
+          this.config?.connection?.acquireConnectionTimeout || 60000,
+        // @ts-ignore
+        initialSize: this.config?.connection?.pool?.min || 2,
+        // @ts-ignore
+        maxSize: this.config?.connection?.pool?.max || 10,
         reuseConnection: true,
       };
-      console.log({ config: this.config, pool: this.pool, poolConfig });
       const pool = await this.driver.pool(poolConfig);
       return await pool.connect();
     }
@@ -259,5 +265,43 @@ class DB2Client extends knex.Client {
   }
 }
 
+interface DB2PoolConfig {
+  min: number;
+  max: number;
+}
+
+interface DB2ConnectionParams {
+  CMT?: number;
+  CONNTYPE?: number;
+  DBQ?: string;
+  MAXDECPREC?: 31 | 63;
+  MAXDECSCALE?: number;
+  MINDIVSCALE?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9;
+  NAM?: 0 | 1;
+  DFT?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
+  DSP?: 0 | 1 | 2 | 3 | 4;
+  DEC?: 0 | 1;
+  DECFLOATERROROPTION?: 0 | 1;
+  DECFLOATROUNDMODE?: 0 | 1 | 2 | 3 | 4 | 5 | 6;
+  MAPDECIMALFLOATDESCRIBE?: 1 | 3;
+}
+
+interface DB2ConnectionConfig {
+  database: string;
+  host: string;
+  port: 50000 | number;
+  user: string;
+  password: string;
+  driver: "IBM i Access ODBC Driver" | string;
+  connectionStringParams?: DB2ConnectionParams;
+  pool?: DB2PoolConfig;
+}
+
+export interface DB2Config {
+  client: any;
+  connection: DB2ConnectionConfig;
+  pool?: DB2PoolConfig;
+}
+
 export const DB2Dialect = DB2Client;
 export default DB2Client;

package/src/query/ibmi-querycompiler.ts

@@ -152,6 +152,7 @@ class IBMiQueryCompiler extends QueryCompiler {
       i = -1;
     while (++i < columns.length) {
       if (i > 0) str += ", ";
+      // @ts-ignore
       str += prefix + this.wrap(columns[i]);
     }
     return str;