Bun

interface

sqlite.DatabaseSyncOptions

interface DatabaseSyncOptions

  • allowBareNamedParameters?: boolean

    If true, allows binding named parameters without the prefix character (e.g., foo instead of :foo).

  • allowExtension?: boolean

    If true, the loadExtension SQL function and the loadExtension() method are enabled. You can call enableLoadExtension(false) later to disable this feature.

  • allowUnknownNamedParameters?: boolean

    If true, unknown named parameters are ignored when binding. If false, an exception is thrown for unknown named parameters.

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

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

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

  • readBigInts?: boolean

    If true, integer fields are read as JavaScript BigInt values. If false, integer fields are read as JavaScript numbers.

  • readOnly?: boolean

    If true, the database is opened in read-only mode. If the database does not exist, opening it will fail.

  • returnArrays?: boolean

    If true, query results are returned as arrays instead of objects.

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