Skip to content

doc: clarify sqlite bare named parameter default - #62009

Open
skdas20 wants to merge 1 commit into
nodejs:mainfrom
skdas20:docs/sqlite-allow-bare-named-params-61823
Open

doc: clarify sqlite bare named parameter default#62009
skdas20 wants to merge 1 commit into
nodejs:mainfrom
skdas20:docs/sqlite-allow-bare-named-params-61823

Conversation

@skdas20

@skdas20 skdas20 commented Feb 26, 2026

Copy link
Copy Markdown
Contributor

Fixes #61823

Summary

Updates statement.setAllowBareNamedParameters() documentation to match the actual default behavior.

  • Replaced wording that implied prefixed named parameters are required by default.
  • Clarified that bare named parameters are allowed by default.
  • Clarified that this API toggles the behavior (enable/disable), and caveats apply when bare names are enabled.

Validation

Ran markdown lint on the changed file:

node tools/lint-md/lint-md.mjs doc/api/sqlite.md

Result: exit code 0.

@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/sqlite

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. sqlite Issues and PRs related to the SQLite subsystem. labels Feb 26, 2026

@mike-git374 mike-git374 left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

I approve the PR and the wording is correct, but I suggest this 1 change. Then might need to re-lint

Comment thread doc/api/sqlite.md Outdated
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
Copy Markdown

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

@trivikr

trivikr commented Jul 27, 2026

Copy link
Copy Markdown
Member

@skdas20 Can you please sign the first commit and force push?

It's required as per instructions

Your commit must contain the Signed-off-by line with your name and email address as an acknowledgement that you agree to the Developer Certificate of Origin

Signed-off-by: skdas20 <skdas5405@gmail.com>
@skdas20
skdas20 force-pushed the docs/sqlite-allow-bare-named-params-61823 branch from a6301f7 to b571db8 Compare July 27, 2026 05:00
@skdas20

skdas20 commented Jul 27, 2026

Copy link
Copy Markdown
Contributor Author

Thanks @trivikr — done. Squashed into a single signed commit and force-pushed; the diff is unchanged. Also set the author to an email verified on my GitHub account (same as I did on #62010).

@trivikr

trivikr commented Jul 27, 2026

Copy link
Copy Markdown
Member

cc @nodejs/sqlite

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Issues and PRs related to the documentations. sqlite Issues and PRs related to the SQLite subsystem.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: sqlite statement.setAllowBareNamedParameters()

4 participants