Source Code: lib/sqlite.js
\nThe node:sqlite module facilitates working with SQLite databases.\nTo access it:
import sqlite from 'node:sqlite';\nconst sqlite = require('node:sqlite');\nThis module is only available under the node: scheme.
The following example shows the basic usage of the node:sqlite module to open\nan in-memory database, write data to the database, and then read the data back.
import { DatabaseSync } from 'node:sqlite';\nconst database = new DatabaseSync(':memory:');\n\n// Execute SQL statements from strings.\ndatabase.exec(`\n CREATE TABLE data(\n key INTEGER PRIMARY KEY,\n value TEXT\n ) STRICT\n`);\n// Create a prepared statement to insert data into the database.\nconst insert = database.prepare('INSERT INTO data (key, value) VALUES (?, ?)');\n// Execute the prepared statement with bound values.\ninsert.run(1, 'hello');\ninsert.run(2, 'world');\n// Create a prepared statement to read data from the database.\nconst query = database.prepare('SELECT * FROM data ORDER BY key');\n// Execute the prepared statement and log the result set.\nconsole.log(query.all());\n// Prints: [ { key: 1, value: 'hello' }, { key: 2, value: 'world' } ]\n'use strict';\nconst { DatabaseSync } = require('node:sqlite');\nconst database = new DatabaseSync(':memory:');\n\n// Execute SQL statements from strings.\ndatabase.exec(`\n CREATE TABLE data(\n key INTEGER PRIMARY KEY,\n value TEXT\n ) STRICT\n`);\n// Create a prepared statement to insert data into the database.\nconst insert = database.prepare('INSERT INTO data (key, value) VALUES (?, ?)');\n// Execute the prepared statement with bound values.\ninsert.run(1, 'hello');\ninsert.run(2, 'world');\n// Create a prepared statement to read data from the database.\nconst query = database.prepare('SELECT * FROM data ORDER BY key');\n// Execute the prepared statement and log the result set.\nconsole.log(query.all());\n// Prints: [ { key: 1, value: 'hello' }, { key: 2, value: 'world' } ]\nThis class represents a single connection to a SQLite database. All APIs\nexposed by this class execute synchronously.
", "methods": [ { "textRaw": "`database.aggregate(name, options)`", "type": "method", "name": "aggregate", "meta": { "added": [ "v24.0.0" ], "changes": [] }, "signatures": [ { "params": [] } ], "desc": "Registers a new aggregate function with the SQLite database. This method is a wrapper around\nsqlite3_create_window_function().
name <string> The name of the SQLite function to create.options <Object> Function configuration settings.\ndeterministic <boolean> If true, the SQLITE_DETERMINISTIC flag is\nset on the created function. Default: false.directOnly <boolean> If true, the SQLITE_DIRECTONLY flag is set on\nthe created function. Default: false.useBigIntArguments <boolean> If true, integer arguments to options.step and options.inverse\nare converted to BigInts. If false, integer arguments are passed as\nJavaScript numbers. Default: false.varargs <boolean> If true, options.step and options.inverse may be invoked with any number of\narguments (between zero and SQLITE_MAX_FUNCTION_ARG). If false,\ninverse and step must be invoked with exactly length arguments.\nDefault: false.start <number> | <string> | <null> | <Array> | <Object> | <Function> The identity\nvalue for the aggregation function. This value is used when the aggregation\nfunction is initialized. When a <Function> is passed the identity will be its return value.step <Function> The function to call for each row in the aggregation. The\nfunction receives the current state and the row value. The return value of\nthis function should be the new state.result <Function> The function to call to get the result of the\naggregation. The function receives the final state and should return the\nresult of the aggregation.inverse <Function> When this function is provided, the aggregate method will work as a window function.\nThe function receives the current state and the dropped row value. The return value of this function should be the\nnew state.When used as a window function, the result function will be called multiple times.
const { DatabaseSync } = require('node:sqlite');\n\nconst db = new DatabaseSync(':memory:');\ndb.exec(`\n CREATE TABLE t3(x, y);\n INSERT INTO t3 VALUES ('a', 4),\n ('b', 5),\n ('c', 3),\n ('d', 8),\n ('e', 1);\n`);\n\ndb.aggregate('sumint', {\n start: 0,\n step: (acc, value) => acc + value,\n});\n\ndb.prepare('SELECT sumint(y) as total FROM t3').get(); // { total: 21 }\nimport { DatabaseSync } from 'node:sqlite';\n\nconst db = new DatabaseSync(':memory:');\ndb.exec(`\n CREATE TABLE t3(x, y);\n INSERT INTO t3 VALUES ('a', 4),\n ('b', 5),\n ('c', 3),\n ('d', 8),\n ('e', 1);\n`);\n\ndb.aggregate('sumint', {\n start: 0,\n step: (acc, value) => acc + value,\n});\n\ndb.prepare('SELECT sumint(y) as total FROM t3').get(); // { total: 21 }\nCloses the database connection. An exception is thrown if the database is not\nopen. This method is a wrapper around sqlite3_close_v2().
Loads a shared library into the database connection. This method is a wrapper\naround sqlite3_load_extension(). It is required to enable the\nallowExtension option when constructing the DatabaseSync instance.
Enables or disables the loadExtension SQL function, and the loadExtension()\nmethod. When allowExtension is false when constructing, you cannot enable\nloading extensions for security reasons.
This method is a wrapper around sqlite3_db_filename()
This method allows one or more SQL statements to be executed without returning\nany results. This method is useful when executing SQL statements read from a\nfile. This method is a wrapper around sqlite3_exec().
This method is used to create SQLite user-defined functions. This method is a\nwrapper around sqlite3_create_function_v2().
Opens the database specified in the path argument of the DatabaseSync\nconstructor. This method should only be used when the database is not opened via\nthe constructor. An exception is thrown if the database is already open.
Compiles a SQL statement into a prepared statement. This method is a wrapper\naround sqlite3_prepare_v2().
Creates and attaches a session to the database. This method is a wrapper around sqlite3session_create() and sqlite3session_attach().
An exception is thrown if the database is not\nopen. This method is a wrapper around sqlite3changeset_apply().
const sourceDb = new DatabaseSync(':memory:');\nconst targetDb = new DatabaseSync(':memory:');\n\nsourceDb.exec('CREATE TABLE data(key INTEGER PRIMARY KEY, value TEXT)');\ntargetDb.exec('CREATE TABLE data(key INTEGER PRIMARY KEY, value TEXT)');\n\nconst session = sourceDb.createSession();\n\nconst insert = sourceDb.prepare('INSERT INTO data (key, value) VALUES (?, ?)');\ninsert.run(1, 'hello');\ninsert.run(2, 'world');\n\nconst changeset = session.changeset();\ntargetDb.applyChangeset(changeset);\n// Now that the changeset has been applied, targetDb contains the same data as sourceDb.\nCloses the database connection. If the database connection is already closed\nthen this is a no-op.
" } ], "properties": [ { "textRaw": "`isOpen` {boolean} Whether the database is currently open or not.", "type": "boolean", "name": "isOpen", "meta": { "added": [ "v23.11.0", "v22.15.0" ], "changes": [] }, "desc": "Whether the database is currently open or not." }, { "textRaw": "`isTransaction` {boolean} Whether the database is currently within a transaction. This method is a wrapper around [`sqlite3_get_autocommit()`][].", "type": "boolean", "name": "isTransaction", "meta": { "added": [ "v24.0.0" ], "changes": [] }, "desc": "Whether the database is currently within a transaction. This method is a wrapper around [`sqlite3_get_autocommit()`][]." } ], "signatures": [ { "params": [ { "textRaw": "`path` {string | Buffer | URL} The path of the database. A SQLite database can be stored in a file or completely [in memory][]. To use a file-backed database, the path should be a file path. To use an in-memory database, the path should be the special name `':memory:'`.", "name": "path", "type": "string | Buffer | URL", "desc": "The path of the database. A SQLite database can be stored in a file or completely [in memory][]. To use a file-backed database, the path should be a file path. To use an in-memory database, the path should be the special name `':memory:'`." }, { "textRaw": "`options` {Object} Configuration options for the database connection. The following options are supported:", "name": "options", "type": "Object", "desc": "Configuration options for the database connection. The following options are supported:", "options": [ { "textRaw": "`open` {boolean} If `true`, the database is opened by the constructor. When this value is `false`, the database must be opened via the `open()` method. **Default:** `true`.", "name": "open", "type": "boolean", "default": "`true`", "desc": "If `true`, the database is opened by the constructor. When this value is `false`, the database must be opened via the `open()` method." }, { "textRaw": "`readOnly` {boolean} If `true`, the database is opened in read-only mode. If the database does not exist, opening it will fail. **Default:** `false`.", "name": "readOnly", "type": "boolean", "default": "`false`", "desc": "If `true`, the database is opened in read-only mode. If the database does not exist, opening it will fail." }, { "textRaw": "`enableForeignKeyConstraints` {boolean} If `true`, foreign key constraints are enabled. This is recommended but can be disabled for compatibility with legacy database schemas. The enforcement of foreign key constraints can be enabled and disabled after opening the database using [`PRAGMA foreign_keys`][]. **Default:** `true`.", "name": "enableForeignKeyConstraints", "type": "boolean", "default": "`true`", "desc": "If `true`, foreign key constraints are enabled. This is recommended but can be disabled for compatibility with legacy database schemas. The enforcement of foreign key constraints can be enabled and disabled after opening the database using [`PRAGMA foreign_keys`][]." }, { "textRaw": "`enableDoubleQuotedStringLiterals` {boolean} If `true`, SQLite will accept [double-quoted string literals][]. This is not recommended but can be enabled for compatibility with legacy database schemas. **Default:** `false`.", "name": "enableDoubleQuotedStringLiterals", "type": "boolean", "default": "`false`", "desc": "If `true`, SQLite will accept [double-quoted string literals][]. This is not recommended but can be enabled for compatibility with legacy database schemas." }, { "textRaw": "`allowExtension` {boolean} If `true`, the `loadExtension` SQL function and the `loadExtension()` method are enabled. You can call `enableLoadExtension(false)` later to disable this feature. **Default:** `false`.", "name": "allowExtension", "type": "boolean", "default": "`false`", "desc": "If `true`, the `loadExtension` SQL function and the `loadExtension()` method are enabled. You can call `enableLoadExtension(false)` later to disable this feature." }, { "textRaw": "`timeout` {number} The [busy timeout][] in milliseconds. This is the maximum amount of time that SQLite will wait for a database lock to be released before returning an error. **Default:** `0`.", "name": "timeout", "type": "number", "default": "`0`", "desc": "The [busy timeout][] in milliseconds. This is the maximum amount of time that SQLite will wait for a database lock to be released before returning an error." } ] } ], "desc": "Constructs a new DatabaseSync instance.
Retrieves a changeset containing all changes since the changeset was created. Can be called multiple times.\nAn exception is thrown if the database or the session is not open. This method is a wrapper around sqlite3session_changeset().
Similar to the method above, but generates a more compact patchset. See Changesets and Patchsets\nin the documentation of SQLite. An exception is thrown if the database or the session is not open. This method is a\nwrapper around sqlite3session_patchset().
Closes the session. An exception is thrown if the database or the session is not open. This method is a\nwrapper around sqlite3session_delete().
This class represents a single prepared statement. This class cannot be\ninstantiated via its constructor. Instead, instances are created via the\ndatabase.prepare() method. All APIs exposed by this class execute\nsynchronously.
A prepared statement is an efficient binary representation of the SQL used to\ncreate it. Prepared statements are parameterizable, and can be invoked multiple\ntimes with different bound values. Parameters also offer protection against\nSQL injection attacks. For these reasons, prepared statements are preferred\nover hand-crafted SQL strings when handling user input.
", "methods": [ { "textRaw": "`statement.all([namedParameters][, ...anonymousParameters])`", "type": "method", "name": "all", "meta": { "added": [ "v22.5.0" ], "changes": [ { "version": [ "v23.7.0", "v22.14.0" ], "pr-url": "https://github.com/nodejs/node/pull/56385", "description": "Add support for `DataView` and typed array objects for `anonymousParameters`." } ] }, "signatures": [ { "return": { "textRaw": "Returns: {Array} An array of objects. Each object corresponds to a row returned by executing the prepared statement. The keys and values of each object correspond to the column names and values of the row.", "name": "return", "type": "Array", "desc": "An array of objects. Each object corresponds to a row returned by executing the prepared statement. The keys and values of each object correspond to the column names and values of the row." }, "params": [ { "textRaw": "`namedParameters` {Object} An optional object used to bind named parameters. The keys of this object are used to configure the mapping.", "name": "namedParameters", "type": "Object", "desc": "An optional object used to bind named parameters. The keys of this object are used to configure the mapping." }, { "textRaw": "`...anonymousParameters` {null|number|bigint|string|Buffer|TypedArray|DataView} Zero or more values to bind to anonymous parameters.", "name": "...anonymousParameters", "type": "null|number|bigint|string|Buffer|TypedArray|DataView", "desc": "Zero or more values to bind to anonymous parameters." } ] } ], "desc": "This method executes a prepared statement and returns all results as an array of\nobjects. If the prepared statement does not return any results, this method\nreturns an empty array. The prepared statement parameters are bound using\nthe values in namedParameters and anonymousParameters.
This method is used to retrieve information about the columns returned by the\nprepared statement.
" }, { "textRaw": "`statement.get([namedParameters][, ...anonymousParameters])`", "type": "method", "name": "get", "meta": { "added": [ "v22.5.0" ], "changes": [ { "version": [ "v23.7.0", "v22.14.0" ], "pr-url": "https://github.com/nodejs/node/pull/56385", "description": "Add support for `DataView` and typed array objects for `anonymousParameters`." } ] }, "signatures": [ { "return": { "textRaw": "Returns: {Object|undefined} An object corresponding to the first row returned by executing the prepared statement. The keys and values of the object correspond to the column names and values of the row. If no rows were returned from the database then this method returns `undefined`.", "name": "return", "type": "Object|undefined", "desc": "An object corresponding to the first row returned by executing the prepared statement. The keys and values of the object correspond to the column names and values of the row. If no rows were returned from the database then this method returns `undefined`." }, "params": [ { "textRaw": "`namedParameters` {Object} An optional object used to bind named parameters. The keys of this object are used to configure the mapping.", "name": "namedParameters", "type": "Object", "desc": "An optional object used to bind named parameters. The keys of this object are used to configure the mapping." }, { "textRaw": "`...anonymousParameters` {null|number|bigint|string|Buffer|TypedArray|DataView} Zero or more values to bind to anonymous parameters.", "name": "...anonymousParameters", "type": "null|number|bigint|string|Buffer|TypedArray|DataView", "desc": "Zero or more values to bind to anonymous parameters." } ] } ], "desc": "This method executes a prepared statement and returns the first result as an\nobject. If the prepared statement does not return any results, this method\nreturns undefined. The prepared statement parameters are bound using the\nvalues in namedParameters and anonymousParameters.
This method executes a prepared statement and returns an iterator of\nobjects. If the prepared statement does not return any results, this method\nreturns an empty iterator. The prepared statement parameters are bound using\nthe values in namedParameters and anonymousParameters.
This method executes a prepared statement and returns an object summarizing the\nresulting changes. The prepared statement parameters are bound using the\nvalues in namedParameters and anonymousParameters.
The names of SQLite parameters begin with a prefix character. By default,\nnode:sqlite requires that this prefix character is present when binding\nparameters. However, with the exception of dollar sign character, these\nprefix characters also require extra quoting when used in object keys.
To improve ergonomics, this method can be used to also allow bare named\nparameters, which do not require the prefix character in JavaScript code. There\nare several caveats to be aware of when enabling bare named parameters:
\n$k and @k, in the same prepared\nstatement will result in an exception as it cannot be determined how to bind\na bare name.By default, if an unknown name is encountered while binding parameters, an\nexception is thrown. This method allows unknown named parameters to be ignored.
" }, { "textRaw": "`statement.setReadBigInts(enabled)`", "type": "method", "name": "setReadBigInts", "meta": { "added": [ "v22.5.0" ], "changes": [] }, "signatures": [ { "params": [ { "textRaw": "`enabled` {boolean} Enables or disables the use of `BigInt`s when reading `INTEGER` fields from the database.", "name": "enabled", "type": "boolean", "desc": "Enables or disables the use of `BigInt`s when reading `INTEGER` fields from the database." } ] } ], "desc": "When reading from the database, SQLite INTEGERs are mapped to JavaScript\nnumbers by default. However, SQLite INTEGERs can store values larger than\nJavaScript numbers are capable of representing. In such cases, this method can\nbe used to read INTEGER data using JavaScript BigInts. This method has no\nimpact on database write operations where numbers and BigInts are both\nsupported at all times.
The source SQL text of the prepared statement with parameter\nplaceholders replaced by the values that were used during the most recent\nexecution of this prepared statement. This property is a wrapper around\nsqlite3_expanded_sql().
The source SQL text of the prepared statement. This property is a\nwrapper around sqlite3_sql().
When Node.js writes to or reads from SQLite it is necessary to convert between\nJavaScript data types and SQLite's data types. Because JavaScript supports\nmore data types than SQLite, only a subset of JavaScript types are supported.\nAttempting to write an unsupported data type to SQLite will result in an\nexception.
\n| SQLite | \nJavaScript | \n
|---|---|
NULL | \n<null> | \n
INTEGER | \n<number> or <bigint> | \n
REAL | \n<number> | \n
TEXT | \n<string> | \n
BLOB | \n<TypedArray> or <DataView> | \n
This method makes a database backup. This method abstracts the sqlite3_backup_init(), sqlite3_backup_step()\nand sqlite3_backup_finish() functions.
The backed-up database can be used normally during the backup process. Mutations coming from the same connection - same\n<DatabaseSync> - object will be reflected in the backup right away. However, mutations from other connections will cause\nthe backup process to restart.
\nconst { backup, DatabaseSync } = require('node:sqlite');\n\n(async () => {\n const sourceDb = new DatabaseSync('source.db');\n const totalPagesTransferred = await backup(sourceDb, 'backup.db', {\n rate: 1, // Copy one page at a time.\n progress: ({ totalPages, remainingPages }) => {\n console.log('Backup in progress', { totalPages, remainingPages });\n },\n });\n\n console.log('Backup completed', totalPagesTransferred);\n})();\nimport { backup, DatabaseSync } from 'node:sqlite';\n\nconst sourceDb = new DatabaseSync('source.db');\nconst totalPagesTransferred = await backup(sourceDb, 'backup.db', {\n rate: 1, // Copy one page at a time.\n progress: ({ totalPages, remainingPages }) => {\n console.log('Backup in progress', { totalPages, remainingPages });\n },\n});\n\nconsole.log('Backup completed', totalPagesTransferred);\nAn object containing commonly used constants for SQLite operations.
", "modules": [ { "textRaw": "SQLite constants", "name": "sqlite_constants", "desc": "The following constants are exported by the sqlite.constants object.
One of the following constants is available as an argument to the onConflict\nconflict resolution handler passed to database.applyChangeset(). See also\nConstants Passed To The Conflict Handler in the SQLite documentation.
| Constant | \nDescription | \n
|---|---|
SQLITE_CHANGESET_DATA | \n The conflict handler is invoked with this constant when processing a DELETE or UPDATE change if a row with the required PRIMARY KEY fields is present in the database, but one or more other (non primary-key) fields modified by the update do not contain the expected \"before\" values. | \n
SQLITE_CHANGESET_NOTFOUND | \n The conflict handler is invoked with this constant when processing a DELETE or UPDATE change if a row with the required PRIMARY KEY fields is not present in the database. | \n
SQLITE_CHANGESET_CONFLICT | \n This constant is passed to the conflict handler while processing an INSERT change if the operation would result in duplicate primary key values. | \n
SQLITE_CHANGESET_CONSTRAINT | \n If foreign key handling is enabled, and applying a changeset leaves the database in a state containing foreign key violations, the conflict handler is invoked with this constant exactly once before the changeset is committed. If the conflict handler returns SQLITE_CHANGESET_OMIT, the changes, including those that caused the foreign key constraint violation, are committed. Or, if it returns SQLITE_CHANGESET_ABORT, the changeset is rolled back. | \n
SQLITE_CHANGESET_FOREIGN_KEY | \n If any other constraint violation occurs while applying a change (i.e. a UNIQUE, CHECK or NOT NULL constraint), the conflict handler is invoked with this constant. | \n
One of the following constants must be returned from the onConflict conflict\nresolution handler passed to database.applyChangeset(). See also\nConstants Returned From The Conflict Handler in the SQLite documentation.
| Constant | \nDescription | \n
|---|---|
SQLITE_CHANGESET_OMIT | \n Conflicting changes are omitted. | \n
SQLITE_CHANGESET_REPLACE | \n Conflicting changes replace existing values. Note that this value can only be returned when the type of conflict is either SQLITE_CHANGESET_DATA or SQLITE_CHANGESET_CONFLICT. | \n
SQLITE_CHANGESET_ABORT | \n Abort when a change encounters a conflict and roll back database. | \n