@bdkinc/knex-ibmi 0.2.9 → 0.3.0

package/README.md

@@ -13,14 +13,12 @@ For more information on IBMi OSS here are the [docs](https://ibmi-oss-docs.readt
 ## Supported functionality
 
 - Query building
-- Query execution (see [Limitations](#Limitations))
+- Query execution
 - Transactions
-
-## Limitations
-
-- No streaming support
+- Streaming
 
 ## Installation
+
 ```
 npm install --save odbc knex @bdkinc/knex-ibmi
 ```
@@ -29,7 +27,7 @@ Requires Node v16 or higher.
 
 ## Dependencies
 
-`npm install odbc` see [odbc](https://github.com/markdirish/node-odbc)
+`npm install odbc` see [odbc](https://github.com/IBM/node-odbc)
 
 `npm install knex` see [knex](https://github.com/tgriesser/knex)
 
@@ -51,10 +49,11 @@ const db = knex({
     user: "<user>", // IBMi username
     password: "<password>", // IBMi password
     driver: "IBM i Access ODBC Driver", // defined in odbcinst.ini
-    connectionStringParams: { // DSN connection string parameters https://www.ibm.com/docs/en/i/7.5?topic=details-connection-string-keywords
-      ALLOWPROCCALLS: 1, 
+    connectionStringParams: {
+      // DSN connection string parameters https://www.ibm.com/docs/en/i/7.5?topic=details-connection-string-keywords
+      ALLOWPROCCALLS: 1,
       CMT: 0,
-      DBQ: 'MYLIB' // library or schema that holds the tables
+      DBQ: "MYLIB", // library or schema that holds the tables
     },
   },
   pool: {
@@ -88,17 +87,18 @@ const config = {
     user: "<user>", // IBMi username
     password: "<password>", // IBMi password
     driver: "IBM i Access ODBC Driver", // defined in odbcinst.ini
-    connectionStringParams: { // DSN connection string parameters https://www.ibm.com/docs/en/i/7.5?topic=details-connection-string-keywords
+    connectionStringParams: {
+      // DSN connection string parameters https://www.ibm.com/docs/en/i/7.5?topic=details-connection-string-keywords
       ALLOWPROCCALLS: 1,
       CMT: 0,
-      DBQ: 'MYLIB' // library or schema that holds the tables
+      DBQ: "MYLIB", // library or schema that holds the tables
     },
   },
   pool: {
     min: 2,
     max: 10,
   },
-}
+};
 
 const db = knex(config);
 
@@ -126,10 +126,11 @@ const config: DB2Config = {
     user: "<user>", // IBMi username
     password: "<password>", // IBMi password
     driver: "IBM i Access ODBC Driver", // defined in odbcinst.ini
-    connectionStringParams: { // DSN connection string parameters https://www.ibm.com/docs/en/i/7.5?topic=details-connection-string-keywords
+    connectionStringParams: {
+      // DSN connection string parameters https://www.ibm.com/docs/en/i/7.5?topic=details-connection-string-keywords
       ALLOWPROCCALLS: 1,
       CMT: 0,
-      DBQ: 'MYLIB' // library or schema that holds the tables
+      DBQ: "MYLIB", // library or schema that holds the tables
     },
   },
   pool: {
@@ -150,6 +151,52 @@ try {
 }
 ```
 
+### Streaming example
+
+```typescript
+import { knex } from "knex";
+import { DB2Dialect, DB2Config } from "@bdkinc/knex-ibmi";
+
+const config: DB2Config = {
+  client: DB2Dialect,
+  connection: {
+    host: "localhost", // hostname or ip address of server
+    database: "*LOCAL", // usually named in your odbc.ini connection
+    user: "<user>", // IBMi username
+    password: "<password>", // IBMi password
+    driver: "IBM i Access ODBC Driver", // defined in odbcinst.ini
+    connectionStringParams: {
+      // DSN connection string parameters https://www.ibm.com/docs/en/i/7.5?topic=details-connection-string-keywords
+      ALLOWPROCCALLS: 1,
+      CMT: 0,
+      DBQ: "MYLIB", // library or schema that holds the tables
+    },
+  },
+  pool: {
+    min: 2,
+    max: 10,
+  },
+};
+
+const db = knex(config);
+
+try {
+  const data = await db
+    .select("*")
+    .from("table")
+    .stream({ fetchSize: 1 }); // optional, fetchSize defaults to 1
+
+  for await (const record of data) {
+    // returns an array of objects, length of array is determined by fetchSize
+    console.log(record);
+  }
+} catch (err) {
+  throw err;
+} finally {
+  process.exit();
+}
+```
+
 ## 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.ts

@@ -59,6 +59,10 @@ declare class DB2Client extends knex.Client {
     destroyRawConnection(connection: any): Promise<any>;
     _getConnectionString(connectionConfig: DB2ConnectionConfig): string;
     _query(connection: any, obj: any): Promise<any>;
+    _stream(connection: any, obj: any, stream: any, options: {
+        fetchSize?: number;
+        initialBufferSize?: number;
+    }): Promise<unknown>;
     transaction(container: any, config: any, outerTx: any): Knex.Transaction;
     schemaCompiler(tableBuilder: any): IBMiSchemaCompiler;
     tableCompiler(tableBuilder: any): IBMiTableCompiler;
@@ -86,6 +90,7 @@ interface DB2ConnectionParams {
     DECFLOATROUNDMODE?: 0 | 1 | 2 | 3 | 4 | 5 | 6;
     MAPDECIMALFLOATDESCRIBE?: 1 | 3;
     ALLOWPROCCALLS?: 0 | 1;
+    XDYNAMIC?: 0 | 1;
 }
 interface DB2ConnectionConfig {
     database: string;

package/dist/index.js

@@ -313,6 +313,7 @@ var IBMiQueryCompiler = class extends import_querycompiler.default {
 var ibmi_querycompiler_default = IBMiQueryCompiler;
 
 // src/index.ts
+var import_node_stream = require("stream");
 var DB2Client = class extends import_knex.knex.Client {
   constructor(config) {
     super(config);
@@ -448,6 +449,38 @@ var DB2Client = class extends import_knex.knex.Client {
     this.printDebug(obj);
     return obj;
   }
+  _stream(connection, obj, stream, options) {
+    if (!obj.sql) throw new Error("A query is required to stream results");
+    return new Promise(async (resolve, reject) => {
+      stream.on("error", (err) => {
+        if (err) {
+          connection.__knex__disposed = err;
+        }
+        reject(err);
+      });
+      stream.on("end", resolve);
+      const readableStream = new import_node_stream.Readable({
+        objectMode: true,
+        async read() {
+          const cursor = await connection.query(obj.sql, obj.bindings, {
+            cursor: true,
+            fetchSize: options?.fetchSize || 1,
+            ...options
+          });
+          while (!cursor.noData) {
+            const result = await cursor.fetch();
+            this.push(result);
+          }
+          await cursor.close();
+        }
+      });
+      readableStream.pipe(stream);
+      readableStream.on("error", (err) => {
+        reject(err);
+        stream.emit("error", err);
+      });
+    });
+  }
   transaction(container, config, outerTx) {
     return new ibmi_transaction_default(this, container, config, outerTx);
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bdkinc/knex-ibmi",
-  "version": "0.2.9",
+  "version": "0.3.0",
   "description": "Knex dialect for IBMi",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",