fix: added stream function to Database class

duckdb · Mar 1, 2024 · a4b9b60 · a4b9b60
1 parent a62d096
commit a4b9b60
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/lib/duckdb.js b/lib/duckdb.js
@@ -530,6 +530,17 @@ Database.prototype.each = function () {
     return this;
 }
 
+
+/**
+ * @arg sql
+ * @param {...*} params
+ * @yields row chunks
+ */
+Database.prototype.stream = function() {
+    return default_connection(this).stream.apply(this.default_connection, arguments);
+}
+
+
 /**
  * Convenience method for Connection#apply using a built-in default connection
  * @arg sql

diff --git a/test/query_result.test.ts b/test/query_result.test.ts
@@ -20,4 +20,13 @@ describe('QueryResult', () => {
         }
         assert.equal(total, retrieved)
     })
+
+    it('streams results using the database object', async () => {
+        let retrieved = 0;
+        const stream = db.stream('SELECT * FROM range(0, ?)', total);
+        for await (const row of stream) {
+            retrieved++;
+        }
+        assert.equal(total, retrieved)
+    })
 })