Interface SqliteModule

The main SQLite module interface.

interface SqliteModule {
    constants: SqliteConstants;
    Database: new (
        location?: string | Buffer<ArrayBufferLike> | URL,
        options?: DatabaseSyncOptions,
    ) => DatabaseSyncInstance;
    DatabaseSync: new (
        location?: string | Buffer<ArrayBufferLike> | URL,
        options?: DatabaseSyncOptions,
    ) => DatabaseSyncInstance;
    Session: new () => Session;
    Statement: new (
        database: DatabaseSyncInstance,
        sql: string,
        options?: StatementOptions,
    ) => StatementSyncInstance;
    StatementSync: new (
        database: DatabaseSyncInstance,
        sql: string,
        options?: StatementOptions,
    ) => StatementSyncInstance;
}

Properties

SQLite constants for various operations and flags.

Database: new (
location?: string | Buffer<ArrayBufferLike> | URL,
options?: DatabaseSyncOptions,
) => DatabaseSyncInstance

The Database class represents a synchronous connection to a SQLite database. All operations are performed synchronously, blocking until completion.

DatabaseSync: new (
location?: string | Buffer<ArrayBufferLike> | URL,
options?: DatabaseSyncOptions,
) => DatabaseSyncInstance

The pre-rename name of SqliteModule.Database, kept as an alias. Node.js deprecates it in documentation only (DEP0210).

Session: new () => Session

The Session class for recording database changes. This class should not be instantiated directly; use Database.createSession() instead.

Statement: new (
    database: DatabaseSyncInstance,
    sql: string,
    options?: StatementOptions,
) => StatementSyncInstance

The Statement class represents a synchronous prepared statement. This class should not be instantiated directly; use Database.prepare() instead.

StatementSync: new (
    database: DatabaseSyncInstance,
    sql: string,
    options?: StatementOptions,
) => StatementSyncInstance

The pre-rename name of SqliteModule.Statement, kept as an alias. Node.js deprecates it in documentation only (DEP0211).