@homeofthings/sqlite3 0.0.1-alpha0 → 6.1.1

package/lib/sqlite3.d.ts

@@ -0,0 +1,205 @@
+// Type definitions for sqlite3
+// Project: http://github.com/gms1/node-sqlite3
+
+/// <reference types="node" />
+
+import events = require("events");
+
+export const OPEN_READONLY: number;
+export const OPEN_READWRITE: number;
+export const OPEN_CREATE: number;
+export const OPEN_FULLMUTEX: number;
+export const OPEN_SHAREDCACHE: number;
+export const OPEN_PRIVATECACHE: number;
+export const OPEN_URI: number;
+
+export const VERSION: string;
+export const SOURCE_ID: string;
+export const VERSION_NUMBER: number;
+
+export const OK: number;
+export const ERROR: number;
+export const INTERNAL: number;
+export const PERM: number;
+export const ABORT: number;
+export const BUSY: number;
+export const LOCKED: number;
+export const NOMEM: number;
+export const READONLY: number;
+export const INTERRUPT: number
+export const IOERR: number;
+export const CORRUPT: number
+export const NOTFOUND: number;
+export const FULL: number;
+export const CANTOPEN: number;
+export const PROTOCOL: number;
+export const EMPTY: number;
+export const SCHEMA: number;
+export const TOOBIG: number
+export const CONSTRAINT: number
+export const MISMATCH: number;
+export const MISUSE: number;
+export const NOLFS: number;
+export const AUTH: number
+export const FORMAT: number;
+export const RANGE: number
+export const NOTADB: number;
+
+export const LIMIT_LENGTH: number;
+export const LIMIT_SQL_LENGTH: number;
+export const LIMIT_COLUMN: number;
+export const LIMIT_EXPR_DEPTH: number;
+export const LIMIT_COMPOUND_SELECT: number;
+export const LIMIT_VDBE_OP: number;
+export const LIMIT_FUNCTION_ARG: number;
+export const LIMIT_ATTACHED: number;
+export const LIMIT_LIKE_PATTERN_LENGTH: number;
+export const LIMIT_VARIABLE_NUMBER: number;
+export const LIMIT_TRIGGER_DEPTH: number;
+export const LIMIT_WORKER_THREADS: number;
+
+export const cached: {
+    Database(filename: string, callback?: (this: Database, err: Error | null) => void): Database;
+    Database(filename: string, mode?: number, callback?: (this: Database, err: Error | null) => void): Database;
+};
+
+export interface RunResult extends Statement {
+    lastID: number;
+    changes: number;
+}
+
+export class Statement extends events.EventEmitter {
+    bind(callback?: (err: Error | null) => void): this;
+    bind(...params: any[]): this;
+
+    reset(callback?: (err: null) => void): this;
+
+    finalize(callback?: (err: Error) => void): Database;
+
+    run(callback?: (err: Error | null) => void): this;
+    run(params: any, callback?: (this: RunResult, err: Error | null) => void): this;
+    run(...params: any[]): this;
+
+    get<T>(callback?: (err: Error | null, row?: T) => void): this;
+    get<T>(params: any, callback?: (this: RunResult, err: Error | null, row?: T) => void): this;
+    get(...params: any[]): this;
+
+    all<T>(callback?: (err: Error | null, rows: T[]) => void): this;
+    all<T>(params: any, callback?: (this: RunResult, err: Error | null, rows: T[]) => void): this;
+    all(...params: any[]): this;
+
+    each<T>(callback?: (err: Error | null, row: T) => void, complete?: (err: Error | null, count: number) => void): this;
+    each<T>(params: any, callback?: (this: RunResult, err: Error | null, row: T) => void, complete?: (err: Error | null, count: number) => void): this;
+    each(...params: any[]): this;
+}
+
+export class Database extends events.EventEmitter {
+    constructor(filename: string, callback?: (err: Error | null) => void);
+    constructor(filename: string, mode?: number, callback?: (err: Error | null) => void);
+
+    close(callback?: (err: Error | null) => void): void;
+
+    run(sql: string, callback?: (this: RunResult, err: Error | null) => void): this;
+    run(sql: string, params: any, callback?: (this: RunResult, err: Error | null) => void): this;
+    run(sql: string, ...params: any[]): this;
+
+    get<T>(sql: string, callback?: (this: Statement, err: Error | null, row: T) => void): this;
+    get<T>(sql: string, params: any, callback?: (this: Statement, err: Error | null, row: T) => void): this;
+    get(sql: string, ...params: any[]): this;
+
+    all<T>(sql: string, callback?: (this: Statement, err: Error | null, rows: T[]) => void): this;
+    all<T>(sql: string, params: any, callback?: (this: Statement, err: Error | null, rows: T[]) => void): this;
+    all(sql: string, ...params: any[]): this;
+
+    each<T>(sql: string, callback?: (this: Statement, err: Error | null, row: T) => void, complete?: (err: Error | null, count: number) => void): this;
+    each<T>(sql: string, params: any, callback?: (this: Statement, err: Error | null, row: T) => void, complete?: (err: Error | null, count: number) => void): this;
+    each(sql: string, ...params: any[]): this;
+
+    exec(sql: string, callback?: (this: Statement, err: Error | null) => void): this;
+
+    prepare(sql: string, callback?: (this: Statement, err: Error | null) => void): Statement;
+    prepare(sql: string, params: any, callback?: (this: Statement, err: Error | null) => void): Statement;
+    prepare(sql: string, ...params: any[]): Statement;
+
+    serialize(callback?: () => void): void;
+    parallelize(callback?: () => void): void;
+
+    on(event: "trace", listener: (sql: string) => void): this;
+    on(event: "profile", listener: (sql: string, time: number) => void): this;
+    on(event: "change", listener: (type: string, database: string, table: string, rowid: number) => void): this;
+    on(event: "error", listener: (err: Error) => void): this;
+    on(event: "open" | "close", listener: () => void): this;
+    on(event: string, listener: (...args: any[]) => void): this;
+
+    configure(option: "busyTimeout", value: number): void;
+    configure(option: "limit", id: number, value: number): void;
+
+    loadExtension(filename: string, callback?: (err: Error | null) => void): this;
+
+    wait(callback?: (param: null) => void): this;
+
+    interrupt(): void;
+}
+
+export function verbose(): sqlite3;
+
+export interface sqlite3 {
+    OPEN_READONLY: number;
+    OPEN_READWRITE: number;
+    OPEN_CREATE: number;
+    OPEN_FULLMUTEX: number;
+    OPEN_SHAREDCACHE: number;
+    OPEN_PRIVATECACHE: number;
+    OPEN_URI: number;
+
+    VERSION: string;
+    SOURCE_ID: string;
+    VERSION_NUMBER: number;
+
+    OK: number;
+    ERROR: number;
+    INTERNAL: number;
+    PERM: number;
+    ABORT: number;
+    BUSY: number;
+    LOCKED: number;
+    NOMEM: number;
+    READONLY: number;
+    INTERRUPT: number
+    IOERR: number;
+    CORRUPT: number
+    NOTFOUND: number;
+    FULL: number;
+    CANTOPEN: number;
+    PROTOCOL: number;
+    EMPTY: number;
+    SCHEMA: number;
+    TOOBIG: number
+    CONSTRAINT: number
+    MISMATCH: number;
+    MISUSE: number;
+    NOLFS: number;
+    AUTH: number
+    FORMAT: number;
+    RANGE: number
+    NOTADB: number;
+
+    LIMIT_LENGTH: number;
+    LIMIT_SQL_LENGTH: number;
+    LIMIT_COLUMN: number;
+    LIMIT_EXPR_DEPTH: number;
+    LIMIT_COMPOUND_SELECT: number;
+    LIMIT_VDBE_OP: number;
+    LIMIT_FUNCTION_ARG: number;
+    LIMIT_ATTACHED: number;
+    LIMIT_LIKE_PATTERN_LENGTH: number;
+    LIMIT_VARIABLE_NUMBER: number;
+    LIMIT_TRIGGER_DEPTH: number;
+    LIMIT_WORKER_THREADS: number;
+
+    cached: typeof cached;
+    RunResult: RunResult;
+    Statement: typeof Statement;
+    Database: typeof Database;
+    verbose(): this;
+}

