duckdb 0.6.2-dev670.0 → 0.6.2-dev679.0

package/lib/duckdb.d.ts

@@ -15,12 +15,14 @@ export type RowData = {
 };
 
 export type TableData = RowData[];
+export type ArrowIterable = Iterable<Uint8Array> | AsyncIterable<Uint8Array>;
+export type ArrowArray = Uint8Array[];
 
 export class Connection {
   constructor(db: Database, callback?: Callback<any>);
 
   all(sql: string, ...args: [...any, Callback<TableData>] | []): void;
-  arrowIPCAll(sql: string, ...args: [...any, Callback<TableData>] | []): void;
+  arrowIPCAll(sql: string, ...args: [...any, Callback<ArrowArray>] | []): void;
   each(sql: string, ...args: [...any, Callback<RowData>] | []): void;
   exec(sql: string, ...args: [...any, Callback<void>] | []): void;
 
@@ -41,13 +43,24 @@ export class Connection {
   unregister_udf(name: string, callback: Callback<any>): void;
 
   stream(sql: any, ...args: any[]): QueryResult;
-  arrowIPCStream(sql: any, ...args: any[]): QueryResult;
+  arrowIPCStream(sql: any, ...args: any[]): IpcResultStreamIterator;
+
+  register_buffer(name: string, array: ArrowIterable, force: boolean, callback?: Callback<void>): void;
+  unregister_buffer(name: string, callback?: Callback<void>): void;
 }
 
-export class QueryResult {
+export class QueryResult implements AsyncIterable<RowData> {
   [Symbol.asyncIterator](): AsyncIterator<RowData>;
 }
 
+export class IpcResultStreamIterator implements AsyncIterator<Uint8Array>, AsyncIterable<Uint8Array> {
+  [Symbol.asyncIterator](): this;
+
+  next(...args: [] | [undefined]): Promise<IteratorResult<Uint8Array, any>>;
+
+  toArray(): Promise<ArrowArray>;
+}
+
 export class Database {
   constructor(path: string, accessMode?: number | Record<string,string>, callback?: Callback<any>);
   constructor(path: string, callback?: Callback<any>);
@@ -57,7 +70,7 @@ export class Database {
   connect(): Connection;
 
   all(sql: string, ...args: [...any, Callback<TableData>] | []): this;
-  arrowIPCAll(sql: string, ...args: [...any, Callback<QueryResult>] | []): void;
+  arrowIPCAll(sql: string, ...args: [...any, Callback<ArrowArray>] | []): void;
   each(sql: string, ...args: [...any, Callback<RowData>] | []): this;
   exec(sql: string, ...args: [...any, Callback<void>] | []): void;
 
@@ -72,7 +85,7 @@ export class Database {
   unregister_udf(name: string, callback: Callback<any>): void;
 
   stream(sql: any, ...args: any[]): QueryResult;
-  arrowIPCStream(sql: any, ...args: any[]): Promise<QueryResult>;
+  arrowIPCStream(sql: any, ...args: any[]): Promise<IpcResultStreamIterator>;
 
   serialize(done?: Callback<void>): void;
   parallelize(done?: Callback<void>): void;
@@ -83,7 +96,7 @@ export class Database {
 
   interrupt(): void;
 
-  register_buffer(name: string, array: ArrayLike<any>, force: boolean, callback?: Callback<void>): void;
+  register_buffer(name: string, array: ArrowIterable, force: boolean, callback?: Callback<void>): void;
 
   unregister_buffer(name: string, callback?: Callback<void>): void;
 }
@@ -95,7 +108,7 @@ export class Statement {
 
   all(...args: [...any, Callback<TableData>] | any[]): this;
 
-  arrowIPCAll(...args: [...any, Callback<TableData>] | any[]): void;
+  arrowIPCAll(...args: [...any, Callback<ArrowArray>] | any[]): void;
 
   each(...args: [...any, Callback<RowData>] | any[]): this;
 

package/package.json

@@ -2,7 +2,7 @@
   "name": "duckdb",
   "main": "./lib/duckdb.js",
   "types": "./lib/duckdb.d.ts",
-  "version": "0.6.2-dev670.0",
+  "version": "0.6.2-dev679.0",
   "description": "DuckDB node.js API",
   "gypfile": true,
   "dependencies": {

package/test/arrow.test.ts

@@ -1,7 +1,6 @@
 import * as duckdb from '..';
 import * as assert from 'assert';
-import * as fs from 'fs';
-import {QueryResult} from "..";
+import {ArrowArray} from "..";
 
 describe('arrow IPC API fails neatly when extension not loaded', function() {
     // Note: arrow IPC api requires the arrow extension to be loaded. The tests for this functionality reside in:
@@ -25,7 +24,7 @@ describe('arrow IPC API fails neatly when extension not loaded', function() {
             }
         );
 
-        db.arrowIPCAll(`SELECT * FROM ipc_table`, function (err: null | Error, result: QueryResult) {
+        db.arrowIPCAll(`SELECT * FROM ipc_table`, function (err: null | Error, result: ArrowArray) {
             if (err) {
                 assert.ok(err.message.includes("Catalog Error: Function with name to_arrow_ipc is not on the catalog, but it exists in the arrow extension. To Install and Load the extension, run: INSTALL arrow; LOAD arrow;"))
             } else {
@@ -33,6 +32,7 @@ describe('arrow IPC API fails neatly when extension not loaded', function() {
             }
         });
 
+        // @ts-expect-error
         assert.throws(() => db.register_buffer("ipc_table", [1,'a',1], true), TypeError, "Incorrect parameters");
     });