Skip to content

doc: clarify sqlite bare named parameter default #64919

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

Closed
sanzofr wants to merge 1 commit into from
+8 −7
Closed

doc: clarify sqlite bare named parameter default #64919

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
15 changes: 8 additions & 7 deletions doc/api/sqlite.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1134,13 +1134,14 @@ 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.

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:
`node:sqlite` allows bare named parameters because
`allowBareNamedParameters` defaults to `true`. When bare named parameters are
disabled, the prefix character is required when binding parameters. However,
with the exception of the dollar sign character, these prefix characters also
require extra quoting when used in object keys.

This method enables or disables bare named parameters. 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
Loading