Repository files navigation

ES6 Promise-based interface to the sqlite3 module.

Thesqlite-async module exports theDatabase class. Each method works the same as the originalsqlite3 API. Instead of callbacks, each method returns a promise. Theprepare method returns aStatement instance that also wraps all of the original statement methods into methods that return a promise.

import{Database}from'sqlite-async':Database.open('test.db').then(db=>{        ...}).catch(err=>{        ...}):

Thetest/sqlite-async-test.js file provides examples.

Static getter that returns the version number of thenode-sqlite3 package currently being used by this module.

Static method that instantiates a newDatabase object and callsDatabase#open(filename, mode). Returns a promise that is resolved with the Database instance.

Opens the database with the same arguments as the sqlite3Database constructor. Returns a promise that is resolved with the Database instance.

Closes the database and returns a promise. If the optional provider function (fn) is specified, it is called asfn(db) before the database is closed.This function must return a promise. The database is closed regardless of whether the promise returned by the optional provider function is resolved or rejected. If the returned promise is rejected, then the close method itself will return a rejected promise with the error from the promise returned by the provider function.

Equivalent to the sqlite3Database#run method. Returns a promise that is resolved with thethis parameter from the sqlite3 callback function.

Equivalent to the sqlite3Database#get method. Returns a promise that is resolved with the row.

Equivalent to the sqlite3Database#all method. Returns a promise that is resolved with the rows.

Equivalent to the sqlite3Database#each method. The per-row callback function is requied. Returns a promise that is resolved with the Database instance.

Equivalent to the sqlite3Database#exec method. Returns a promise that is resolved with the Database instance.

Thetransaction method allows a function returning a promise to be wrapped in a transaction. The function is passed theDatabase instance as its parameter. Returns a promise that is resolved with the function's promise value.

db.transaction((db)=>{returnPromise.all([db.run('INSERT INTO test VALUES (2, "two")'),db.run('INSERT INTO test VALUES (2, "three")')]);});

Equivalent to the sqlite3Database#prepare method. Returns a promise that is resolved with the Statement instance.

Equivalent to the sqlite3Statement#bind method. Returns a promise that is resolved with the Statement instance.

Equivalent to the sqlite3Statement#reset method. Returns a promise that is resolved with the Statement instance.

Equivalent to the sqlite3Statement#finalize method. Returns a promise that is resolved with no value because the statement can no longer be used.

Equivalent to the sqlite3Statement#run method. Returns a promise that is resolved with thethis parameter from the sqlite3 callback function.

Equivalent to the sqlite3Statement#get method. Returns a promise that is resolved with the row.

Equivalent to the sqlite3Statement#all method. Returns a promise that is resolved with the rows.

Equivalent to the sqlite3Statement#each method. The per-row callback function is requied. Returns a promise that is resolved with the Statement instance.

MIT License

Copyright (c) 2025 Frank Hellwig

Permission is hereby granted, free of charge, to any person obtaining a copyof this software and associated documentation files (the "Software"), to dealin the Software without restriction, including without limitation the rightsto use, copy, modify, merge, publish, distribute, sublicense, and/or sellcopies of the Software, and to permit persons to whom the Software isfurnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in allcopies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS ORIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THEAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHERLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THESOFTWARE.