Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions doc/api/sqlite.md
Original file line number Diff line number Diff line change
Expand Up @@ -1011,6 +1011,9 @@ db.prepare('SELECT ?2 AS a, ?1 AS b').get('first', 'second');
// { a: 'second', b: 'first' }
```

Passing more anonymous parameters than the statement accepts throws an
`ERR_INVALID_STATE` error. The `?NNN` form raises the number accepted to `NNN`.

Named parameters begin with one of the prefix characters `$`, `:`, or `@` in
SQL. They are bound from an object passed as the first argument. Repeating a
name in the SQL binds the same value to every occurrence.
Expand Down
14 changes: 13 additions & 1 deletion src/node_sqlite.cc
Original file line number Diff line number Diff line change
Expand Up @@ -2777,13 +2777,25 @@ bool StatementSync::BindParams(const FunctionCallbackInfo<Value>& args) {
anon_start++;
}

int param_count = sqlite3_bind_parameter_count(statement_);

for (int i = anon_start; i < args.Length(); ++i) {
while (1) {
while (anon_idx <= param_count) {
const char* param = sqlite3_bind_parameter_name(statement_, anon_idx);
if (param == nullptr || param[0] == '?') break;
anon_idx++;
}

if (anon_idx > param_count) {
THROW_ERR_INVALID_STATE(
env(),
"Too many anonymous parameter values were provided. "
"The statement accepts %d, but received %d",
i - anon_start,
args.Length() - anon_start);
return false;
}

if (!BindValue(args[i], anon_idx)) {
return false;
}
Expand Down
33 changes: 28 additions & 5 deletions test/parallel/test-sqlite-statement-sync.js
Original file line number Diff line number Diff line change
Expand Up @@ -337,7 +337,7 @@ suite('StatementSync.prototype.run()', () => {
t.assert.deepStrictEqual(stmt.run(), { changes: 1, lastInsertRowid: 1 });
});

test('SQLite throws when trying to bind too many parameters', (t) => {
test('throws when trying to bind too many parameters', (t) => {
const db = new DatabaseSync(':memory:');
t.after(() => { db.close(); });
const setup = db.exec(
Expand All @@ -348,10 +348,33 @@ suite('StatementSync.prototype.run()', () => {
t.assert.throws(() => {
stmt.run(1, 2, 3);
}, {
code: 'ERR_SQLITE_ERROR',
message: 'column index out of range',
errcode: 25,
errstr: 'column index out of range',
code: 'ERR_INVALID_STATE',

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I guess ERR_INVALID_ARG_TYPE is more appropriate

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I looked at both codes before I picked this one.

doc/api/errors.md defines ERR_INVALID_ARG_TYPE as "An argument of the wrong type was passed to a Node.js API". Here the values have valid types. There are simply more of them than the statement has anonymous slots.

The closest case is the unknown named parameter failure in the same function. It throws ERR_INVALID_STATE, and sqlite.md documents it that way. In node_sqlite.cc every ERR_INVALID_ARG_TYPE is a real type check, and the docs already draw that line: a value of an unsupported type gives ERR_INVALID_ARG_TYPE, a parameter that the statement does not accept gives ERR_INVALID_STATE.

So I kept ERR_INVALID_STATE for consistency. If you still prefer ERR_INVALID_ARG_TYPE, say so and I will change it.

message: 'Too many anonymous parameter values were provided. ' +
'The statement accepts 2, but received 3',
});

t.assert.throws(() => {
db.prepare('SELECT 1').run(5);
}, {
code: 'ERR_INVALID_STATE',
message: 'Too many anonymous parameter values were provided. ' +
'The statement accepts 0, but received 1',
});

t.assert.throws(() => {
db.prepare('SELECT $a AS a, ? AS b').run({ $a: 1 }, 2, 3);
}, {
code: 'ERR_INVALID_STATE',
message: 'Too many anonymous parameter values were provided. ' +
'The statement accepts 1, but received 2',
});

t.assert.throws(() => {
db.prepare('SELECT $a AS a').run(1);
}, {
code: 'ERR_INVALID_STATE',
message: 'Too many anonymous parameter values were provided. ' +
'The statement accepts 0, but received 1',
});
});

Expand Down
Loading