Skip to content

sqlite: db.prepare(sql, options) #61235

Closed
#61311
Closed
sqlite: db.prepare(sql, options)#61235
#61311
Labels
feature requestIssues requesting new Node.js features.sqliteIssues and PRs related to the SQLite subsystem.

Description

@mike-git374
mike-git374
opened on Jan 1, 2026

Problem

Currently you need multiple js statements to declare a single SQLite statement with options like returnArrays, readBigInts etc. This requires multiple lines and can be inefficient to call c++ multiple times:

const q = db.prepare(sql);
q.setReturnArrays(true);
q.setReadBigInts(true);
q.setAllowBareNamedParameters(true);
q.setAllowUnknownNamedParameters(true);

Proposal 1

Allow chaining statement.set* functions by returning the sql statement instead of undefined. This allows declaring a sql statement with 1 JS statement. This still requires multiple function calls but is slightly better DX developer experience using the existing set* functions:

// before
const q = db.prepare(sql);
q.setReturnArrays(true);

// after
const q = db.prepare(sql).setReturnArrays(true);

// more example
const q = db.prepare(sql).setReturnArrays(true).setReadBigInts(true);

PR: #61263

Proposal 2

Add options argument: db.prepare(sql[, options])

// before
const q = db.prepare(sql);
q.setReturnArrays(true);

// after
const q = db.prepare(sql, { returnArrays: true });

// more example
const q = db.prepare(sql, { returnArrays: true, readBigInts: true });

In this case I recommend to remove the statement.set* functions to simplify the API, you only need db.prepare(sql[, options])

Proposal 3

Do both Proposal 1 and Proposal 2. Currently I am leaning towards Proposal 2 and removing set* functions

Activity

  1. mike-git374
    added
    feature requestIssues requesting new Node.js features.
    on Jan 1, 2026
  2. github-project-automation
    added this to Node.js feature requestson Jan 1, 2026
  3. github-project-automation
    moved this to Awaiting Triage in Node.js feature requestson Jan 1, 2026
  4. mike-git374
    changed the title [-]sqlite `db.prepare(sql).set*` should return statement for chaining[/-] [+]sqlite: add `db.prepare(sql, options)` options object[/+] on Jan 1, 2026
  5. mike-git374
    changed the title [-]sqlite: add `db.prepare(sql, options)` options object[/-] [+]sqlite: add `db.prepare(sql, options)`[/+] on Jan 1, 2026
  6. mike-git374
    changed the title [-]sqlite: add `db.prepare(sql, options)`[/-] [+]sqlite: `db.prepare(sql, options)`[/+] on Jan 1, 2026
  7. mike-git374
    changed the title [-]sqlite: `db.prepare(sql, options)`[/-] [+]sqlite: `db.prepare(sql).set*` chain[/+] on Jan 1, 2026

  8. Renegade334 commented on Jan 2, 2026

    @Renegade334
    Renegade334
    on Jan 2, 2026
    Member

    I think your original proposal (an options argument to db.prepare()) is more consistent with existing node:sqlite patterns, and with Node.js conventions on the whole. That being said, is your usage case already covered by passing defaults to the DatabaseSync constructor?

  9. Renegade334
    added
    sqliteIssues and PRs related to the SQLite subsystem.
    on Jan 2, 2026
  10. mike-git374
    changed the title [-]sqlite: `db.prepare(sql).set*` chain[/-] [+]sqlite: multiple JS statements needed to declare 1 sql statement[/+] on Jan 4, 2026
  11. mike-git374
    changed the title [-]sqlite: multiple JS statements needed to declare 1 sql statement[/-] [+]sqlite: `db.prepare(sql[, options])`[/+] on Jan 4, 2026
  12. mike-git374
    changed the title [-]sqlite: `db.prepare(sql[, options])`[/-] [+]sqlite: db.prepare(sql, options)[/+] on Jan 4, 2026

  13. mcollina commented on Jan 5, 2026

    @mcollina
    mcollina
    on Jan 5, 2026
    SponsorMember

    Go for proposal 2.

  14. baeseokjae commented on Jan 6, 2026

    @baeseokjae
    baeseokjae
    on Jan 6, 2026

    I'm interested in implementing this. Can I take this on?

  15. mike-git374 commented on Jan 6, 2026

    @mike-git374
    mike-git374
    on Jan 6, 2026
    ContributorAuthor

    While this issue is open anyone can open a PR, thanks

  16. nodejs-github-bot
    closed this as completedin #61311on Jan 19, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    feature requestIssues requesting new Node.js features.sqliteIssues and PRs related to the SQLite subsystem.

    Type

    No type

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions