sqlite: bind undefined to NULL#65709

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
TrevorBurnham wants to merge 1 commit into
base:main
Choose a base branch
from
+117 −12
Open

sqlite: bind undefined to NULL #65709

Show file tree
Hide file tree
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
59 changes: 50 additions & 9 deletions doc/api/sqlite.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -101,7 +101,7 @@ exception.

| Storage class | JavaScript to SQLite | SQLite to JavaScript |
| ------------- | --------------------------------------------------------------- | ------------------------------------- |
| `NULL` | {null} | {null} |
| `NULL` | {null} or {undefined} | {null} |
| `INTEGER` | {number}, {bigint}, or {boolean} | {number} or {bigint} _(configurable)_ |
| `REAL` | {number} | {number} |
| `TEXT` | {string} | {string} |
Expand All@@ -113,6 +113,10 @@ values (`1n` and `0n`) when reading BigInts is enabled. Writing a {bigint} that
does not fit in a signed 64-bit integer throws an `ERR_INVALID_ARG_VALUE`
error.

`undefined` is written as `NULL`, so passing it explicitly is equivalent to
omitting a named parameter. `NULL` always reads back as {null}, never
`undefined`.

APIs that read values from SQLite have a configuration option that determines
whether `INTEGER` values are converted to `number` or `bigint` in JavaScript,
such as the `readBigInts` option for statements and the `useBigIntArguments`
Expand DownExpand Up@@ -1089,6 +1093,11 @@ Binding a key that does not name a parameter of the statement throws an
`ERR_INVALID_STATE` error unless unknown named parameters are ignored. See
[`statement.setAllowUnknownNamedParameters()`][].

Parameters that are never bound are `NULL`, and binding `undefined` has the same
effect, so `{ $a: undefined }` and `{}` are equivalent. Because `undefined` is
not an object, passing it in place of `namedParameters` binds it as an anonymous
parameter instead.

See [Type conversion between JavaScript and SQLite][] for the values that can be
bound. Binding any other value throws an `ERR_INVALID_ARG_TYPE` error.

Expand All@@ -1097,6 +1106,9 @@ bound. Binding any other value throws an `ERR_INVALID_ARG_TYPE` error.
<!-- YAML
added: v22.5.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/65709
description: Bind `undefined` to `NULL`.
- version: v26.8.0
pr-url: https://github.com/nodejs/node/pull/62001
description: Add support for boolean values in bound parameters.
Expand All@@ -1112,7 +1124,8 @@ changes:

