SQLite for Deno API Documentation

This file documents all of the public interfaces for deno-sqlite. The documentation is generated automatically using the docs/generate.js script. If you want to clarify any of the notes in this file, edit the corresponding comment in the source file and rerun the generator, to avoid loosing the changes.

How to import

import { DB, Empty, Status } from "https://deno.land/x/sqlite/mod.ts"

The above statement lists all the available imports.

DB

new DB(path = ":memory:")

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.query

query(sql, values)

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 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 .done().

DB.close

close(force = false)

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.lastInsertRowId

get 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.

SqliteError

new SqliteError(message, code)

Extension over the standard JS Error object to also contain class members for error code and error code name.

This class is not exported by the module and should only be obtained from exceptions raised in this module.

SqliteError.code

The SQLite result status code, see the SQLite docs for more information about each code.

https://www.sqlite.org/rescode.html

Beyond the SQLite status codes, this member can also contain custom status codes specific to this library (starting from 1000).

Errors that originate in the JavaScript part of the library will not have an associated status code. For these errors, the code will be Status.Unknown.

These codes are accessible via the exported Status object.

SqliteError.codeName

get codeName()

Key of code in exported status object.

E.g. if code is 19, codeName would be SqliteConstraint.

Rows

new Rows(db, stmt)

Rows represent a set of results from a query. They are iterable and yield arrays with the data from the selected columns.

This class is not exported from the module and the only correct way to obtain a Rows object is by making a database query.

Rows.done

done()

Call this if you are done with the query and have not iterated over all the available results.

!> If you leave rows with results before making new queries, you will leak memory. Always use .done() instead of break.

const rows = db.query("SELECT name FROM users;");
for (const [name] of rows) {
  if (name === "Clark Kent")
    rows.done();
}

Rows.next

next()

Implements the iterator protocol.

Rows.columns

columns()

Call this if you need column names from the result of a select query.

This method returns an array of objects, where each object has the following properties:

Empty

A special constant. This is a Rows object which has no results. It is still iterable, however it won’t yield any results.

Empty is returned from queries which return no data.