DB

Create a new database. The passed path will be opened with read/ write permissions and created if it does not already exist.

The default opens an in-memory database.

DB.changes

Return the number of rows modified, inserted or deleted by the most recently completed query. This corresponds to the SQLite function sqlite3_changes.

DB.lastInsertRowId

Get last inserted row id. This corresponds to the SQLite function sqlite3_last_insert_rowid.

By default, it will return 0 if there is no row inserted yet.

DB.totalChanges

Return the number of rows modified, inserted or deleted since the database was opened. This corresponds to the SQLite function sqlite3_total_changes.

DB.close

Close database handle. This must be called if DB is no longer used, to avoid leaking file resources.

If force is specified, any on-going transactions will be closed.

DB.query

Run a query against the database. The query can contain placeholder parameters, which are bound to the values passed in 'values'.

db.query("SELECT name, email FROM users WHERE subscribed = ? AND list LIKE ?", [true, listName]);

This supports positional and named parameters. Positional parameters can be set by passing an array for values. Named parameters can be set by passing an object for values.

While they can be mixed in principle, this is not recommended.

(see https://www.sqlite.org/lang_expr.html)

Values may only be of the following types and are converted as follows:

If no value is provided to a given parameter, SQLite will default to NULL.

If a bigint is bound, it is converted to a signed 64 big integer, which may not be lossless. If an integer value is read from the database, which is too big to safely be contained in a number, it is automatically returned as a bigint.

If a Date is bound, it will be converted to an ISO 8601 string: YYYY-MM-DDTHH:MM:SS.SSSZ. This format is understood by built-in SQLite date-time functions. Also see https://sqlite.org/lang_datefunc.html.

This always returns an iterable Rows object. As a special case, if the query has no rows to return this returns the Empty row (which is also iterable, but has zero entries).

!> Any returned Rows object needs to be fully iterated over or discarded by calling .return() or closing the iterator.