SQL.SQLiteOptions

interface SQLiteOptions

• adapter?: 'sqlite'
• create?: boolean

  Allow creating a new database

  Equivalent to constants.SQLITE_OPEN_CREATE

• filename?: URL | string & {} | ':memory:'

  Path to the database file

  Examples:

  • sqlite://:memory:
  • sqlite://./path/to/database.db
  • sqlite:///Users/bun/projects/my-app/database.db
  • ./dev.db
  • :memory:
• onclose?: (err: null | Error) => void

  Called when a connection is closed. Receives the closing Error, or null.

• onconnect?: (err: null | Error) => void

  Called when a connection attempt completes. Receives an Error on failure, or null on success.

• readonly?: boolean

  Open the database as read-only (no write operations, no create).

  Equivalent to constants.SQLITE_OPEN_READONLY

• readwrite?: boolean

  Open the database as read-write

  Equivalent to constants.SQLITE_OPEN_READWRITE

• safeIntegers?: boolean

  When true, integers are returned as bigint.

  When false, integers are returned as number and truncated to 52 bits.

• strict?: boolean

  When set to false or undefined:

  • Queries missing bound parameters do NOT throw an error
  • Bound named parameters in JavaScript need to exactly match the SQL query.

  const db = new Database(":memory:", { strict: false });
  db.run("INSERT INTO foo (name) VALUES ($name)", { $name: "foo" });

  When set to true:

  • Queries missing bound parameters throw an error
  • Bound named parameters in JavaScript no longer need the $, :, or @ prefix. The SQL query keeps its prefix.