package/lib/sqlite3.js

@@ -0,0 +1,207 @@
+const path = require('path');
+const sqlite3 = require('./sqlite3-binding.js');
+const EventEmitter = require('events').EventEmitter;
+module.exports = exports = sqlite3;
+
+function normalizeMethod (fn) {
+    return function (sql) {
+        let errBack;
+        const args = Array.prototype.slice.call(arguments, 1);
+
+        if (typeof args[args.length - 1] === 'function') {
+            const callback = args[args.length - 1];
+            errBack = function(err) {
+                if (err) {
+                    callback(err);
+                }
+            };
+        }
+        const statement = new Statement(this, sql, errBack);
+        return fn.call(this, statement, args);
+    };
+}
+
+function inherits(target, source) {
+    for (const k in source.prototype)
+        target.prototype[k] = source.prototype[k];
+}
+
+sqlite3.cached = {
+    Database: function(file, a, b) {
+        if (file === '' || file === ':memory:') {
+            // Don't cache special databases.
+            return new Database(file, a, b);
+        }
+
+        let db;
+        file = path.resolve(file);
+
+        if (!sqlite3.cached.objects[file]) {
+            db = sqlite3.cached.objects[file] = new Database(file, a, b);
+        }
+        else {
+            // Make sure the callback is called.
+            db = sqlite3.cached.objects[file];
+            const callback = (typeof a === 'number') ? b : a;
+            if (typeof callback === 'function') {
+                function cb() { callback.call(db, null); }
+                if (db.open) process.nextTick(cb);
+                else db.once('open', cb);
+            }
+        }
+
+        return db;
+    },
+    objects: {}
+};
+
+
+const Database = sqlite3.Database;
+const Statement = sqlite3.Statement;
+const Backup = sqlite3.Backup;
+
+inherits(Database, EventEmitter);
+inherits(Statement, EventEmitter);
+inherits(Backup, EventEmitter);
+
+// Database#prepare(sql, [bind1, bind2, ...], [callback])
+Database.prototype.prepare = normalizeMethod(function(statement, params) {
+    return params.length
+        ? statement.bind.apply(statement, params)
+        : statement;
+});
+
+// Database#run(sql, [bind1, bind2, ...], [callback])
+Database.prototype.run = normalizeMethod(function(statement, params) {
+    statement.run.apply(statement, params).finalize();
+    return this;
+});
+
+// Database#get(sql, [bind1, bind2, ...], [callback])
+Database.prototype.get = normalizeMethod(function(statement, params) {
+    statement.get.apply(statement, params).finalize();
+    return this;
+});
+
+// Database#all(sql, [bind1, bind2, ...], [callback])
+Database.prototype.all = normalizeMethod(function(statement, params) {
+    statement.all.apply(statement, params).finalize();
+    return this;
+});
+
+// Database#each(sql, [bind1, bind2, ...], [callback], [complete])
+Database.prototype.each = normalizeMethod(function(statement, params) {
+    statement.each.apply(statement, params).finalize();
+    return this;
+});
+
+Database.prototype.map = normalizeMethod(function(statement, params) {
+    statement.map.apply(statement, params).finalize();
+    return this;
+});
+
+// Database#backup(filename, [callback])
+// Database#backup(filename, destName, sourceName, filenameIsDest, [callback])
+Database.prototype.backup = function() {
+    let backup;
+    if (arguments.length <= 2) {
+        // By default, we write the main database out to the main database of the named file.
+        // This is the most likely use of the backup api.
+        backup = new Backup(this, arguments[0], 'main', 'main', true, arguments[1]);
+    } else {
+        // Otherwise, give the user full control over the sqlite3_backup_init arguments.
+        backup = new Backup(this, arguments[0], arguments[1], arguments[2], arguments[3], arguments[4]);
+    }
+    // Per the sqlite docs, exclude the following errors as non-fatal by default.
+    backup.retryErrors = [sqlite3.BUSY, sqlite3.LOCKED];
+    return backup;
+};
+
+Statement.prototype.map = function() {
+    const params = Array.prototype.slice.call(arguments);
+    const callback = params.pop();
+    params.push(function(err, rows) {
+        if (err) return callback(err);
+        const result = {};
+        if (rows.length) {
+            const keys = Object.keys(rows[0]);
+            const key = keys[0];
+            if (keys.length > 2) {
+                // Value is an object
+                for (let i = 0; i < rows.length; i++) {
+                    result[rows[i][key]] = rows[i];
+                }
+            } else {
+                const value = keys[1];
+                // Value is a plain value
+                for (let i = 0; i < rows.length; i++) {
+                    result[rows[i][key]] = rows[i][value];
+                }
+            }
+        }
+        callback(err, result);
+    });
+    return this.all.apply(this, params);
+};
+
+let isVerbose = false;
+
+const supportedEvents = [ 'trace', 'profile', 'change' ];
+
+Database.prototype.addListener = Database.prototype.on = function(type) {
+    const val = EventEmitter.prototype.addListener.apply(this, arguments);
+    if (supportedEvents.indexOf(type) >= 0) {
+        this.configure(type, true);
+    }
+    return val;
+};
+
+Database.prototype.removeListener = function(type) {
+    const val = EventEmitter.prototype.removeListener.apply(this, arguments);
+    if (supportedEvents.indexOf(type) >= 0 && !this._events[type]) {
+        this.configure(type, false);
+    }
+    return val;
+};
+
+Database.prototype.removeAllListeners = function(type) {
+    const val = EventEmitter.prototype.removeAllListeners.apply(this, arguments);
+    if (supportedEvents.indexOf(type) >= 0) {
+        this.configure(type, false);
+    }
+    return val;
+};
+
+// Save the stack trace over EIO callbacks.
+sqlite3.verbose = function() {
+    if (!isVerbose) {
+        const trace = require('./trace');
+        [
+            'prepare',
+            'get',
+            'run',
+            'all',
+            'each',
+            'map',
+            'close',
+            'exec'
+        ].forEach(function (name) {
+            trace.extendTrace(Database.prototype, name);
+        });
+        [
+            'bind',
+            'get',
+            'run',
+            'all',
+            'each',
+            'map',
+            'reset',
+            'finalize',
+        ].forEach(function (name) {
+            trace.extendTrace(Statement.prototype, name);
+        });
+        isVerbose = true;
+    }
+
+    return sqlite3;
+};

