Class Database

Opens a SQLite database.

Closes the database. No further operations can be performed afterwards.

Execute the given SQL statement(s).

Load an extension from file

Create a prepared statement, to run SQL queries.

Wrap the given function so it runs in a transaction. When the (returned) function is invoked, it will start a new transaction. When the function returns, the transaction will be committed. If an exception is thrown, the transaction will be rolled back.

const ins = db.prepare('INSERT INTO test (txt, int) VALUES(?, ?)');
const insMany = db.transaction(datas => {
    for (const data of datas) {
        ins.run(data);
    }
});

insMany([
    [ '1234', 1234 ],
    [ '4321', 4321 ],
]);
Copy

Transaction functions can be called from inside other transaction functions. When doing so, the inner transaction becomes a savepoint. If an error is thrown inside of a nested transaction function, the nested transaction function will roll back to the state just before the savepoint. If the error is not caught in the outer transaction function, this will cause the outer transaction function to roll back as well.

Transactions also come with deferred, immediate, and exclusive versions:

insertMany(datas); // uses "BEGIN"
insertMany.deferred(datas); // uses "BEGIN DEFERRED"
insertMany.immediate(datas); // uses "BEGIN IMMEDIATE"
insertMany.exclusive(datas); // uses "BEGIN EXCLUSIVE"
Copy

NOTE: This implementation was mostly taken from better-sqlite3.