duckdb 0.6.2-dev6.0 → 0.6.2-dev604.0

package/.mocharc.json

@@ -1,5 +1,5 @@
 {
-  "extension": ["js", "ts"],
-  "spec": ["test/*.js", "test/*.ts"],
+  "extension": ["ts"],
+  "spec": ["test/*.ts"],
   "require": "ts-node/register"
 }

package/README.md

@@ -99,3 +99,20 @@ var stmt = con.prepare('select ?::INTEGER as fortytwo', function(err, stmt) {
   });
 });
 ```
+
+## Development
+
+### First install:
+
+To install all the dev dependencies of the project, navigate over to `tools/nodejs` and run `npm install` (this uses package.json)
+You might want to add the `--ignore-scripts` option if you don't care about building the package for now and just want to install the dependencies.
+
+### Tests:
+Tests are located in `tools/nodejs/test` and can be run with `npm test`
+To run a single test, you can use `npm test -- --grep "name of test as given in describe"`
+
+### Additional notes:
+To build the NodeJS package from source, when on Windows, requires the following extra steps:
+- Set `OPENSSL_ROOT_DIR` to the root directory of an OpenSSL installation
+- Supply the `STATIC_OPENSSL=1` option when executing `make`, or set `-DOPENSSL_USE_STATIC_LIBS=1` manually when calling `cmake`
+

package/lib/duckdb.d.ts

@@ -49,15 +49,16 @@ export class QueryResult {
 }
 
 export class Database {
-  constructor(path: string, accessMode?: number, callback?: Callback<any>);
+  constructor(path: string, accessMode?: number | Record<string,string>, callback?: Callback<any>);
+  constructor(path: string, callback?: Callback<any>);
 
-  close(callback: Callback<void>): void;
+  close(callback?: Callback<void>): void;
 
   connect(): Connection;
 
-  all(sql: string, ...args: [...any, Callback<TableData>] | []): void;
-  arrowIPCAll(sql: string, ...args: [...any, Callback<TableData>] | []): void;
-  each(sql: string, ...args: [...any, Callback<RowData>] | []): void;
+  all(sql: string, ...args: [...any, Callback<TableData>] | []): this;
+  arrowIPCAll(sql: string, ...args: [...any, Callback<QueryResult>] | []): void;
+  each(sql: string, ...args: [...any, Callback<RowData>] | []): this;
   exec(sql: string, ...args: [...any, Callback<void>] | []): void;
 
   prepare(sql: string, ...args: [...any, Callback<Statement>] | []): Statement;
@@ -71,21 +72,36 @@ export class Database {
   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[]): Promise<QueryResult>;
+
+  serialize(done?: Callback<void>): void;
+  parallelize(done?: Callback<void>): void;
+  wait(done: Callback<void>): void;
+
+  get(columnName: string, cb: Callback<RowData>): void;
+  get(columnName: string, num: number, cb: Callback<RowData>): void;
+
+  interrupt(): void;
+
+  register_buffer(name: string, array: ArrayLike<any>, force: boolean, callback?: Callback<void>): void;
+
+  unregister_buffer(name: string, callback?: Callback<void>): void;
 }
 
 export class Statement {
-  constructor();
+  sql: string;
 
-  all(...args: [...any, Callback<TableData>] | []): void;
+  constructor(connection: Connection, sql: string);
 
-  arrowIPCAll(...args: [...any, Callback<TableData>] | []): void;
+  all(...args: [...any, Callback<TableData>] | any[]): this;
 
-  each(...args: [...any, Callback<RowData>] | []): void;
+  arrowIPCAll(...args: [...any, Callback<TableData>] | any[]): void;
+
+  each(...args: [...any, Callback<RowData>] | any[]): this;
 
   finalize(callback?: Callback<void>): void;
 
-  run(...args: [...any, Callback<void>] | []): Statement;
+  run(...args: [...any, Callback<void>] | any[]): Statement;
 }
 
 export const ERROR: number;
@@ -101,3 +117,5 @@ export const OPEN_READONLY: number;
 export const OPEN_READWRITE: number;
 
 export const OPEN_SHAREDCACHE: number;
+
+export const INTERRUPT: number;

package/lib/duckdb.js

@@ -670,3 +670,9 @@ Statement.prototype.finalize
  * @yield callback
  */
 Statement.prototype.stream;
+
+/**
+ * @field
+ * @returns sql contained in statement
+ */
+Statement.prototype.sql;

package/package.json

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