package/lib/trace.js

@@ -0,0 +1,38 @@
+// Inspired by https://github.com/tlrobinson/long-stack-traces
+const util = require('util');
+
+function extendTrace(object, property, pos) {
+    const old = object[property];
+    object[property] = function() {
+        const error = new Error();
+        const name = object.constructor.name + '#' + property + '(' +
+            Array.prototype.slice.call(arguments).map(function(el) {
+                return util.inspect(el, false, 0);
+            }).join(', ') + ')';
+
+        if (typeof pos === 'undefined') pos = -1;
+        if (pos < 0) pos += arguments.length;
+        const cb = arguments[pos];
+        if (typeof arguments[pos] === 'function') {
+            arguments[pos] = function replacement() {
+                const err = arguments[0];
+                if (err && err.stack && !err.__augmented) {
+                    err.stack = filter(err).join('\n');
+                    err.stack += '\n--> in ' + name;
+                    err.stack += '\n' + filter(error).slice(1).join('\n');
+                    err.__augmented = true;
+                }
+                return cb.apply(this, arguments);
+            };
+        }
+        return old.apply(this, arguments);
+    };
+}
+exports.extendTrace = extendTrace;
+
+
+function filter(error) {
+    return error.stack.split('\n').filter(function(line) {
+        return line.indexOf(__filename) < 0;
+    });
+}

