Interface EnhancedStatementMethods

Readonlydatabase

expand

• expand(toggle?: boolean): this

  Causes the statement to return data namespaced by table. Each key in a row object will be a table name, and each corresponding value will be a nested object containing that table's columns. Columns from expressions or subqueries are placed under the special $ namespace.

  When expand mode is turned on, pluck and raw modes are turned off.

  Requires the statement to have a .columns() method (available on real statements but not minimal mocks).

  Parameters

  • Optionaltoggle: boolean

    Enable (true) or disable (false) expand mode. Defaults to true.

  Returns this

  The same statement for chaining.

  Example

  const rows = db.prepare("SELECT u.id, u.name, p.title FROM users u JOIN posts p ON ...").expand().all();
  // Returns: [{ users: { id: 1, name: "Alice" }, posts: { title: "Hello" } }]
  Copy

pluck

• pluck(toggle?: boolean): this

  Causes the statement to return only the first column value of each row.

  When plucking is turned on, raw and expand modes are turned off.

  Parameters

  • Optionaltoggle: boolean

    Enable (true) or disable (false) pluck mode. Defaults to true.

  Returns this

  The same statement for chaining.

  Example

  const count = db.prepare("SELECT COUNT(*) FROM users").pluck().get();
  // Returns: 42 (not { "COUNT(*)": 42 })
  
  const names = db.prepare("SELECT name FROM users").pluck().all();
  // Returns: ["Alice", "Bob"] (not [{ name: "Alice" }, { name: "Bob" }])
  Copy

raw

• raw(toggle?: boolean): this

  Causes the statement to return rows as arrays of values instead of objects.

  When raw mode is turned on, pluck and expand modes are turned off.

  Parameters

  • Optionaltoggle: boolean

    Enable (true) or disable (false) raw mode. Defaults to true.

  Returns this

  The same statement for chaining.

  Example

  const rows = db.prepare("SELECT id, name FROM users").raw().all();
  // Returns: [[1, "Alice"], [2, "Bob"]] (not [{ id: 1, name: "Alice" }, ...])
  Copy