@bdkinc/knex-ibmi 0.3.0 → 0.3.3

package/README.md

@@ -156,6 +156,8 @@ try {
 ```typescript
 import { knex } from "knex";
 import { DB2Dialect, DB2Config } from "@bdkinc/knex-ibmi";
+import { Transform } from "node:stream";
+import { finished } from "node:stream/promises";
 
 const config: DB2Config = {
   client: DB2Dialect,
@@ -186,8 +188,28 @@ try {
     .from("table")
     .stream({ fetchSize: 1 }); // optional, fetchSize defaults to 1
 
+  // use an objectMode transformer
+  const transform = new Transform({
+    objectMode: true,
+    transform(
+      chunk: any,
+      encoding: BufferEncoding,
+      callback: TransformCallback,
+    ) {
+      // chunk will be an array of objects
+      // the length of the array is the chunk size
+      console.log(chunk);
+      callback(null, chunk);
+    },
+  });
+
+  // pipe through the transformer
+  data.pipe(transform);
+
+  await finished(data); // db queries are promises, we need to wait until resolved
+
+  // or we can iterate through each record one at a time (fetchSize has no effect)
   for await (const record of data) {
-    // returns an array of objects, length of array is determined by fetchSize
     console.log(record);
   }
 } catch (err) {

package/dist/index.d.ts

@@ -61,7 +61,6 @@ declare class DB2Client extends knex.Client {
     _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;

package/dist/index.js

@@ -452,33 +452,28 @@ var DB2Client = class extends import_knex.knex.Client {
   _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("error", reject);
       stream.on("end", resolve);
+      const cursor = await connection.query(obj.sql, obj.bindings, {
+        cursor: true,
+        fetchSize: options?.fetchSize || 1
+      });
       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);
           }
+          this.push(null);
           await cursor.close();
         }
       });
-      readableStream.pipe(stream);
       readableStream.on("error", (err) => {
         reject(err);
         stream.emit("error", err);
       });
+      readableStream.pipe(stream);
     });
   }
   transaction(container, config, outerTx) {

package/package.json

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