package/package.json

@@ -1,14 +1,93 @@
 {
   "name": "@homeofthings/sqlite3",
-  "version": "0.0.1-alpha0",
   "description": "Asynchronous, non-blocking SQLite3 bindings",
-  "main": "index.js",
+  "version": "6.1.1",
+  "homepage": "https://github.com/gms1/node-sqlite3",
+  "author": {
+    "name": "Mapbox",
+    "url": "https://mapbox.com/"
+  },
+  "binary": {
+    "napi_versions": [
+      3,
+      6
+    ]
+  },
+  "contributors": [
+    "Daniel Lockyer <hi@daniellockyer.com>",
+    "Konstantin Käfer <mail@kkaefer.com>",
+    "Dane Springmeyer <dane@mapbox.com>",
+    "Will White <will@mapbox.com>",
+    "Orlando Vazquez <ovazquez@gmail.com>",
+    "Artem Kustikov <kustikoff@gmail.com>",
+    "Eric Fredricksen <efredricksen@gmail.com>",
+    "John Wright <mrjjwright@gmail.com>",
+    "Ryan Dahl <ry@tinyclouds.org>",
+    "Tom MacWright <tom@mapbox.com>",
+    "Carter Thaxton <carter.thaxton@gmail.com>",
+    "Audrius Kažukauskas <audrius@neutrino.lt>",
+    "Johannes Schauer <josch@pyneo.org>",
+    "Nathan Rajlich <nathan@tootallnate.net>",
+    "AJ ONeal <coolaj86@gmail.com>",
+    "Mithgol",
+    "Ben Noordhuis <ben@strongloop.com>"
+  ],
+  "files": [
+    "binding.gyp",
+    "deps/",
+    "lib/*.js",
+    "lib/*.d.ts",
+    "src/"
+  ],
   "repository": {
     "type": "git",
     "url": "https://github.com/gms1/node-sqlite3.git"
   },
+  "dependencies": {
+    "bindings": "^1.5.0",
+    "node-addon-api": "^8.0.0",
+    "prebuild-install": "^7.1.3",
+    "tar": "^7.5.10"
+  },
+  "devDependencies": {
+    "eslint": "8.56.0",
+    "mocha": "10.2.0",
+    "prebuild": "13.0.1",
+    "tinybench": "^2.9.0"
+  },
+  "peerDependencies": {
+    "node-gyp": "12.x"
+  },
+  "peerDependenciesMeta": {
+    "node-gyp": {
+      "optional": true
+    }
+  },
+  "optionalDependencies": {
+    "node-gyp": "12.x"
+  },
+  "engines": {
+    "node": ">=20.17.0"
+  },
+  "scripts": {
+    "install": "prebuild-install -r napi || node-gyp rebuild",
+    "prebuild": "prebuild --runtime napi --all --verbose",
+    "rebuild": "node-gyp rebuild",
+    "upload": "prebuild --verbose --prerelease",
+    "frozen-install": "yarn install --frozen-lockfile",
+    "lint": "eslint .eslintrc.js lib/ test/ tools/",
+    "test": "node test/support/createdb.js && mocha -R spec --timeout 480000"
+  },
   "license": "BSD-3-Clause",
   "publishConfig": {
     "access": "public"
-  }
+  },
+  "keywords": [
+    "sql",
+    "sqlite",
+    "sqlite3",
+    "database"
+  ],
+  "main": "./lib/sqlite3",
+  "types": "./lib/sqlite3.d.ts"
 }

