doc: show the use of string expressions in the SQLTagStore example #60873
+4
−4
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
If a users attempts to escape strings with quotes in SQLTagStore
template strings (`'${expression}'`), as is usually required for
SQL query strings, the queries would fail. This change shows an
example on the correct use (`${expression}`).
Collaborator
|
Review requested:
|
nodejs-github-bot
added
doc
cjihrig
approved these changes
Nov 28, 2025
aduh95
added
author ready
nodejs-github-bot
removed
the
commit-queue
Collaborator
|
Landed in d0c1024 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Slight edit to the example shown for the
database.createTagStoreAPI. Showing the get query with a string instead of a number to demonstrate correct usage of the template literals in combination with string expressions.Reason for this change:
Because strings in SQL queries are usually enclosed in quotation marks:
"SELECT * FROM users WHERE name = 'Alice'"Users may be tempted to enclose them in quotation marks in the template literals used for the SQLTagStore API:
const user = sql.get`SELECT * FROM users WHERE name = '${name}'`;This would lead to a incorrect SQL query (which might actually fail quietly). The correct form is to leave the quotation marks out:
const user = sql.get`SELECT * FROM users WHERE name = ${name}`;