Skip to content

doc: clarify sqlite bare named parameter default #62009

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
skdas20 wants to merge 1 commit into
base: main
Choose a base branch
from
+6 −6
Open

doc: clarify sqlite bare named parameter default #62009

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions doc/api/sqlite.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -943,13 +943,13 @@ added: v22.5.0
without the prefix character.

The names of SQLite parameters begin with a prefix character. By default,
`node:sqlite` requires that this prefix character is present when binding
parameters. However, with the exception of dollar sign character, these
prefix characters also require extra quoting when used in object keys.
`node:sqlite` allows binding named parameters without this prefix character in
JavaScript code. With the exception of the dollar sign character, these prefix
Copy link

@mike-git374 mike-git374 Feb 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
JavaScript code. With the exception of the dollar sign character, these prefix
the parameter object. With the exception of the dollar sign character, these prefix

characters require extra quoting when used in object keys.

To improve ergonomics, this method can be used to also allow bare named
parameters, which do not require the prefix character in JavaScript code. There
are several caveats to be aware of when enabling bare named parameters:
This method enables or disables support for bare named parameters, which do not
require the prefix character in JavaScript code. There are several caveats to
be aware of when bare named parameters are enabled:

* The prefix character is still required in SQL.
* The prefix character is still allowed in JavaScript. In fact, prefixed names
Expand Down