package/src/async.h

@@ -0,0 +1,76 @@
+#ifndef NODE_SQLITE3_SRC_ASYNC_H
+#define NODE_SQLITE3_SRC_ASYNC_H
+
+#include <napi.h>
+#include <uv.h>
+
+#include "threading.h"
+
+// Generic uv_async handler.
+template <class Item, class Parent> class Async {
+    typedef void (*Callback)(Parent* parent, Item* item);
+
+protected:
+    uv_async_t watcher;
+    NODE_SQLITE3_MUTEX_t
+    std::vector<Item*> data;
+    Callback callback;
+public:
+    Parent* parent;
+
+public:
+    Async(Parent* parent_, Callback cb_)
+        : callback(cb_), parent(parent_) {
+        watcher.data = this;
+        NODE_SQLITE3_MUTEX_INIT
+        uv_loop_t *loop;
+        napi_get_uv_event_loop(parent_->Env(), &loop);
+        uv_async_init(loop, &watcher, reinterpret_cast<uv_async_cb>(listener));
+    }
+
+    static void listener(uv_async_t* handle) {
+        auto* async = static_cast<Async*>(handle->data);
+        std::vector<Item*> rows;
+        NODE_SQLITE3_MUTEX_LOCK(&async->mutex)
+        rows.swap(async->data);
+        NODE_SQLITE3_MUTEX_UNLOCK(&async->mutex)
+        for(auto row : rows)
+            async->callback(async->parent, row);
+    }
+
+    static void close(uv_handle_t* handle) {
+        assert(handle != NULL);
+        assert(handle->data != NULL);
+        auto* async = static_cast<Async*>(handle->data);
+        delete async;
+    }
+
+    void finish() {
+        // Need to call the listener again to ensure all items have been
+        // processed. Is this a bug in uv_async? Feels like uv_close
+        // should handle that.
+        listener(&watcher);
+        uv_close((uv_handle_t*)&watcher, close);
+    }
+
+    void add(Item* item) {
+        NODE_SQLITE3_MUTEX_LOCK(&mutex);
+        data.emplace_back(item);
+        NODE_SQLITE3_MUTEX_UNLOCK(&mutex)
+    }
+
+    void send() {
+        uv_async_send(&watcher);
+    }
+
+    void send(Item* item) {
+        add(item);
+        send();
+    }
+
+    ~Async() {
+        NODE_SQLITE3_MUTEX_DESTROY
+    }
+};
+
+#endif