* `namedParameters` {Object} An optional object used to bind named parameters.
The keys of this object are used to configure the mapping.
* `...anonymousParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...anonymousParameters`
{undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
Zero or more values to bind to anonymous parameters.
* Returns: {Array} An array of objects. Each object corresponds to a row
returned by executing the prepared statement. The keys and values of each
Expand DownExpand Up@@ -1185,6 +1198,9 @@ execution of this prepared statement. This property is a wrapper around
<!-- YAML
added: v22.5.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/65709
description: Bind `undefined` to `NULL`.
- version: v26.8.0
pr-url: https://github.com/nodejs/node/pull/62001
description: Add support for boolean values in bound parameters.
Expand All@@ -1200,7 +1216,8 @@ changes:

* `namedParameters` {Object} An optional object used to bind named parameters.
The keys of this object are used to configure the mapping.
* `...anonymousParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...anonymousParameters`
{undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
Zero or more values to bind to anonymous parameters.
* Returns: {Object|undefined} An object corresponding to the first row returned
by executing the prepared statement. The keys and values of the object
Expand All@@ -1220,6 +1237,9 @@ added:
- v23.4.0
- v22.13.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/65709
description: Bind `undefined` to `NULL`.
- version: v26.8.0
pr-url: https://github.com/nodejs/node/pull/62001
description: Add support for boolean values in bound parameters.
Expand All@@ -1235,7 +1255,8 @@ changes:

* `namedParameters` {Object} An optional object used to bind named parameters.
The keys of this object are used to configure the mapping.
* `...anonymousParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...anonymousParameters`
{undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
Zero or more values to bind to anonymous parameters.
* Returns: {Iterator} An iterable iterator of objects. Each object corresponds to a row
returned by executing the prepared statement. The keys and values of each
Expand DownExpand Up@@ -1264,6 +1285,9 @@ executions of the same prepared statement.
<!-- YAML
added: v22.5.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/65709
description: Bind `undefined` to `NULL`.
- version: v26.8.0
pr-url: https://github.com/nodejs/node/pull/62001
description: Add support for boolean values in bound parameters.
Expand All@@ -1279,7 +1303,8 @@ changes:

* `namedParameters` {Object} An optional object used to bind named parameters.
The keys of this object are used to configure the mapping.
* `...anonymousParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...anonymousParameters`
{undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
Zero or more values to bind to anonymous parameters.
* Returns: {Object}
* `changes` {number|bigint} The number of rows modified, inserted, or deleted
Expand DownExpand Up@@ -1448,6 +1473,9 @@ class execute synchronously.
<!-- YAML
added: v24.9.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/65709
description: Bind `undefined` to `NULL`.
- version: v26.8.0
pr-url: https://github.com/nodejs/node/pull/62001
description: Add support for boolean values in bound parameters.
Expand All@@ -1458,7 +1486,8 @@ changes:

* `stringElements` {string\[]} Template literal elements containing the SQL
query.
* `...boundParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...boundParameters`
{undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
Parameter values to be bound to placeholders in the template string.
* Returns: {Array} An array of objects representing the rows returned by the query.

Expand All@@ -1473,6 +1502,9 @@ called directly.
<!-- YAML
added: v24.9.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/65709
description: Bind `undefined` to `NULL`.
- version: v26.8.0
pr-url: https://github.com/nodejs/node/pull/62001
description: Add support for boolean values in bound parameters.
Expand All@@ -1483,7 +1515,8 @@ changes:

* `stringElements` {string\[]} Template literal elements containing the SQL
query.
* `...boundParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...boundParameters`
{undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
Parameter values to be bound to placeholders in the template string.
* Returns: {Object | undefined} An object representing the first row returned by
the query, or `undefined` if no rows are returned.
Expand All@@ -1498,6 +1531,9 @@ called directly.
<!-- YAML
added: v24.9.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/65709
description: Bind `undefined` to `NULL`.
- version: v26.8.0
pr-url: https://github.com/nodejs/node/pull/62001
description: Add support for boolean values in bound parameters.
Expand All@@ -1508,7 +1544,8 @@ changes:

* `stringElements` {string\[]} Template literal elements containing the SQL
query.
* `...boundParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...boundParameters`
{undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
Parameter values to be bound to placeholders in the template string.
* Returns: {Iterator} An iterator that yields objects representing the rows returned by the query.

Expand All@@ -1522,6 +1559,9 @@ called directly.
<!-- YAML
added: v24.9.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/65709
description: Bind `undefined` to `NULL`.
- version: v26.8.0
pr-url: https://github.com/nodejs/node/pull/62001
description: Add support for boolean values in bound parameters.
Expand All@@ -1532,7 +1572,8 @@ changes:

* `stringElements` {string\[]} Template literal elements containing the SQL
query.
* `...boundParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...boundParameters`
{undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
Parameter values to be bound to placeholders in the template string.
* Returns: {Object} An object containing information about the execution, including `changes` and `lastInsertRowid`.

Expand Down
5 changes: 3 additions & 2 deletions src/node_sqlite.cc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3101,7 +3101,8 @@ bool StatementSync::BindValue(const Local<Value>& value, const int index) {
// Dates could be supported by converting them to numbers. However, there
// would not be a good way to read the values back from SQLite with the
// original type. JS Boolean binds to 1 and 0 because SQLite maps true and
// false keywords to 1 and 0.
// false keywords to 1 and 0. JS undefined binds to NULL so that passing it
// explicitly matches omitting the parameter altogether.
Isolate* isolate = env()->isolate();
int r;
if (value->IsNumber()) {
Expand All@@ -3125,7 +3126,7 @@ bool StatementSync::BindValue(const Local<Value>& value, const int index) {
SQLITE_TRANSIENT,
SQLITE_UTF8);
}
} else if (value->IsNull()) {
} else if (value->IsNullOrUndefined()) {
r = sqlite3_bind_null(statement_.get(), index);
} else if (value->IsArrayBufferView() || value->IsArrayBuffer() ||
value->IsSharedArrayBuffer()) {
Expand Down
65 changes: 64 additions & 1 deletion test/parallel/test-sqlite-data-types.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -80,6 +80,70 @@ suite('data binding and mapping', () => {
query.get(5),
{ __proto__: null, key: 5, int: 1, double: 0, text: '1', buf: null }
);

t.assert.deepStrictEqual(
stmt.run(6, undefined, undefined, undefined, undefined),
{ changes: 1, lastInsertRowid: 6 }
);
t.assert.deepStrictEqual(
query.get(6),
{ __proto__: null, key: 6, int: null, double: null, text: null, buf: null }
);
});

test('undefined is bound as NULL', (t) => {
const db = new DatabaseSync(':memory:');
t.after(() => { db.close(); });
const setup = db.exec(
'CREATE TABLE types(key INTEGER PRIMARY KEY, val INTEGER) STRICT;'
);
t.assert.strictEqual(setup, undefined);
const stmt = db.prepare('INSERT INTO types (key, val) VALUES ($k, $v)');
const query = db.prepare('SELECT * FROM types WHERE key = ?');

// An explicit `undefined` and an omitted named parameter are equivalent.
t.assert.deepStrictEqual(
stmt.run({ k: 1, v: undefined }),
{ changes: 1, lastInsertRowid: 1 }
);
t.assert.deepStrictEqual(
stmt.run({ k: 2 }),
{ changes: 1, lastInsertRowid: 2 }
);
t.assert.deepStrictEqual(
query.get(1),
{ __proto__: null, key: 1, val: null }
);
t.assert.deepStrictEqual(
query.get(2),
{ __proto__: null, key: 2, val: null }
);

t.assert.deepStrictEqual(
db.prepare('SELECT ? AS a').get(undefined),
{ __proto__: null, a: null }
);
});

test('undefined is not treated as the named parameters argument', (t) => {
const db = new DatabaseSync(':memory:');
t.after(() => { db.close(); });

// `undefined` is not an object, so it is bound as an anonymous parameter
// rather than being treated as the named parameters argument.
t.assert.throws(() => {
db.prepare('SELECT $k AS a').get(undefined);
}, {
code: 'ERR_SQLITE_ERROR',
message: /column index out of range/,
});

t.assert.throws(() => {
db.prepare('SELECT ? AS a').get(1, undefined);
}, {
code: 'ERR_SQLITE_ERROR',
message: /column index out of range/,
});
});

test('large strings are bound correctly', (t) => {
Expand DownExpand Up@@ -126,7 +190,6 @@ suite('data binding and mapping', () => {
t.assert.strictEqual(setup, undefined);

[
undefined,
() => {},
Symbol(),
/foo/,
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
sqlite: bind undefined to NULL#65709

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

TrevorBurnham
wants to merge
1
commit into

base:main
Choose a base branch

from


+117

−12

 Open


sqlite: bind undefined to NULL
#65709
Show file tree
Hide file tree
 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


59 changes: 50 additions & 9 deletions
doc/api/sqlite.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -101,7 +101,7 @@ exception.

| Storage class | JavaScript to SQLite | SQLite to JavaScript |
| ------------- | --------------------------------------------------------------- | ------------------------------------- |
| `NULL` | {null}  | {null} |
| `NULL` | {null} or {undefined} | {null} |
| `INTEGER` | {number}, {bigint}, or {boolean} | {number} or {bigint} _(configurable)_ |
| `REAL` | {number} | {number} |
| `TEXT` | {string} | {string} |
Expand All@@ -113,6 +113,10 @@ values (`1n` and `0n`) when reading BigInts is enabled. Writing a {bigint} that
does not fit in a signed 64-bit integer throws an `ERR_INVALID_ARG_VALUE`
error.

`undefined` is written as `NULL`, so passing it explicitly is equivalent to
omitting a named parameter. `NULL` always reads back as {null}, never
`undefined`.

APIs that read values from SQLite have a configuration option that determines
whether `INTEGER` values are converted to `number` or `bigint` in JavaScript,
such as the `readBigInts` option for statements and the `useBigIntArguments`
Expand DownExpand Up@@ -1089,6 +1093,11 @@ Binding a key that does not name a parameter of the statement throws an
`ERR_INVALID_STATE` error unless unknown named parameters are ignored. See
[`statement.setAllowUnknownNamedParameters()`][].

Parameters that are never bound are `NULL`, and binding `undefined` has the same
effect, so `{ $a: undefined }` and `{}` are equivalent. Because `undefined` is
not an object, passing it in place of `namedParameters` binds it as an anonymous
parameter instead.

See [Type conversion between JavaScript and SQLite][] for the values that can be
bound. Binding any other value throws an `ERR_INVALID_ARG_TYPE` error.

Expand All@@ -1097,6 +1106,9 @@ bound. Binding any other value throws an `ERR_INVALID_ARG_TYPE` error.
<!-- YAML
added: v22.5.0
changes:
 - version: REPLACEME
 pr-url: https://github.com/nodejs/node/pull/65709
 description: Bind `undefined` to `NULL`.
 - version: v26.8.0
 pr-url: https://github.com/nodejs/node/pull/62001
 description: Add support for boolean values in bound parameters.
Expand All@@ -1112,7 +1124,8 @@ changes:

* `namedParameters` {Object} An optional object used to bind named parameters.
 The keys of this object are used to configure the mapping.
* `...anonymousParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...anonymousParameters`
 {undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
 Zero or more values to bind to anonymous parameters.
* Returns: {Array} An array of objects. Each object corresponds to a row
 returned by executing the prepared statement. The keys and values of each
Expand DownExpand Up@@ -1185,6 +1198,9 @@ execution of this prepared statement. This property is a wrapper around
<!-- YAML
added: v22.5.0
changes:
 - version: REPLACEME
 pr-url: https://github.com/nodejs/node/pull/65709
 description: Bind `undefined` to `NULL`.
 - version: v26.8.0
 pr-url: https://github.com/nodejs/node/pull/62001
 description: Add support for boolean values in bound parameters.
Expand All@@ -1200,7 +1216,8 @@ changes:

* `namedParameters` {Object} An optional object used to bind named parameters.
 The keys of this object are used to configure the mapping.
* `...anonymousParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...anonymousParameters`
 {undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
 Zero or more values to bind to anonymous parameters.
* Returns: {Object|undefined} An object corresponding to the first row returned
 by executing the prepared statement. The keys and values of the object
Expand All@@ -1220,6 +1237,9 @@ added:
 - v23.4.0
 - v22.13.0
changes:
 - version: REPLACEME
 pr-url: https://github.com/nodejs/node/pull/65709
 description: Bind `undefined` to `NULL`.
 - version: v26.8.0
 pr-url: https://github.com/nodejs/node/pull/62001
 description: Add support for boolean values in bound parameters.
Expand All@@ -1235,7 +1255,8 @@ changes:

* `namedParameters` {Object} An optional object used to bind named parameters.
 The keys of this object are used to configure the mapping.
* `...anonymousParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...anonymousParameters`
 {undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
 Zero or more values to bind to anonymous parameters.
* Returns: {Iterator} An iterable iterator of objects. Each object corresponds to a row
 returned by executing the prepared statement. The keys and values of each
Expand DownExpand Up@@ -1264,6 +1285,9 @@ executions of the same prepared statement.
<!-- YAML
added: v22.5.0
changes:
 - version: REPLACEME
 pr-url: https://github.com/nodejs/node/pull/65709
 description: Bind `undefined` to `NULL`.
 - version: v26.8.0
 pr-url: https://github.com/nodejs/node/pull/62001
 description: Add support for boolean values in bound parameters.
Expand All@@ -1279,7 +1303,8 @@ changes:

* `namedParameters` {Object} An optional object used to bind named parameters.
 The keys of this object are used to configure the mapping.
* `...anonymousParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...anonymousParameters`
 {undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
 Zero or more values to bind to anonymous parameters.
* Returns: {Object}
 * `changes` {number|bigint} The number of rows modified, inserted, or deleted
Expand DownExpand Up@@ -1448,6 +1473,9 @@ class execute synchronously.
<!-- YAML
added: v24.9.0
changes:
 - version: REPLACEME
 pr-url: https://github.com/nodejs/node/pull/65709
 description: Bind `undefined` to `NULL`.
 - version: v26.8.0
 pr-url: https://github.com/nodejs/node/pull/62001
 description: Add support for boolean values in bound parameters.
Expand All@@ -1458,7 +1486,8 @@ changes:

* `stringElements` {string\[]} Template literal elements containing the SQL
 query.
* `...boundParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...boundParameters`
 {undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
 Parameter values to be bound to placeholders in the template string.
* Returns: {Array} An array of objects representing the rows returned by the query.

Expand All@@ -1473,6 +1502,9 @@ called directly.
<!-- YAML
added: v24.9.0
changes:
 - version: REPLACEME
 pr-url: https://github.com/nodejs/node/pull/65709
 description: Bind `undefined` to `NULL`.
 - version: v26.8.0
 pr-url: https://github.com/nodejs/node/pull/62001
 description: Add support for boolean values in bound parameters.
Expand All@@ -1483,7 +1515,8 @@ changes:

* `stringElements` {string\[]} Template literal elements containing the SQL
 query.
* `...boundParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...boundParameters`
 {undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
 Parameter values to be bound to placeholders in the template string.
* Returns: {Object | undefined} An object representing the first row returned by
 the query, or `undefined` if no rows are returned.
Expand All@@ -1498,6 +1531,9 @@ called directly.
<!-- YAML
added: v24.9.0
changes:
 - version: REPLACEME
 pr-url: https://github.com/nodejs/node/pull/65709
 description: Bind `undefined` to `NULL`.
 - version: v26.8.0
 pr-url: https://github.com/nodejs/node/pull/62001
 description: Add support for boolean values in bound parameters.
Expand All@@ -1508,7 +1544,8 @@ changes:

* `stringElements` {string\[]} Template literal elements containing the SQL
 query.
* `...boundParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...boundParameters`
 {undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
 Parameter values to be bound to placeholders in the template string.
* Returns: {Iterator} An iterator that yields objects representing the rows returned by the query.

Expand All@@ -1522,6 +1559,9 @@ called directly.
<!-- YAML
added: v24.9.0
changes:
 - version: REPLACEME
 pr-url: https://github.com/nodejs/node/pull/65709
 description: Bind `undefined` to `NULL`.
 - version: v26.8.0
 pr-url: https://github.com/nodejs/node/pull/62001
 description: Add support for boolean values in bound parameters.
Expand All@@ -1532,7 +1572,8 @@ changes:

* `stringElements` {string\[]} Template literal elements containing the SQL
 query.
* `...boundParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...boundParameters`
 {undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
 Parameter values to be bound to placeholders in the template string.
* Returns: {Object} An object containing information about the execution, including `changes` and `lastInsertRowid`.

Expand Down

5 changes: 3 additions & 2 deletions
src/node_sqlite.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3101,7 +3101,8 @@ bool StatementSync::BindValue(const Local<Value>& value, const int index) {
 // Dates could be supported by converting them to numbers. However, there
 // would not be a good way to read the values back from SQLite with the
 // original type. JS Boolean binds to 1 and 0 because SQLite maps true and
 // false keywords to 1 and 0.
 // false keywords to 1 and 0. JS undefined binds to NULL so that passing it
 // explicitly matches omitting the parameter altogether.
 Isolate* isolate = env()->isolate();
 int r;
 if (value->IsNumber()) {
Expand All@@ -3125,7 +3126,7 @@ bool StatementSync::BindValue(const Local<Value>& value, const int index) {
 SQLITE_TRANSIENT,
 SQLITE_UTF8);
 }
 } else if (value->IsNull()) {
 } else if (value->IsNullOrUndefined()) {
 r = sqlite3_bind_null(statement_.get(), index);
 } else if (value->IsArrayBufferView() || value->IsArrayBuffer() ||
 value->IsSharedArrayBuffer()) {
Expand Down

65 changes: 64 additions & 1 deletion
test/parallel/test-sqlite-data-types.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -80,6 +80,70 @@ suite('data binding and mapping', () => {
 query.get(5),
 { __proto__: null, key: 5, int: 1, double: 0, text: '1', buf: null }
 );

 t.assert.deepStrictEqual(
 stmt.run(6, undefined, undefined, undefined, undefined),
 { changes: 1, lastInsertRowid: 6 }
 );
 t.assert.deepStrictEqual(
 query.get(6),
 { __proto__: null, key: 6, int: null, double: null, text: null, buf: null }
 );
 });

 test('undefined is bound as NULL', (t) => {
 const db = new DatabaseSync(':memory:');
 t.after(() => { db.close(); });
 const setup = db.exec(
 'CREATE TABLE types(key INTEGER PRIMARY KEY, val INTEGER) STRICT;'
 );
 t.assert.strictEqual(setup, undefined);
 const stmt = db.prepare('INSERT INTO types (key, val) VALUES ($k, $v)');
 const query = db.prepare('SELECT * FROM types WHERE key = ?');

 // An explicit `undefined` and an omitted named parameter are equivalent.
 t.assert.deepStrictEqual(
 stmt.run({ k: 1, v: undefined }),
 { changes: 1, lastInsertRowid: 1 }
 );
 t.assert.deepStrictEqual(
 stmt.run({ k: 2 }),
 { changes: 1, lastInsertRowid: 2 }
 );
 t.assert.deepStrictEqual(
 query.get(1),
 { __proto__: null, key: 1, val: null }
 );
 t.assert.deepStrictEqual(
 query.get(2),
 { __proto__: null, key: 2, val: null }
 );

 t.assert.deepStrictEqual(
 db.prepare('SELECT ? AS a').get(undefined),
 { __proto__: null, a: null }
 );
 });

 test('undefined is not treated as the named parameters argument', (t) => {
 const db = new DatabaseSync(':memory:');
 t.after(() => { db.close(); });

 // `undefined` is not an object, so it is bound as an anonymous parameter
 // rather than being treated as the named parameters argument.
 t.assert.throws(() => {
 db.prepare('SELECT $k AS a').get(undefined);
 }, {
 code: 'ERR_SQLITE_ERROR',
 message: /column index out of range/,
 });

 t.assert.throws(() => {
 db.prepare('SELECT ? AS a').get(1, undefined);
 }, {
 code: 'ERR_SQLITE_ERROR',
 message: /column index out of range/,
 });
 });

 test('large strings are bound correctly', (t) => {
Expand DownExpand Up@@ -126,7 +190,6 @@ suite('data binding and mapping', () => {
 t.assert.strictEqual(setup, undefined);

 [
 undefined,
 () => {},
 Symbol(),
 /foo/,
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
sqlite: bind undefined to NULL#65709

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

TrevorBurnham
wants to merge
1
commit into

base:main
Choose a base branch

from


+117

−12

 Open


sqlite: bind undefined to NULL
#65709
Show file tree
Hide file tree
 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


59 changes: 50 additions & 9 deletions
doc/api/sqlite.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -101,7 +101,7 @@ exception.

| Storage class | JavaScript to SQLite | SQLite to JavaScript |
| ------------- | --------------------------------------------------------------- | ------------------------------------- |
| `NULL` | {null}  | {null} |
| `NULL` | {null} or {undefined} | {null} |
| `INTEGER` | {number}, {bigint}, or {boolean} | {number} or {bigint} _(configurable)_ |
| `REAL` | {number} | {number} |
| `TEXT` | {string} | {string} |
Expand All@@ -113,6 +113,10 @@ values (`1n` and `0n`) when reading BigInts is enabled. Writing a {bigint} that
does not fit in a signed 64-bit integer throws an `ERR_INVALID_ARG_VALUE`
error.

`undefined` is written as `NULL`, so passing it explicitly is equivalent to
omitting a named parameter. `NULL` always reads back as {null}, never
`undefined`.

APIs that read values from SQLite have a configuration option that determines
whether `INTEGER` values are converted to `number` or `bigint` in JavaScript,
such as the `readBigInts` option for statements and the `useBigIntArguments`
Expand DownExpand Up@@ -1089,6 +1093,11 @@ Binding a key that does not name a parameter of the statement throws an
`ERR_INVALID_STATE` error unless unknown named parameters are ignored. See
[`statement.setAllowUnknownNamedParameters()`][].

Parameters that are never bound are `NULL`, and binding `undefined` has the same
effect, so `{ $a: undefined }` and `{}` are equivalent. Because `undefined` is
not an object, passing it in place of `namedParameters` binds it as an anonymous
parameter instead.

See [Type conversion between JavaScript and SQLite][] for the values that can be
bound. Binding any other value throws an `ERR_INVALID_ARG_TYPE` error.

Expand All@@ -1097,6 +1106,9 @@ bound. Binding any other value throws an `ERR_INVALID_ARG_TYPE` error.
<!-- YAML
added: v22.5.0
changes:
 - version: REPLACEME
 pr-url: https://github.com/nodejs/node/pull/65709
 description: Bind `undefined` to `NULL`.
 - version: v26.8.0
 pr-url: https://github.com/nodejs/node/pull/62001
 description: Add support for boolean values in bound parameters.
Expand All@@ -1112,7 +1124,8 @@ changes:

* `namedParameters` {Object} An optional object used to bind named parameters.
 The keys of this object are used to configure the mapping.
* `...anonymousParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...anonymousParameters`
 {undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
 Zero or more values to bind to anonymous parameters.
* Returns: {Array} An array of objects. Each object corresponds to a row
 returned by executing the prepared statement. The keys and values of each
Expand DownExpand Up@@ -1185,6 +1198,9 @@ execution of this prepared statement. This property is a wrapper around
<!-- YAML
added: v22.5.0
changes:
 - version: REPLACEME
 pr-url: https://github.com/nodejs/node/pull/65709
 description: Bind `undefined` to `NULL`.
 - version: v26.8.0
 pr-url: https://github.com/nodejs/node/pull/62001
 description: Add support for boolean values in bound parameters.
Expand All@@ -1200,7 +1216,8 @@ changes:

* `namedParameters` {Object} An optional object used to bind named parameters.
 The keys of this object are used to configure the mapping.
* `...anonymousParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...anonymousParameters`
 {undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
 Zero or more values to bind to anonymous parameters.
* Returns: {Object|undefined} An object corresponding to the first row returned
 by executing the prepared statement. The keys and values of the object
Expand All@@ -1220,6 +1237,9 @@ added:
 - v23.4.0
 - v22.13.0
changes:
 - version: REPLACEME
 pr-url: https://github.com/nodejs/node/pull/65709
 description: Bind `undefined` to `NULL`.
 - version: v26.8.0
 pr-url: https://github.com/nodejs/node/pull/62001
 description: Add support for boolean values in bound parameters.
Expand All@@ -1235,7 +1255,8 @@ changes:

* `namedParameters` {Object} An optional object used to bind named parameters.
 The keys of this object are used to configure the mapping.
* `...anonymousParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...anonymousParameters`
 {undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
 Zero or more values to bind to anonymous parameters.
* Returns: {Iterator} An iterable iterator of objects. Each object corresponds to a row
 returned by executing the prepared statement. The keys and values of each
Expand DownExpand Up@@ -1264,6 +1285,9 @@ executions of the same prepared statement.
<!-- YAML
added: v22.5.0
changes:
 - version: REPLACEME
 pr-url: https://github.com/nodejs/node/pull/65709
 description: Bind `undefined` to `NULL`.
 - version: v26.8.0
 pr-url: https://github.com/nodejs/node/pull/62001
 description: Add support for boolean values in bound parameters.
Expand All@@ -1279,7 +1303,8 @@ changes:

* `namedParameters` {Object} An optional object used to bind named parameters.
 The keys of this object are used to configure the mapping.
* `...anonymousParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...anonymousParameters`
 {undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
 Zero or more values to bind to anonymous parameters.
* Returns: {Object}
 * `changes` {number|bigint} The number of rows modified, inserted, or deleted
Expand DownExpand Up@@ -1448,6 +1473,9 @@ class execute synchronously.
<!-- YAML
added: v24.9.0
changes:
 - version: REPLACEME
 pr-url: https://github.com/nodejs/node/pull/65709
 description: Bind `undefined` to `NULL`.
 - version: v26.8.0
 pr-url: https://github.com/nodejs/node/pull/62001
 description: Add support for boolean values in bound parameters.
Expand All@@ -1458,7 +1486,8 @@ changes:

* `stringElements` {string\[]} Template literal elements containing the SQL
 query.
* `...boundParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...boundParameters`
 {undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
 Parameter values to be bound to placeholders in the template string.
* Returns: {Array} An array of objects representing the rows returned by the query.

Expand All@@ -1473,6 +1502,9 @@ called directly.
<!-- YAML
added: v24.9.0
changes:
 - version: REPLACEME
 pr-url: https://github.com/nodejs/node/pull/65709
 description: Bind `undefined` to `NULL`.
 - version: v26.8.0
 pr-url: https://github.com/nodejs/node/pull/62001
 description: Add support for boolean values in bound parameters.
Expand All@@ -1483,7 +1515,8 @@ changes:

* `stringElements` {string\[]} Template literal elements containing the SQL
 query.
* `...boundParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...boundParameters`
 {undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
 Parameter values to be bound to placeholders in the template string.
* Returns: {Object | undefined} An object representing the first row returned by
 the query, or `undefined` if no rows are returned.
Expand All@@ -1498,6 +1531,9 @@ called directly.
<!-- YAML
added: v24.9.0
changes:
 - version: REPLACEME
 pr-url: https://github.com/nodejs/node/pull/65709
 description: Bind `undefined` to `NULL`.
 - version: v26.8.0
 pr-url: https://github.com/nodejs/node/pull/62001
 description: Add support for boolean values in bound parameters.
Expand All@@ -1508,7 +1544,8 @@ changes:

* `stringElements` {string\[]} Template literal elements containing the SQL
 query.
* `...boundParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...boundParameters`
 {undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
 Parameter values to be bound to placeholders in the template string.
* Returns: {Iterator} An iterator that yields objects representing the rows returned by the query.

Expand All@@ -1522,6 +1559,9 @@ called directly.
<!-- YAML
added: v24.9.0
changes:
 - version: REPLACEME
 pr-url: https://github.com/nodejs/node/pull/65709
 description: Bind `undefined` to `NULL`.
 - version: v26.8.0
 pr-url: https://github.com/nodejs/node/pull/62001
 description: Add support for boolean values in bound parameters.
Expand All@@ -1532,7 +1572,8 @@ changes:

* `stringElements` {string\[]} Template literal elements containing the SQL
 query.
* `...boundParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...boundParameters`
 {undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
 Parameter values to be bound to placeholders in the template string.
* Returns: {Object} An object containing information about the execution, including `changes` and `lastInsertRowid`.

Expand Down

5 changes: 3 additions & 2 deletions
src/node_sqlite.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3101,7 +3101,8 @@ bool StatementSync::BindValue(const Local<Value>& value, const int index) {
 // Dates could be supported by converting them to numbers. However, there
 // would not be a good way to read the values back from SQLite with the
 // original type. JS Boolean binds to 1 and 0 because SQLite maps true and
 // false keywords to 1 and 0.
 // false keywords to 1 and 0. JS undefined binds to NULL so that passing it
 // explicitly matches omitting the parameter altogether.
 Isolate* isolate = env()->isolate();
 int r;
 if (value->IsNumber()) {
Expand All@@ -3125,7 +3126,7 @@ bool StatementSync::BindValue(const Local<Value>& value, const int index) {
 SQLITE_TRANSIENT,
 SQLITE_UTF8);
 }
 } else if (value->IsNull()) {
 } else if (value->IsNullOrUndefined()) {
 r = sqlite3_bind_null(statement_.get(), index);
 } else if (value->IsArrayBufferView() || value->IsArrayBuffer() ||
 value->IsSharedArrayBuffer()) {
Expand Down

65 changes: 64 additions & 1 deletion
test/parallel/test-sqlite-data-types.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -80,6 +80,70 @@ suite('data binding and mapping', () => {
 query.get(5),
 { __proto__: null, key: 5, int: 1, double: 0, text: '1', buf: null }
 );

 t.assert.deepStrictEqual(
 stmt.run(6, undefined, undefined, undefined, undefined),
 { changes: 1, lastInsertRowid: 6 }
 );
 t.assert.deepStrictEqual(
 query.get(6),
 { __proto__: null, key: 6, int: null, double: null, text: null, buf: null }
 );
 });

 test('undefined is bound as NULL', (t) => {
 const db = new DatabaseSync(':memory:');
 t.after(() => { db.close(); });
 const setup = db.exec(
 'CREATE TABLE types(key INTEGER PRIMARY KEY, val INTEGER) STRICT;'
 );
 t.assert.strictEqual(setup, undefined);
 const stmt = db.prepare('INSERT INTO types (key, val) VALUES ($k, $v)');
 const query = db.prepare('SELECT * FROM types WHERE key = ?');

 // An explicit `undefined` and an omitted named parameter are equivalent.
 t.assert.deepStrictEqual(
 stmt.run({ k: 1, v: undefined }),
 { changes: 1, lastInsertRowid: 1 }
 );
 t.assert.deepStrictEqual(
 stmt.run({ k: 2 }),
 { changes: 1, lastInsertRowid: 2 }
 );
 t.assert.deepStrictEqual(
 query.get(1),
 { __proto__: null, key: 1, val: null }
 );
 t.assert.deepStrictEqual(
 query.get(2),
 { __proto__: null, key: 2, val: null }
 );

 t.assert.deepStrictEqual(
 db.prepare('SELECT ? AS a').get(undefined),
 { __proto__: null, a: null }
 );
 });

 test('undefined is not treated as the named parameters argument', (t) => {
 const db = new DatabaseSync(':memory:');
 t.after(() => { db.close(); });

 // `undefined` is not an object, so it is bound as an anonymous parameter
 // rather than being treated as the named parameters argument.
 t.assert.throws(() => {
 db.prepare('SELECT $k AS a').get(undefined);
 }, {
 code: 'ERR_SQLITE_ERROR',
 message: /column index out of range/,
 });

 t.assert.throws(() => {
 db.prepare('SELECT ? AS a').get(1, undefined);
 }, {
 code: 'ERR_SQLITE_ERROR',
 message: /column index out of range/,
 });
 });

 test('large strings are bound correctly', (t) => {
Expand DownExpand Up@@ -126,7 +190,6 @@ suite('data binding and mapping', () => {
 t.assert.strictEqual(setup, undefined);

 [
 undefined,
 () => {},
 Symbol(),
 /foo/,
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
sqlite: bind undefined to NULL#65709

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

TrevorBurnham
wants to merge
1
commit into

base:main
Choose a base branch

from


+117

−12

 Open


sqlite: bind undefined to NULL
#65709
Show file tree
Hide file tree
 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


59 changes: 50 additions & 9 deletions
doc/api/sqlite.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -101,7 +101,7 @@ exception.

| Storage class | JavaScript to SQLite | SQLite to JavaScript |
| ------------- | --------------------------------------------------------------- | ------------------------------------- |
| `NULL` | {null}  | {null} |
| `NULL` | {null} or {undefined} | {null} |
| `INTEGER` | {number}, {bigint}, or {boolean} | {number} or {bigint} _(configurable)_ |
| `REAL` | {number} | {number} |
| `TEXT` | {string} | {string} |
Expand All@@ -113,6 +113,10 @@ values (`1n` and `0n`) when reading BigInts is enabled. Writing a {bigint} that
does not fit in a signed 64-bit integer throws an `ERR_INVALID_ARG_VALUE`
error.

`undefined` is written as `NULL`, so passing it explicitly is equivalent to
omitting a named parameter. `NULL` always reads back as {null}, never
`undefined`.

APIs that read values from SQLite have a configuration option that determines
whether `INTEGER` values are converted to `number` or `bigint` in JavaScript,
such as the `readBigInts` option for statements and the `useBigIntArguments`
Expand DownExpand Up@@ -1089,6 +1093,11 @@ Binding a key that does not name a parameter of the statement throws an
`ERR_INVALID_STATE` error unless unknown named parameters are ignored. See
[`statement.setAllowUnknownNamedParameters()`][].

Parameters that are never bound are `NULL`, and binding `undefined` has the same
effect, so `{ $a: undefined }` and `{}` are equivalent. Because `undefined` is
not an object, passing it in place of `namedParameters` binds it as an anonymous
parameter instead.

See [Type conversion between JavaScript and SQLite][] for the values that can be
bound. Binding any other value throws an `ERR_INVALID_ARG_TYPE` error.

Expand All@@ -1097,6 +1106,9 @@ bound. Binding any other value throws an `ERR_INVALID_ARG_TYPE` error.
<!-- YAML
added: v22.5.0
changes:
 - version: REPLACEME
 pr-url: https://github.com/nodejs/node/pull/65709
 description: Bind `undefined` to `NULL`.
 - version: v26.8.0
 pr-url: https://github.com/nodejs/node/pull/62001
 description: Add support for boolean values in bound parameters.
Expand All@@ -1112,7 +1124,8 @@ changes:

* `namedParameters` {Object} An optional object used to bind named parameters.
 The keys of this object are used to configure the mapping.
* `...anonymousParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...anonymousParameters`
 {undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
 Zero or more values to bind to anonymous parameters.
* Returns: {Array} An array of objects. Each object corresponds to a row
 returned by executing the prepared statement. The keys and values of each
Expand DownExpand Up@@ -1185,6 +1198,9 @@ execution of this prepared statement. This property is a wrapper around
<!-- YAML
added: v22.5.0
changes:
 - version: REPLACEME
 pr-url: https://github.com/nodejs/node/pull/65709
 description: Bind `undefined` to `NULL`.
 - version: v26.8.0
 pr-url: https://github.com/nodejs/node/pull/62001
 description: Add support for boolean values in bound parameters.
Expand All@@ -1200,7 +1216,8 @@ changes:

* `namedParameters` {Object} An optional object used to bind named parameters.
 The keys of this object are used to configure the mapping.
* `...anonymousParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...anonymousParameters`
 {undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
 Zero or more values to bind to anonymous parameters.
* Returns: {Object|undefined} An object corresponding to the first row returned
 by executing the prepared statement. The keys and values of the object
Expand All@@ -1220,6 +1237,9 @@ added:
 - v23.4.0
 - v22.13.0
changes:
 - version: REPLACEME
 pr-url: https://github.com/nodejs/node/pull/65709
 description: Bind `undefined` to `NULL`.
 - version: v26.8.0
 pr-url: https://github.com/nodejs/node/pull/62001
 description: Add support for boolean values in bound parameters.
Expand All@@ -1235,7 +1255,8 @@ changes:

* `namedParameters` {Object} An optional object used to bind named parameters.
 The keys of this object are used to configure the mapping.
* `...anonymousParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...anonymousParameters`
 {undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
 Zero or more values to bind to anonymous parameters.
* Returns: {Iterator} An iterable iterator of objects. Each object corresponds to a row
 returned by executing the prepared statement. The keys and values of each
Expand DownExpand Up@@ -1264,6 +1285,9 @@ executions of the same prepared statement.
<!-- YAML
added: v22.5.0
changes:
 - version: REPLACEME
 pr-url: https://github.com/nodejs/node/pull/65709
 description: Bind `undefined` to `NULL`.
 - version: v26.8.0
 pr-url: https://github.com/nodejs/node/pull/62001
 description: Add support for boolean values in bound parameters.
Expand All@@ -1279,7 +1303,8 @@ changes:

* `namedParameters` {Object} An optional object used to bind named parameters.
 The keys of this object are used to configure the mapping.
* `...anonymousParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...anonymousParameters`
 {undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
 Zero or more values to bind to anonymous parameters.
* Returns: {Object}
 * `changes` {number|bigint} The number of rows modified, inserted, or deleted
Expand DownExpand Up@@ -1448,6 +1473,9 @@ class execute synchronously.
<!-- YAML
added: v24.9.0
changes:
 - version: REPLACEME
 pr-url: https://github.com/nodejs/node/pull/65709
 description: Bind `undefined` to `NULL`.
 - version: v26.8.0
 pr-url: https://github.com/nodejs/node/pull/62001
 description: Add support for boolean values in bound parameters.
Expand All@@ -1458,7 +1486,8 @@ changes:

* `stringElements` {string\[]} Template literal elements containing the SQL
 query.
* `...boundParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...boundParameters`
 {undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
 Parameter values to be bound to placeholders in the template string.
* Returns: {Array} An array of objects representing the rows returned by the query.

Expand All@@ -1473,6 +1502,9 @@ called directly.
<!-- YAML
added: v24.9.0
changes:
 - version: REPLACEME
 pr-url: https://github.com/nodejs/node/pull/65709
 description: Bind `undefined` to `NULL`.
 - version: v26.8.0
 pr-url: https://github.com/nodejs/node/pull/62001
 description: Add support for boolean values in bound parameters.
Expand All@@ -1483,7 +1515,8 @@ changes:

* `stringElements` {string\[]} Template literal elements containing the SQL
 query.
* `...boundParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...boundParameters`
 {undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
 Parameter values to be bound to placeholders in the template string.
* Returns: {Object | undefined} An object representing the first row returned by
 the query, or `undefined` if no rows are returned.
Expand All@@ -1498,6 +1531,9 @@ called directly.
<!-- YAML
added: v24.9.0
changes:
 - version: REPLACEME
 pr-url: https://github.com/nodejs/node/pull/65709
 description: Bind `undefined` to `NULL`.
 - version: v26.8.0
 pr-url: https://github.com/nodejs/node/pull/62001
 description: Add support for boolean values in bound parameters.
Expand All@@ -1508,7 +1544,8 @@ changes:

* `stringElements` {string\[]} Template literal elements containing the SQL
 query.
* `...boundParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...boundParameters`
 {undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
 Parameter values to be bound to placeholders in the template string.
* Returns: {Iterator} An iterator that yields objects representing the rows returned by the query.

Expand All@@ -1522,6 +1559,9 @@ called directly.
<!-- YAML
added: v24.9.0
changes:
 - version: REPLACEME
 pr-url: https://github.com/nodejs/node/pull/65709
 description: Bind `undefined` to `NULL`.
 - version: v26.8.0
 pr-url: https://github.com/nodejs/node/pull/62001
 description: Add support for boolean values in bound parameters.
Expand All@@ -1532,7 +1572,8 @@ changes:

* `stringElements` {string\[]} Template literal elements containing the SQL
 query.
* `...boundParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...boundParameters`
 {undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
 Parameter values to be bound to placeholders in the template string.
* Returns: {Object} An object containing information about the execution, including `changes` and `lastInsertRowid`.

Expand Down

5 changes: 3 additions & 2 deletions
src/node_sqlite.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3101,7 +3101,8 @@ bool StatementSync::BindValue(const Local<Value>& value, const int index) {
 // Dates could be supported by converting them to numbers. However, there
 // would not be a good way to read the values back from SQLite with the
 // original type. JS Boolean binds to 1 and 0 because SQLite maps true and
 // false keywords to 1 and 0.
 // false keywords to 1 and 0. JS undefined binds to NULL so that passing it
 // explicitly matches omitting the parameter altogether.
 Isolate* isolate = env()->isolate();
 int r;
 if (value->IsNumber()) {
Expand All@@ -3125,7 +3126,7 @@ bool StatementSync::BindValue(const Local<Value>& value, const int index) {
 SQLITE_TRANSIENT,
 SQLITE_UTF8);
 }
 } else if (value->IsNull()) {
 } else if (value->IsNullOrUndefined()) {
 r = sqlite3_bind_null(statement_.get(), index);
 } else if (value->IsArrayBufferView() || value->IsArrayBuffer() ||
 value->IsSharedArrayBuffer()) {
Expand Down

65 changes: 64 additions & 1 deletion
test/parallel/test-sqlite-data-types.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -80,6 +80,70 @@ suite('data binding and mapping', () => {
 query.get(5),
 { __proto__: null, key: 5, int: 1, double: 0, text: '1', buf: null }
 );

 t.assert.deepStrictEqual(
 stmt.run(6, undefined, undefined, undefined, undefined),
 { changes: 1, lastInsertRowid: 6 }
 );
 t.assert.deepStrictEqual(
 query.get(6),
 { __proto__: null, key: 6, int: null, double: null, text: null, buf: null }
 );
 });

 test('undefined is bound as NULL', (t) => {
 const db = new DatabaseSync(':memory:');
 t.after(() => { db.close(); });
 const setup = db.exec(
 'CREATE TABLE types(key INTEGER PRIMARY KEY, val INTEGER) STRICT;'
 );
 t.assert.strictEqual(setup, undefined);
 const stmt = db.prepare('INSERT INTO types (key, val) VALUES ($k, $v)');
 const query = db.prepare('SELECT * FROM types WHERE key = ?');

 // An explicit `undefined` and an omitted named parameter are equivalent.
 t.assert.deepStrictEqual(
 stmt.run({ k: 1, v: undefined }),
 { changes: 1, lastInsertRowid: 1 }
 );
 t.assert.deepStrictEqual(
 stmt.run({ k: 2 }),
 { changes: 1, lastInsertRowid: 2 }
 );
 t.assert.deepStrictEqual(
 query.get(1),
 { __proto__: null, key: 1, val: null }
 );
 t.assert.deepStrictEqual(
 query.get(2),
 { __proto__: null, key: 2, val: null }
 );

 t.assert.deepStrictEqual(
 db.prepare('SELECT ? AS a').get(undefined),
 { __proto__: null, a: null }
 );
 });

 test('undefined is not treated as the named parameters argument', (t) => {
 const db = new DatabaseSync(':memory:');
 t.after(() => { db.close(); });

 // `undefined` is not an object, so it is bound as an anonymous parameter
 // rather than being treated as the named parameters argument.
 t.assert.throws(() => {
 db.prepare('SELECT $k AS a').get(undefined);
 }, {
 code: 'ERR_SQLITE_ERROR',
 message: /column index out of range/,
 });

 t.assert.throws(() => {
 db.prepare('SELECT ? AS a').get(1, undefined);
 }, {
 code: 'ERR_SQLITE_ERROR',
 message: /column index out of range/,
 });
 });

 test('large strings are bound correctly', (t) => {
Expand DownExpand Up@@ -126,7 +190,6 @@ suite('data binding and mapping', () => {
 t.assert.strictEqual(setup, undefined);

 [
 undefined,
 () => {},
 Symbol(),
 /foo/,
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
sqlite: bind undefined to NULL#65709

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

TrevorBurnham
wants to merge
1
commit into

base:main
Choose a base branch

from


+117

−12

 Open


sqlite: bind undefined to NULL
#65709
Show file tree
Hide file tree
 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


59 changes: 50 additions & 9 deletions
doc/api/sqlite.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -101,7 +101,7 @@ exception.

| Storage class | JavaScript to SQLite | SQLite to JavaScript |
| ------------- | --------------------------------------------------------------- | ------------------------------------- |
| `NULL` | {null}  | {null} |
| `NULL` | {null} or {undefined} | {null} |
| `INTEGER` | {number}, {bigint}, or {boolean} | {number} or {bigint} _(configurable)_ |
| `REAL` | {number} | {number} |
| `TEXT` | {string} | {string} |
Expand All@@ -113,6 +113,10 @@ values (`1n` and `0n`) when reading BigInts is enabled. Writing a {bigint} that
does not fit in a signed 64-bit integer throws an `ERR_INVALID_ARG_VALUE`
error.

`undefined` is written as `NULL`, so passing it explicitly is equivalent to
omitting a named parameter. `NULL` always reads back as {null}, never
`undefined`.

APIs that read values from SQLite have a configuration option that determines
whether `INTEGER` values are converted to `number` or `bigint` in JavaScript,
such as the `readBigInts` option for statements and the `useBigIntArguments`
Expand DownExpand Up@@ -1089,6 +1093,11 @@ Binding a key that does not name a parameter of the statement throws an
`ERR_INVALID_STATE` error unless unknown named parameters are ignored. See
[`statement.setAllowUnknownNamedParameters()`][].

Parameters that are never bound are `NULL`, and binding `undefined` has the same
effect, so `{ $a: undefined }` and `{}` are equivalent. Because `undefined` is
not an object, passing it in place of `namedParameters` binds it as an anonymous
parameter instead.

See [Type conversion between JavaScript and SQLite][] for the values that can be
bound. Binding any other value throws an `ERR_INVALID_ARG_TYPE` error.

Expand All@@ -1097,6 +1106,9 @@ bound. Binding any other value throws an `ERR_INVALID_ARG_TYPE` error.
<!-- YAML
added: v22.5.0
changes:
 - version: REPLACEME
 pr-url: https://github.com/nodejs/node/pull/65709
 description: Bind `undefined` to `NULL`.
 - version: v26.8.0
 pr-url: https://github.com/nodejs/node/pull/62001
 description: Add support for boolean values in bound parameters.
Expand All@@ -1112,7 +1124,8 @@ changes:

* `namedParameters` {Object} An optional object used to bind named parameters.
 The keys of this object are used to configure the mapping.
* `...anonymousParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...anonymousParameters`
 {undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
 Zero or more values to bind to anonymous parameters.
* Returns: {Array} An array of objects. Each object corresponds to a row
 returned by executing the prepared statement. The keys and values of each
Expand DownExpand Up@@ -1185,6 +1198,9 @@ execution of this prepared statement. This property is a wrapper around
<!-- YAML
added: v22.5.0
changes:
 - version: REPLACEME
 pr-url: https://github.com/nodejs/node/pull/65709
 description: Bind `undefined` to `NULL`.
 - version: v26.8.0
 pr-url: https://github.com/nodejs/node/pull/62001
 description: Add support for boolean values in bound parameters.
Expand All@@ -1200,7 +1216,8 @@ changes:

* `namedParameters` {Object} An optional object used to bind named parameters.
 The keys of this object are used to configure the mapping.
* `...anonymousParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...anonymousParameters`
 {undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
 Zero or more values to bind to anonymous parameters.
* Returns: {Object|undefined} An object corresponding to the first row returned
 by executing the prepared statement. The keys and values of the object
Expand All@@ -1220,6 +1237,9 @@ added:
 - v23.4.0
 - v22.13.0
changes:
 - version: REPLACEME
 pr-url: https://github.com/nodejs/node/pull/65709
 description: Bind `undefined` to `NULL`.
 - version: v26.8.0
 pr-url: https://github.com/nodejs/node/pull/62001
 description: Add support for boolean values in bound parameters.
Expand All@@ -1235,7 +1255,8 @@ changes:

* `namedParameters` {Object} An optional object used to bind named parameters.
 The keys of this object are used to configure the mapping.
* `...anonymousParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...anonymousParameters`
 {undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
 Zero or more values to bind to anonymous parameters.
* Returns: {Iterator} An iterable iterator of objects. Each object corresponds to a row
 returned by executing the prepared statement. The keys and values of each
Expand DownExpand Up@@ -1264,6 +1285,9 @@ executions of the same prepared statement.
<!-- YAML
added: v22.5.0
changes:
 - version: REPLACEME
 pr-url: https://github.com/nodejs/node/pull/65709
 description: Bind `undefined` to `NULL`.
 - version: v26.8.0
 pr-url: https://github.com/nodejs/node/pull/62001
 description: Add support for boolean values in bound parameters.
Expand All@@ -1279,7 +1303,8 @@ changes:

* `namedParameters` {Object} An optional object used to bind named parameters.
 The keys of this object are used to configure the mapping.
* `...anonymousParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...anonymousParameters`
 {undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
 Zero or more values to bind to anonymous parameters.
* Returns: {Object}
 * `changes` {number|bigint} The number of rows modified, inserted, or deleted
Expand DownExpand Up@@ -1448,6 +1473,9 @@ class execute synchronously.
<!-- YAML
added: v24.9.0
changes:
 - version: REPLACEME
 pr-url: https://github.com/nodejs/node/pull/65709
 description: Bind `undefined` to `NULL`.
 - version: v26.8.0
 pr-url: https://github.com/nodejs/node/pull/62001
 description: Add support for boolean values in bound parameters.
Expand All@@ -1458,7 +1486,8 @@ changes:

* `stringElements` {string\[]} Template literal elements containing the SQL
 query.
* `...boundParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...boundParameters`
 {undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
 Parameter values to be bound to placeholders in the template string.
* Returns: {Array} An array of objects representing the rows returned by the query.

Expand All@@ -1473,6 +1502,9 @@ called directly.
<!-- YAML
added: v24.9.0
changes:
 - version: REPLACEME
 pr-url: https://github.com/nodejs/node/pull/65709
 description: Bind `undefined` to `NULL`.
 - version: v26.8.0
 pr-url: https://github.com/nodejs/node/pull/62001
 description: Add support for boolean values in bound parameters.
Expand All@@ -1483,7 +1515,8 @@ changes:

* `stringElements` {string\[]} Template literal elements containing the SQL
 query.
* `...boundParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...boundParameters`
 {undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
 Parameter values to be bound to placeholders in the template string.
* Returns: {Object | undefined} An object representing the first row returned by
 the query, or `undefined` if no rows are returned.
Expand All@@ -1498,6 +1531,9 @@ called directly.
<!-- YAML
added: v24.9.0
changes:
 - version: REPLACEME
 pr-url: https://github.com/nodejs/node/pull/65709
 description: Bind `undefined` to `NULL`.
 - version: v26.8.0
 pr-url: https://github.com/nodejs/node/pull/62001
 description: Add support for boolean values in bound parameters.
Expand All@@ -1508,7 +1544,8 @@ changes:

* `stringElements` {string\[]} Template literal elements containing the SQL
 query.
* `...boundParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...boundParameters`
 {undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
 Parameter values to be bound to placeholders in the template string.
* Returns: {Iterator} An iterator that yields objects representing the rows returned by the query.

Expand All@@ -1522,6 +1559,9 @@ called directly.
<!-- YAML
added: v24.9.0
changes:
 - version: REPLACEME
 pr-url: https://github.com/nodejs/node/pull/65709
 description: Bind `undefined` to `NULL`.
 - version: v26.8.0
 pr-url: https://github.com/nodejs/node/pull/62001
 description: Add support for boolean values in bound parameters.
Expand All@@ -1532,7 +1572,8 @@ changes:

* `stringElements` {string\[]} Template literal elements containing the SQL
 query.
* `...boundParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...boundParameters`
 {undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
 Parameter values to be bound to placeholders in the template string.
* Returns: {Object} An object containing information about the execution, including `changes` and `lastInsertRowid`.

Expand Down

5 changes: 3 additions & 2 deletions
src/node_sqlite.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3101,7 +3101,8 @@ bool StatementSync::BindValue(const Local<Value>& value, const int index) {
 // Dates could be supported by converting them to numbers. However, there
 // would not be a good way to read the values back from SQLite with the
 // original type. JS Boolean binds to 1 and 0 because SQLite maps true and
 // false keywords to 1 and 0.
 // false keywords to 1 and 0. JS undefined binds to NULL so that passing it
 // explicitly matches omitting the parameter altogether.
 Isolate* isolate = env()->isolate();
 int r;
 if (value->IsNumber()) {
Expand All@@ -3125,7 +3126,7 @@ bool StatementSync::BindValue(const Local<Value>& value, const int index) {
 SQLITE_TRANSIENT,
 SQLITE_UTF8);
 }
 } else if (value->IsNull()) {
 } else if (value->IsNullOrUndefined()) {
 r = sqlite3_bind_null(statement_.get(), index);
 } else if (value->IsArrayBufferView() || value->IsArrayBuffer() ||
 value->IsSharedArrayBuffer()) {
Expand Down

65 changes: 64 additions & 1 deletion
test/parallel/test-sqlite-data-types.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -80,6 +80,70 @@ suite('data binding and mapping', () => {
 query.get(5),
 { __proto__: null, key: 5, int: 1, double: 0, text: '1', buf: null }
 );

 t.assert.deepStrictEqual(
 stmt.run(6, undefined, undefined, undefined, undefined),
 { changes: 1, lastInsertRowid: 6 }
 );
 t.assert.deepStrictEqual(
 query.get(6),
 { __proto__: null, key: 6, int: null, double: null, text: null, buf: null }
 );
 });

 test('undefined is bound as NULL', (t) => {
 const db = new DatabaseSync(':memory:');
 t.after(() => { db.close(); });
 const setup = db.exec(
 'CREATE TABLE types(key INTEGER PRIMARY KEY, val INTEGER) STRICT;'
 );
 t.assert.strictEqual(setup, undefined);
 const stmt = db.prepare('INSERT INTO types (key, val) VALUES ($k, $v)');
 const query = db.prepare('SELECT * FROM types WHERE key = ?');

 // An explicit `undefined` and an omitted named parameter are equivalent.
 t.assert.deepStrictEqual(
 stmt.run({ k: 1, v: undefined }),
 { changes: 1, lastInsertRowid: 1 }
 );
 t.assert.deepStrictEqual(
 stmt.run({ k: 2 }),
 { changes: 1, lastInsertRowid: 2 }
 );
 t.assert.deepStrictEqual(
 query.get(1),
 { __proto__: null, key: 1, val: null }
 );
 t.assert.deepStrictEqual(
 query.get(2),
 { __proto__: null, key: 2, val: null }
 );

 t.assert.deepStrictEqual(
 db.prepare('SELECT ? AS a').get(undefined),
 { __proto__: null, a: null }
 );
 });

 test('undefined is not treated as the named parameters argument', (t) => {
 const db = new DatabaseSync(':memory:');
 t.after(() => { db.close(); });

 // `undefined` is not an object, so it is bound as an anonymous parameter
 // rather than being treated as the named parameters argument.
 t.assert.throws(() => {
 db.prepare('SELECT $k AS a').get(undefined);
 }, {
 code: 'ERR_SQLITE_ERROR',
 message: /column index out of range/,
 });

 t.assert.throws(() => {
 db.prepare('SELECT ? AS a').get(1, undefined);
 }, {
 code: 'ERR_SQLITE_ERROR',
 message: /column index out of range/,
 });
 });

 test('large strings are bound correctly', (t) => {
Expand DownExpand Up@@ -126,7 +190,6 @@ suite('data binding and mapping', () => {
 t.assert.strictEqual(setup, undefined);

 [
 undefined,
 () => {},
 Symbol(),
 /foo/,
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
sqlite: bind undefined to NULL#65709

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

TrevorBurnham
wants to merge
1
commit into

base:main
Choose a base branch

from


+117

−12

 Open


sqlite: bind undefined to NULL
#65709
Show file tree
Hide file tree
 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


59 changes: 50 additions & 9 deletions
doc/api/sqlite.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -101,7 +101,7 @@ exception.

| Storage class | JavaScript to SQLite | SQLite to JavaScript |
| ------------- | --------------------------------------------------------------- | ------------------------------------- |
| `NULL` | {null}  | {null} |
| `NULL` | {null} or {undefined} | {null} |
| `INTEGER` | {number}, {bigint}, or {boolean} | {number} or {bigint} _(configurable)_ |
| `REAL` | {number} | {number} |
| `TEXT` | {string} | {string} |
Expand All@@ -113,6 +113,10 @@ values (`1n` and `0n`) when reading BigInts is enabled. Writing a {bigint} that
does not fit in a signed 64-bit integer throws an `ERR_INVALID_ARG_VALUE`
error.

`undefined` is written as `NULL`, so passing it explicitly is equivalent to
omitting a named parameter. `NULL` always reads back as {null}, never
`undefined`.

APIs that read values from SQLite have a configuration option that determines
whether `INTEGER` values are converted to `number` or `bigint` in JavaScript,
such as the `readBigInts` option for statements and the `useBigIntArguments`
Expand DownExpand Up@@ -1089,6 +1093,11 @@ Binding a key that does not name a parameter of the statement throws an
`ERR_INVALID_STATE` error unless unknown named parameters are ignored. See
[`statement.setAllowUnknownNamedParameters()`][].

Parameters that are never bound are `NULL`, and binding `undefined` has the same
effect, so `{ $a: undefined }` and `{}` are equivalent. Because `undefined` is
not an object, passing it in place of `namedParameters` binds it as an anonymous
parameter instead.

See [Type conversion between JavaScript and SQLite][] for the values that can be
bound. Binding any other value throws an `ERR_INVALID_ARG_TYPE` error.

Expand All@@ -1097,6 +1106,9 @@ bound. Binding any other value throws an `ERR_INVALID_ARG_TYPE` error.
<!-- YAML
added: v22.5.0
changes:
 - version: REPLACEME
 pr-url: https://github.com/nodejs/node/pull/65709
 description: Bind `undefined` to `NULL`.
 - version: v26.8.0
 pr-url: https://github.com/nodejs/node/pull/62001
 description: Add support for boolean values in bound parameters.
Expand All@@ -1112,7 +1124,8 @@ changes:

* `namedParameters` {Object} An optional object used to bind named parameters.
 The keys of this object are used to configure the mapping.
* `...anonymousParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...anonymousParameters`
 {undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
 Zero or more values to bind to anonymous parameters.
* Returns: {Array} An array of objects. Each object corresponds to a row
 returned by executing the prepared statement. The keys and values of each
Expand DownExpand Up@@ -1185,6 +1198,9 @@ execution of this prepared statement. This property is a wrapper around
<!-- YAML
added: v22.5.0
changes:
 - version: REPLACEME
 pr-url: https://github.com/nodejs/node/pull/65709
 description: Bind `undefined` to `NULL`.
 - version: v26.8.0
 pr-url: https://github.com/nodejs/node/pull/62001
 description: Add support for boolean values in bound parameters.
Expand All@@ -1200,7 +1216,8 @@ changes:

* `namedParameters` {Object} An optional object used to bind named parameters.
 The keys of this object are used to configure the mapping.
* `...anonymousParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...anonymousParameters`
 {undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
 Zero or more values to bind to anonymous parameters.
* Returns: {Object|undefined} An object corresponding to the first row returned
 by executing the prepared statement. The keys and values of the object
Expand All@@ -1220,6 +1237,9 @@ added:
 - v23.4.0
 - v22.13.0
changes:
 - version: REPLACEME
 pr-url: https://github.com/nodejs/node/pull/65709
 description: Bind `undefined` to `NULL`.
 - version: v26.8.0
 pr-url: https://github.com/nodejs/node/pull/62001
 description: Add support for boolean values in bound parameters.
Expand All@@ -1235,7 +1255,8 @@ changes:

* `namedParameters` {Object} An optional object used to bind named parameters.
 The keys of this object are used to configure the mapping.
* `...anonymousParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...anonymousParameters`
 {undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
 Zero or more values to bind to anonymous parameters.
* Returns: {Iterator} An iterable iterator of objects. Each object corresponds to a row
 returned by executing the prepared statement. The keys and values of each
Expand DownExpand Up@@ -1264,6 +1285,9 @@ executions of the same prepared statement.
<!-- YAML
added: v22.5.0
changes:
 - version: REPLACEME
 pr-url: https://github.com/nodejs/node/pull/65709
 description: Bind `undefined` to `NULL`.
 - version: v26.8.0
 pr-url: https://github.com/nodejs/node/pull/62001
 description: Add support for boolean values in bound parameters.
Expand All@@ -1279,7 +1303,8 @@ changes:

* `namedParameters` {Object} An optional object used to bind named parameters.
 The keys of this object are used to configure the mapping.
* `...anonymousParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...anonymousParameters`
 {undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
 Zero or more values to bind to anonymous parameters.
* Returns: {Object}
 * `changes` {number|bigint} The number of rows modified, inserted, or deleted
Expand DownExpand Up@@ -1448,6 +1473,9 @@ class execute synchronously.
<!-- YAML
added: v24.9.0
changes:
 - version: REPLACEME
 pr-url: https://github.com/nodejs/node/pull/65709
 description: Bind `undefined` to `NULL`.
 - version: v26.8.0
 pr-url: https://github.com/nodejs/node/pull/62001
 description: Add support for boolean values in bound parameters.
Expand All@@ -1458,7 +1486,8 @@ changes:

* `stringElements` {string\[]} Template literal elements containing the SQL
 query.
* `...boundParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...boundParameters`
 {undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
 Parameter values to be bound to placeholders in the template string.
* Returns: {Array} An array of objects representing the rows returned by the query.

Expand All@@ -1473,6 +1502,9 @@ called directly.
<!-- YAML
added: v24.9.0
changes:
 - version: REPLACEME
 pr-url: https://github.com/nodejs/node/pull/65709
 description: Bind `undefined` to `NULL`.
 - version: v26.8.0
 pr-url: https://github.com/nodejs/node/pull/62001
 description: Add support for boolean values in bound parameters.
Expand All@@ -1483,7 +1515,8 @@ changes:

* `stringElements` {string\[]} Template literal elements containing the SQL
 query.
* `...boundParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...boundParameters`
 {undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
 Parameter values to be bound to placeholders in the template string.
* Returns: {Object | undefined} An object representing the first row returned by
 the query, or `undefined` if no rows are returned.
Expand All@@ -1498,6 +1531,9 @@ called directly.
<!-- YAML
added: v24.9.0
changes:
 - version: REPLACEME
 pr-url: https://github.com/nodejs/node/pull/65709
 description: Bind `undefined` to `NULL`.
 - version: v26.8.0
 pr-url: https://github.com/nodejs/node/pull/62001
 description: Add support for boolean values in bound parameters.
Expand All@@ -1508,7 +1544,8 @@ changes:

* `stringElements` {string\[]} Template literal elements containing the SQL
 query.
* `...boundParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...boundParameters`
 {undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
 Parameter values to be bound to placeholders in the template string.
* Returns: {Iterator} An iterator that yields objects representing the rows returned by the query.

Expand All@@ -1522,6 +1559,9 @@ called directly.
<!-- YAML
added: v24.9.0
changes:
 - version: REPLACEME
 pr-url: https://github.com/nodejs/node/pull/65709
 description: Bind `undefined` to `NULL`.
 - version: v26.8.0
 pr-url: https://github.com/nodejs/node/pull/62001
 description: Add support for boolean values in bound parameters.
Expand All@@ -1532,7 +1572,8 @@ changes:

* `stringElements` {string\[]} Template literal elements containing the SQL
 query.
* `...boundParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...boundParameters`
 {undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
 Parameter values to be bound to placeholders in the template string.
* Returns: {Object} An object containing information about the execution, including `changes` and `lastInsertRowid`.

Expand Down

5 changes: 3 additions & 2 deletions
src/node_sqlite.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3101,7 +3101,8 @@ bool StatementSync::BindValue(const Local<Value>& value, const int index) {
 // Dates could be supported by converting them to numbers. However, there
 // would not be a good way to read the values back from SQLite with the
 // original type. JS Boolean binds to 1 and 0 because SQLite maps true and
 // false keywords to 1 and 0.
 // false keywords to 1 and 0. JS undefined binds to NULL so that passing it
 // explicitly matches omitting the parameter altogether.
 Isolate* isolate = env()->isolate();
 int r;
 if (value->IsNumber()) {
Expand All@@ -3125,7 +3126,7 @@ bool StatementSync::BindValue(const Local<Value>& value, const int index) {
 SQLITE_TRANSIENT,
 SQLITE_UTF8);
 }
 } else if (value->IsNull()) {
 } else if (value->IsNullOrUndefined()) {
 r = sqlite3_bind_null(statement_.get(), index);
 } else if (value->IsArrayBufferView() || value->IsArrayBuffer() ||
 value->IsSharedArrayBuffer()) {
Expand Down

65 changes: 64 additions & 1 deletion
test/parallel/test-sqlite-data-types.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -80,6 +80,70 @@ suite('data binding and mapping', () => {
 query.get(5),
 { __proto__: null, key: 5, int: 1, double: 0, text: '1', buf: null }
 );

 t.assert.deepStrictEqual(
 stmt.run(6, undefined, undefined, undefined, undefined),
 { changes: 1, lastInsertRowid: 6 }
 );
 t.assert.deepStrictEqual(
 query.get(6),
 { __proto__: null, key: 6, int: null, double: null, text: null, buf: null }
 );
 });

 test('undefined is bound as NULL', (t) => {
 const db = new DatabaseSync(':memory:');
 t.after(() => { db.close(); });
 const setup = db.exec(
 'CREATE TABLE types(key INTEGER PRIMARY KEY, val INTEGER) STRICT;'
 );
 t.assert.strictEqual(setup, undefined);
 const stmt = db.prepare('INSERT INTO types (key, val) VALUES ($k, $v)');
 const query = db.prepare('SELECT * FROM types WHERE key = ?');

 // An explicit `undefined` and an omitted named parameter are equivalent.
 t.assert.deepStrictEqual(
 stmt.run({ k: 1, v: undefined }),
 { changes: 1, lastInsertRowid: 1 }
 );
 t.assert.deepStrictEqual(
 stmt.run({ k: 2 }),
 { changes: 1, lastInsertRowid: 2 }
 );
 t.assert.deepStrictEqual(
 query.get(1),
 { __proto__: null, key: 1, val: null }
 );
 t.assert.deepStrictEqual(
 query.get(2),
 { __proto__: null, key: 2, val: null }
 );

 t.assert.deepStrictEqual(
 db.prepare('SELECT ? AS a').get(undefined),
 { __proto__: null, a: null }
 );
 });

 test('undefined is not treated as the named parameters argument', (t) => {
 const db = new DatabaseSync(':memory:');
 t.after(() => { db.close(); });

 // `undefined` is not an object, so it is bound as an anonymous parameter
 // rather than being treated as the named parameters argument.
 t.assert.throws(() => {
 db.prepare('SELECT $k AS a').get(undefined);
 }, {
 code: 'ERR_SQLITE_ERROR',
 message: /column index out of range/,
 });

 t.assert.throws(() => {
 db.prepare('SELECT ? AS a').get(1, undefined);
 }, {
 code: 'ERR_SQLITE_ERROR',
 message: /column index out of range/,
 });
 });

 test('large strings are bound correctly', (t) => {
Expand DownExpand Up@@ -126,7 +190,6 @@ suite('data binding and mapping', () => {
 t.assert.strictEqual(setup, undefined);

 [
 undefined,
 () => {},
 Symbol(),
 /foo/,
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
sqlite: bind undefined to NULL#65709

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

TrevorBurnham
wants to merge
1
commit into

base:main
Choose a base branch

from


+117

−12

 Open


sqlite: bind undefined to NULL
#65709
Show file tree
Hide file tree
 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


59 changes: 50 additions & 9 deletions
doc/api/sqlite.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -101,7 +101,7 @@ exception.

| Storage class | JavaScript to SQLite | SQLite to JavaScript |
| ------------- | --------------------------------------------------------------- | ------------------------------------- |
| `NULL` | {null}  | {null} |
| `NULL` | {null} or {undefined} | {null} |
| `INTEGER` | {number}, {bigint}, or {boolean} | {number} or {bigint} _(configurable)_ |
| `REAL` | {number} | {number} |
| `TEXT` | {string} | {string} |
Expand All@@ -113,6 +113,10 @@ values (`1n` and `0n`) when reading BigInts is enabled. Writing a {bigint} that
does not fit in a signed 64-bit integer throws an `ERR_INVALID_ARG_VALUE`
error.

`undefined` is written as `NULL`, so passing it explicitly is equivalent to
omitting a named parameter. `NULL` always reads back as {null}, never
`undefined`.

APIs that read values from SQLite have a configuration option that determines
whether `INTEGER` values are converted to `number` or `bigint` in JavaScript,
such as the `readBigInts` option for statements and the `useBigIntArguments`
Expand DownExpand Up@@ -1089,6 +1093,11 @@ Binding a key that does not name a parameter of the statement throws an
`ERR_INVALID_STATE` error unless unknown named parameters are ignored. See
[`statement.setAllowUnknownNamedParameters()`][].

Parameters that are never bound are `NULL`, and binding `undefined` has the same
effect, so `{ $a: undefined }` and `{}` are equivalent. Because `undefined` is
not an object, passing it in place of `namedParameters` binds it as an anonymous
parameter instead.

See [Type conversion between JavaScript and SQLite][] for the values that can be
bound. Binding any other value throws an `ERR_INVALID_ARG_TYPE` error.

Expand All@@ -1097,6 +1106,9 @@ bound. Binding any other value throws an `ERR_INVALID_ARG_TYPE` error.
<!-- YAML
added: v22.5.0
changes:
 - version: REPLACEME
 pr-url: https://github.com/nodejs/node/pull/65709
 description: Bind `undefined` to `NULL`.
 - version: v26.8.0
 pr-url: https://github.com/nodejs/node/pull/62001
 description: Add support for boolean values in bound parameters.
Expand All@@ -1112,7 +1124,8 @@ changes:

* `namedParameters` {Object} An optional object used to bind named parameters.
 The keys of this object are used to configure the mapping.
* `...anonymousParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...anonymousParameters`
 {undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
 Zero or more values to bind to anonymous parameters.
* Returns: {Array} An array of objects. Each object corresponds to a row
 returned by executing the prepared statement. The keys and values of each
Expand DownExpand Up@@ -1185,6 +1198,9 @@ execution of this prepared statement. This property is a wrapper around
<!-- YAML
added: v22.5.0
changes:
 - version: REPLACEME
 pr-url: https://github.com/nodejs/node/pull/65709
 description: Bind `undefined` to `NULL`.
 - version: v26.8.0
 pr-url: https://github.com/nodejs/node/pull/62001
 description: Add support for boolean values in bound parameters.
Expand All@@ -1200,7 +1216,8 @@ changes:

* `namedParameters` {Object} An optional object used to bind named parameters.
 The keys of this object are used to configure the mapping.
* `...anonymousParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...anonymousParameters`
 {undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
 Zero or more values to bind to anonymous parameters.
* Returns: {Object|undefined} An object corresponding to the first row returned
 by executing the prepared statement. The keys and values of the object
Expand All@@ -1220,6 +1237,9 @@ added:
 - v23.4.0
 - v22.13.0
changes:
 - version: REPLACEME
 pr-url: https://github.com/nodejs/node/pull/65709
 description: Bind `undefined` to `NULL`.
 - version: v26.8.0
 pr-url: https://github.com/nodejs/node/pull/62001
 description: Add support for boolean values in bound parameters.
Expand All@@ -1235,7 +1255,8 @@ changes:

* `namedParameters` {Object} An optional object used to bind named parameters.
 The keys of this object are used to configure the mapping.
* `...anonymousParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...anonymousParameters`
 {undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
 Zero or more values to bind to anonymous parameters.
* Returns: {Iterator} An iterable iterator of objects. Each object corresponds to a row
 returned by executing the prepared statement. The keys and values of each
Expand DownExpand Up@@ -1264,6 +1285,9 @@ executions of the same prepared statement.
<!-- YAML
added: v22.5.0
changes:
 - version: REPLACEME
 pr-url: https://github.com/nodejs/node/pull/65709
 description: Bind `undefined` to `NULL`.
 - version: v26.8.0
 pr-url: https://github.com/nodejs/node/pull/62001
 description: Add support for boolean values in bound parameters.
Expand All@@ -1279,7 +1303,8 @@ changes:

* `namedParameters` {Object} An optional object used to bind named parameters.
 The keys of this object are used to configure the mapping.
* `...anonymousParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...anonymousParameters`
 {undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
 Zero or more values to bind to anonymous parameters.
* Returns: {Object}
 * `changes` {number|bigint} The number of rows modified, inserted, or deleted
Expand DownExpand Up@@ -1448,6 +1473,9 @@ class execute synchronously.
<!-- YAML
added: v24.9.0
changes:
 - version: REPLACEME
 pr-url: https://github.com/nodejs/node/pull/65709
 description: Bind `undefined` to `NULL`.
 - version: v26.8.0
 pr-url: https://github.com/nodejs/node/pull/62001
 description: Add support for boolean values in bound parameters.
Expand All@@ -1458,7 +1486,8 @@ changes:

* `stringElements` {string\[]} Template literal elements containing the SQL
 query.
* `...boundParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...boundParameters`
 {undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
 Parameter values to be bound to placeholders in the template string.
* Returns: {Array} An array of objects representing the rows returned by the query.

Expand All@@ -1473,6 +1502,9 @@ called directly.
<!-- YAML
added: v24.9.0
changes:
 - version: REPLACEME
 pr-url: https://github.com/nodejs/node/pull/65709
 description: Bind `undefined` to `NULL`.
 - version: v26.8.0
 pr-url: https://github.com/nodejs/node/pull/62001
 description: Add support for boolean values in bound parameters.
Expand All@@ -1483,7 +1515,8 @@ changes:

* `stringElements` {string\[]} Template literal elements containing the SQL
 query.
* `...boundParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...boundParameters`
 {undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
 Parameter values to be bound to placeholders in the template string.
* Returns: {Object | undefined} An object representing the first row returned by
 the query, or `undefined` if no rows are returned.
Expand All@@ -1498,6 +1531,9 @@ called directly.
<!-- YAML
added: v24.9.0
changes:
 - version: REPLACEME
 pr-url: https://github.com/nodejs/node/pull/65709
 description: Bind `undefined` to `NULL`.
 - version: v26.8.0
 pr-url: https://github.com/nodejs/node/pull/62001
 description: Add support for boolean values in bound parameters.
Expand All@@ -1508,7 +1544,8 @@ changes:

* `stringElements` {string\[]} Template literal elements containing the SQL
 query.
* `...boundParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...boundParameters`
 {undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
 Parameter values to be bound to placeholders in the template string.
* Returns: {Iterator} An iterator that yields objects representing the rows returned by the query.

Expand All@@ -1522,6 +1559,9 @@ called directly.
<!-- YAML
added: v24.9.0
changes:
 - version: REPLACEME
 pr-url: https://github.com/nodejs/node/pull/65709
 description: Bind `undefined` to `NULL`.
 - version: v26.8.0
 pr-url: https://github.com/nodejs/node/pull/62001
 description: Add support for boolean values in bound parameters.
Expand All@@ -1532,7 +1572,8 @@ changes:

* `stringElements` {string\[]} Template literal elements containing the SQL
 query.
* `...boundParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...boundParameters`
 {undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
 Parameter values to be bound to placeholders in the template string.
* Returns: {Object} An object containing information about the execution, including `changes` and `lastInsertRowid`.

Expand Down

5 changes: 3 additions & 2 deletions
src/node_sqlite.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3101,7 +3101,8 @@ bool StatementSync::BindValue(const Local<Value>& value, const int index) {
 // Dates could be supported by converting them to numbers. However, there
 // would not be a good way to read the values back from SQLite with the
 // original type. JS Boolean binds to 1 and 0 because SQLite maps true and
 // false keywords to 1 and 0.
 // false keywords to 1 and 0. JS undefined binds to NULL so that passing it
 // explicitly matches omitting the parameter altogether.
 Isolate* isolate = env()->isolate();
 int r;
 if (value->IsNumber()) {
Expand All@@ -3125,7 +3126,7 @@ bool StatementSync::BindValue(const Local<Value>& value, const int index) {
 SQLITE_TRANSIENT,
 SQLITE_UTF8);
 }
 } else if (value->IsNull()) {
 } else if (value->IsNullOrUndefined()) {
 r = sqlite3_bind_null(statement_.get(), index);
 } else if (value->IsArrayBufferView() || value->IsArrayBuffer() ||
 value->IsSharedArrayBuffer()) {
Expand Down

65 changes: 64 additions & 1 deletion
test/parallel/test-sqlite-data-types.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -80,6 +80,70 @@ suite('data binding and mapping', () => {
 query.get(5),
 { __proto__: null, key: 5, int: 1, double: 0, text: '1', buf: null }
 );

 t.assert.deepStrictEqual(
 stmt.run(6, undefined, undefined, undefined, undefined),
 { changes: 1, lastInsertRowid: 6 }
 );
 t.assert.deepStrictEqual(
 query.get(6),
 { __proto__: null, key: 6, int: null, double: null, text: null, buf: null }
 );
 });

 test('undefined is bound as NULL', (t) => {
 const db = new DatabaseSync(':memory:');
 t.after(() => { db.close(); });
 const setup = db.exec(
 'CREATE TABLE types(key INTEGER PRIMARY KEY, val INTEGER) STRICT;'
 );
 t.assert.strictEqual(setup, undefined);
 const stmt = db.prepare('INSERT INTO types (key, val) VALUES ($k, $v)');
 const query = db.prepare('SELECT * FROM types WHERE key = ?');

 // An explicit `undefined` and an omitted named parameter are equivalent.
 t.assert.deepStrictEqual(
 stmt.run({ k: 1, v: undefined }),
 { changes: 1, lastInsertRowid: 1 }
 );
 t.assert.deepStrictEqual(
 stmt.run({ k: 2 }),
 { changes: 1, lastInsertRowid: 2 }
 );
 t.assert.deepStrictEqual(
 query.get(1),
 { __proto__: null, key: 1, val: null }
 );
 t.assert.deepStrictEqual(
 query.get(2),
 { __proto__: null, key: 2, val: null }
 );

 t.assert.deepStrictEqual(
 db.prepare('SELECT ? AS a').get(undefined),
 { __proto__: null, a: null }
 );
 });

 test('undefined is not treated as the named parameters argument', (t) => {
 const db = new DatabaseSync(':memory:');
 t.after(() => { db.close(); });

 // `undefined` is not an object, so it is bound as an anonymous parameter
 // rather than being treated as the named parameters argument.
 t.assert.throws(() => {
 db.prepare('SELECT $k AS a').get(undefined);
 }, {
 code: 'ERR_SQLITE_ERROR',
 message: /column index out of range/,
 });

 t.assert.throws(() => {
 db.prepare('SELECT ? AS a').get(1, undefined);
 }, {
 code: 'ERR_SQLITE_ERROR',
 message: /column index out of range/,
 });
 });

 test('large strings are bound correctly', (t) => {
Expand DownExpand Up@@ -126,7 +190,6 @@ suite('data binding and mapping', () => {
 t.assert.strictEqual(setup, undefined);

 [
 undefined,
 () => {},
 Symbol(),
 /foo/,
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
sqlite: bind undefined to NULL#65709

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

TrevorBurnham
wants to merge
1
commit into

base:main
Choose a base branch

from


+117

−12

 Open


sqlite: bind undefined to NULL
#65709
Show file tree
Hide file tree
 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


59 changes: 50 additions & 9 deletions
doc/api/sqlite.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -101,7 +101,7 @@ exception.

| Storage class | JavaScript to SQLite | SQLite to JavaScript |
| ------------- | --------------------------------------------------------------- | ------------------------------------- |
| `NULL` | {null}  | {null} |
| `NULL` | {null} or {undefined} | {null} |
| `INTEGER` | {number}, {bigint}, or {boolean} | {number} or {bigint} _(configurable)_ |
| `REAL` | {number} | {number} |
| `TEXT` | {string} | {string} |
Expand All@@ -113,6 +113,10 @@ values (`1n` and `0n`) when reading BigInts is enabled. Writing a {bigint} that
does not fit in a signed 64-bit integer throws an `ERR_INVALID_ARG_VALUE`
error.

`undefined` is written as `NULL`, so passing it explicitly is equivalent to
omitting a named parameter. `NULL` always reads back as {null}, never
`undefined`.

APIs that read values from SQLite have a configuration option that determines
whether `INTEGER` values are converted to `number` or `bigint` in JavaScript,
such as the `readBigInts` option for statements and the `useBigIntArguments`
Expand DownExpand Up@@ -1089,6 +1093,11 @@ Binding a key that does not name a parameter of the statement throws an
`ERR_INVALID_STATE` error unless unknown named parameters are ignored. See
[`statement.setAllowUnknownNamedParameters()`][].

Parameters that are never bound are `NULL`, and binding `undefined` has the same
effect, so `{ $a: undefined }` and `{}` are equivalent. Because `undefined` is
not an object, passing it in place of `namedParameters` binds it as an anonymous
parameter instead.

See [Type conversion between JavaScript and SQLite][] for the values that can be
bound. Binding any other value throws an `ERR_INVALID_ARG_TYPE` error.

Expand All@@ -1097,6 +1106,9 @@ bound. Binding any other value throws an `ERR_INVALID_ARG_TYPE` error.
<!-- YAML
added: v22.5.0
changes:
 - version: REPLACEME
 pr-url: https://github.com/nodejs/node/pull/65709
 description: Bind `undefined` to `NULL`.
 - version: v26.8.0
 pr-url: https://github.com/nodejs/node/pull/62001
 description: Add support for boolean values in bound parameters.
Expand All@@ -1112,7 +1124,8 @@ changes:

* `namedParameters` {Object} An optional object used to bind named parameters.
 The keys of this object are used to configure the mapping.
* `...anonymousParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...anonymousParameters`
 {undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
 Zero or more values to bind to anonymous parameters.
* Returns: {Array} An array of objects. Each object corresponds to a row
 returned by executing the prepared statement. The keys and values of each
Expand DownExpand Up@@ -1185,6 +1198,9 @@ execution of this prepared statement. This property is a wrapper around
<!-- YAML
added: v22.5.0
changes:
 - version: REPLACEME
 pr-url: https://github.com/nodejs/node/pull/65709
 description: Bind `undefined` to `NULL`.
 - version: v26.8.0
 pr-url: https://github.com/nodejs/node/pull/62001
 description: Add support for boolean values in bound parameters.
Expand All@@ -1200,7 +1216,8 @@ changes:

* `namedParameters` {Object} An optional object used to bind named parameters.
 The keys of this object are used to configure the mapping.
* `...anonymousParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...anonymousParameters`
 {undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
 Zero or more values to bind to anonymous parameters.
* Returns: {Object|undefined} An object corresponding to the first row returned
 by executing the prepared statement. The keys and values of the object
Expand All@@ -1220,6 +1237,9 @@ added:
 - v23.4.0
 - v22.13.0
changes:
 - version: REPLACEME
 pr-url: https://github.com/nodejs/node/pull/65709
 description: Bind `undefined` to `NULL`.
 - version: v26.8.0
 pr-url: https://github.com/nodejs/node/pull/62001
 description: Add support for boolean values in bound parameters.
Expand All@@ -1235,7 +1255,8 @@ changes:

* `namedParameters` {Object} An optional object used to bind named parameters.
 The keys of this object are used to configure the mapping.
* `...anonymousParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...anonymousParameters`
 {undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
 Zero or more values to bind to anonymous parameters.
* Returns: {Iterator} An iterable iterator of objects. Each object corresponds to a row
 returned by executing the prepared statement. The keys and values of each
Expand DownExpand Up@@ -1264,6 +1285,9 @@ executions of the same prepared statement.
<!-- YAML
added: v22.5.0
changes:
 - version: REPLACEME
 pr-url: https://github.com/nodejs/node/pull/65709
 description: Bind `undefined` to `NULL`.
 - version: v26.8.0
 pr-url: https://github.com/nodejs/node/pull/62001
 description: Add support for boolean values in bound parameters.
Expand All@@ -1279,7 +1303,8 @@ changes:

* `namedParameters` {Object} An optional object used to bind named parameters.
 The keys of this object are used to configure the mapping.
* `...anonymousParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...anonymousParameters`
 {undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
 Zero or more values to bind to anonymous parameters.
* Returns: {Object}
 * `changes` {number|bigint} The number of rows modified, inserted, or deleted
Expand DownExpand Up@@ -1448,6 +1473,9 @@ class execute synchronously.
<!-- YAML
added: v24.9.0
changes:
 - version: REPLACEME
 pr-url: https://github.com/nodejs/node/pull/65709
 description: Bind `undefined` to `NULL`.
 - version: v26.8.0
 pr-url: https://github.com/nodejs/node/pull/62001
 description: Add support for boolean values in bound parameters.
Expand All@@ -1458,7 +1486,8 @@ changes:

* `stringElements` {string\[]} Template literal elements containing the SQL
 query.
* `...boundParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...boundParameters`
 {undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
 Parameter values to be bound to placeholders in the template string.
* Returns: {Array} An array of objects representing the rows returned by the query.

Expand All@@ -1473,6 +1502,9 @@ called directly.
<!-- YAML
added: v24.9.0
changes:
 - version: REPLACEME
 pr-url: https://github.com/nodejs/node/pull/65709
 description: Bind `undefined` to `NULL`.
 - version: v26.8.0
 pr-url: https://github.com/nodejs/node/pull/62001
 description: Add support for boolean values in bound parameters.
Expand All@@ -1483,7 +1515,8 @@ changes:

* `stringElements` {string\[]} Template literal elements containing the SQL
 query.
* `...boundParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...boundParameters`
 {undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
 Parameter values to be bound to placeholders in the template string.
* Returns: {Object | undefined} An object representing the first row returned by
 the query, or `undefined` if no rows are returned.
Expand All@@ -1498,6 +1531,9 @@ called directly.
<!-- YAML
added: v24.9.0
changes:
 - version: REPLACEME
 pr-url: https://github.com/nodejs/node/pull/65709
 description: Bind `undefined` to `NULL`.
 - version: v26.8.0
 pr-url: https://github.com/nodejs/node/pull/62001
 description: Add support for boolean values in bound parameters.
Expand All@@ -1508,7 +1544,8 @@ changes:

* `stringElements` {string\[]} Template literal elements containing the SQL
 query.
* `...boundParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...boundParameters`
 {undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
 Parameter values to be bound to placeholders in the template string.
* Returns: {Iterator} An iterator that yields objects representing the rows returned by the query.

Expand All@@ -1522,6 +1559,9 @@ called directly.
<!-- YAML
added: v24.9.0
changes:
 - version: REPLACEME
 pr-url: https://github.com/nodejs/node/pull/65709
 description: Bind `undefined` to `NULL`.
 - version: v26.8.0
 pr-url: https://github.com/nodejs/node/pull/62001
 description: Add support for boolean values in bound parameters.
Expand All@@ -1532,7 +1572,8 @@ changes:

* `stringElements` {string\[]} Template literal elements containing the SQL
 query.
* `...boundParameters` {null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
* `...boundParameters`
 {undefined|null|number|bigint|boolean|string|Buffer|TypedArray|DataView|ArrayBuffer|SharedArrayBuffer}
 Parameter values to be bound to placeholders in the template string.
* Returns: {Object} An object containing information about the execution, including `changes` and `lastInsertRowid`.

Expand Down

5 changes: 3 additions & 2 deletions
src/node_sqlite.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3101,7 +3101,8 @@ bool StatementSync::BindValue(const Local<Value>& value, const int index) {
 // Dates could be supported by converting them to numbers. However, there
 // would not be a good way to read the values back from SQLite with the
 // original type. JS Boolean binds to 1 and 0 because SQLite maps true and
 // false keywords to 1 and 0.
 // false keywords to 1 and 0. JS undefined binds to NULL so that passing it
 // explicitly matches omitting the parameter altogether.
 Isolate* isolate = env()->isolate();
 int r;
 if (value->IsNumber()) {
Expand All@@ -3125,7 +3126,7 @@ bool StatementSync::BindValue(const Local<Value>& value, const int index) {
 SQLITE_TRANSIENT,
 SQLITE_UTF8);
 }
 } else if (value->IsNull()) {
 } else if (value->IsNullOrUndefined()) {
 r = sqlite3_bind_null(statement_.get(), index);
 } else if (value->IsArrayBufferView() || value->IsArrayBuffer() ||
 value->IsSharedArrayBuffer()) {
Expand Down

65 changes: 64 additions & 1 deletion
test/parallel/test-sqlite-data-types.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -80,6 +80,70 @@ suite('data binding and mapping', () => {
 query.get(5),
 { __proto__: null, key: 5, int: 1, double: 0, text: '1', buf: null }
 );

 t.assert.deepStrictEqual(
 stmt.run(6, undefined, undefined, undefined, undefined),
 { changes: 1, lastInsertRowid: 6 }
 );
 t.assert.deepStrictEqual(
 query.get(6),
 { __proto__: null, key: 6, int: null, double: null, text: null, buf: null }
 );
 });

 test('undefined is bound as NULL', (t) => {
 const db = new DatabaseSync(':memory:');
 t.after(() => { db.close(); });
 const setup = db.exec(
 'CREATE TABLE types(key INTEGER PRIMARY KEY, val INTEGER) STRICT;'
 );
 t.assert.strictEqual(setup, undefined);
 const stmt = db.prepare('INSERT INTO types (key, val) VALUES ($k, $v)');
 const query = db.prepare('SELECT * FROM types WHERE key = ?');

 // An explicit `undefined` and an omitted named parameter are equivalent.
 t.assert.deepStrictEqual(
 stmt.run({ k: 1, v: undefined }),
 { changes: 1, lastInsertRowid: 1 }
 );
 t.assert.deepStrictEqual(
 stmt.run({ k: 2 }),
 { changes: 1, lastInsertRowid: 2 }
 );
 t.assert.deepStrictEqual(
 query.get(1),
 { __proto__: null, key: 1, val: null }
 );
 t.assert.deepStrictEqual(
 query.get(2),
 { __proto__: null, key: 2, val: null }
 );

 t.assert.deepStrictEqual(
 db.prepare('SELECT ? AS a').get(undefined),
 { __proto__: null, a: null }
 );
 });

 test('undefined is not treated as the named parameters argument', (t) => {
 const db = new DatabaseSync(':memory:');
 t.after(() => { db.close(); });

 // `undefined` is not an object, so it is bound as an anonymous parameter
 // rather than being treated as the named parameters argument.
 t.assert.throws(() => {
 db.prepare('SELECT $k AS a').get(undefined);
 }, {
 code: 'ERR_SQLITE_ERROR',
 message: /column index out of range/,
 });

 t.assert.throws(() => {
 db.prepare('SELECT ? AS a').get(1, undefined);
 }, {
 code: 'ERR_SQLITE_ERROR',
 message: /column index out of range/,
 });
 });

 test('large strings are bound correctly', (t) => {
Expand DownExpand Up@@ -126,7 +190,6 @@ suite('data binding and mapping', () => {
 t.assert.strictEqual(setup, undefined);

 [
 undefined,
 () => {},
 Symbol(),
 /foo/,
Expand Down
Loading