sqlite: add StatementSync.prototype.close() and [Symbol.dispose]()#64232

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
araujogui wants to merge 4 commits into from
Closed

sqlite: add StatementSync.prototype.close() and [Symbol.dispose]() #64232

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5b64452
sqlite: add StatementSync.prototype[Symbol.dispose]()
araujogui Jul 1, 2026
9425bac
sqlite: simplify StatementSync dispose
araujogui Jul 3, 2026
9f6d4eb
sqlite: add StatementSync.prototype.close()
araujogui Jul 4, 2026
7144743
sqlite: remove unnecessary trycatch
araujogui Jul 4, 2026
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
19 changes: 19 additions & 0 deletions doc/api/sqlite.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -997,6 +997,15 @@ objects. If the prepared statement does not return any results, this method
returns an empty array. The prepared statement [parameters are bound][] using
the values in `namedParameters` and `anonymousParameters`.

### `statement.close()`

<!-- YAML
added: REPLACEME
-->

Finalizes the prepared statement. An exception is thrown if the statement is
already finalized. This method is a wrapper around [`sqlite3_finalize()`][].

### `statement.columns()`

<!-- YAML
Expand DownExpand Up@@ -1202,6 +1211,15 @@ added: v22.5.0
The source SQL text of the prepared statement. This property is a
wrapper around [`sqlite3_sql()`][].

### `statement[Symbol.dispose]()`

<!-- YAML
added: REPLACEME
-->

Finalizes the prepared statement. If the prepared statement is already
finalized, then this is a no-op.

## Class: `SQLTagStore`

<!-- YAML
Expand DownExpand Up@@ -1682,6 +1700,7 @@ callback function to indicate what type of operation is being authorized.
[`sqlite3_deserialize()`]: https://sqlite.org/c3ref/deserialize.html
[`sqlite3_exec()`]: https://www.sqlite.org/c3ref/exec.html
[`sqlite3_expanded_sql()`]: https://www.sqlite.org/c3ref/expanded_sql.html
[`sqlite3_finalize()`]: https://www.sqlite.org/c3ref/finalize.html
[`sqlite3_get_autocommit()`]: https://sqlite.org/c3ref/get_autocommit.html
[`sqlite3_last_insert_rowid()`]: https://www.sqlite.org/c3ref/last_insert_rowid.html
[`sqlite3_load_extension()`]: https://www.sqlite.org/c3ref/load_extension.html
Expand Down
26 changes: 22 additions & 4 deletions src/node_sqlite.cc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1037,10 +1037,7 @@ void DatabaseSync::FinalizeStatements() {
}

void DatabaseSync::UntrackStatement(StatementSync* statement) {
auto it = statements_.find(statement);
if (it != statements_.end()) {
statements_.erase(it);
}
statements_.erase(statement);
}

inline bool DatabaseSync::IsOpen() {
Expand DownExpand Up@@ -2578,6 +2575,10 @@ StatementSync::StatementSync(Environment* env,
}

StatementSync::~StatementSync() {
Close();
}

void StatementSync::Close() {
if (!IsFinalized()) {
db_->UntrackStatement(this);
Finalize();
Expand All@@ -2598,6 +2599,21 @@ inline bool StatementSync::IsFinalized() {
return statement_ == nullptr;
}

void StatementSync::Close(const FunctionCallbackInfo<Value>& args) {
StatementSync* stmt;
ASSIGN_OR_RETURN_UNWRAP(&stmt, args.This());
Environment* env = Environment::GetCurrent(args);
THROW_AND_RETURN_ON_BAD_STATE(
env, stmt->IsFinalized(), "statement has been finalized");
stmt->Close();
}

void StatementSync::Dispose(const FunctionCallbackInfo<Value>& args) {
StatementSync* stmt;
ASSIGN_OR_RETURN_UNWRAP(&stmt, args.This());
stmt->Close();
}

inline int StatementSync::ResetStatement() {
reset_generation_++;
return sqlite3_reset(statement_);
Expand DownExpand Up@@ -3629,6 +3645,8 @@ Local<FunctionTemplate> StatementSync::GetConstructorTemplate(
isolate, tmpl, "setReadBigInts", StatementSync::SetReadBigInts);
SetProtoMethod(
isolate, tmpl, "setReturnArrays", StatementSync::SetReturnArrays);
SetProtoMethod(isolate, tmpl, "close", StatementSync::Close);
SetProtoDispose(isolate, tmpl, StatementSync::Dispose);
env->set_sqlite_statement_sync_constructor_template(tmpl);
}
return tmpl;
Expand Down
3 changes: 3 additions & 0 deletions src/node_sqlite.h
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -278,6 +278,8 @@ class StatementSync : public BaseObject {
const v8::FunctionCallbackInfo<v8::Value>& args);
static void SetReadBigInts(const v8::FunctionCallbackInfo<v8::Value>& args);
static void SetReturnArrays(const v8::FunctionCallbackInfo<v8::Value>& args);
static void Close(const v8::FunctionCallbackInfo<v8::Value>& args);
static void Dispose(const v8::FunctionCallbackInfo<v8::Value>& args);
v8::MaybeLocal<v8::Value> ColumnToValue(const int column);
v8::MaybeLocal<v8::Name> ColumnNameToName(const int column);
bool GetCachedColumnNames(v8::LocalVector<v8::Name>* keys);
Expand All@@ -289,6 +291,7 @@ class StatementSync : public BaseObject {

private:
~StatementSync() override;
void Close();
BaseObjectPtr<DatabaseSync> db_;
sqlite3_stmt* statement_;
bool return_arrays_ = false;
Expand Down
16 changes: 16 additions & 0 deletions test/parallel/test-sqlite-named-parameters.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -118,6 +118,22 @@ suite('StatementSync.prototype.setAllowUnknownNamedParameters()', () => {
message: /The "enabled" argument must be a boolean/,
});
});

test('throws if the statement is already finalized', (t) => {
using db = new DatabaseSync(':memory:');
const setup = db.exec(
'CREATE TABLE data(key INTEGER PRIMARY KEY, val INTEGER) STRICT;'
);
t.assert.strictEqual(setup, undefined);
const stmt = db.prepare('INSERT INTO data (key, val) VALUES ($k, $v)');
stmt.close();
t.assert.throws(() => {
stmt.setAllowUnknownNamedParameters(true);
}, {
code: 'ERR_INVALID_STATE',
message: /statement has been finalized/,
});
});
});

suite('options.allowUnknownNamedParameters', () => {
Expand Down
172 changes: 172 additions & 0 deletions test/parallel/test-sqlite-statement-sync.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -76,6 +76,18 @@ suite('StatementSync.prototype.get()', () => {
__proto__: null, key: 'key1', val: 'val1',
});
});

test('throws if the statement is already finalized', (t) => {
using db = new DatabaseSync(':memory:');
const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
stmt.close();
t.assert.throws(() => {
stmt.get();
}, {
code: 'ERR_INVALID_STATE',
message: /statement has been finalized/,
});
});
});

suite('StatementSync.prototype.all()', () => {
Expand DownExpand Up@@ -129,6 +141,18 @@ suite('StatementSync.prototype.all()', () => {
{ __proto__: null, key: 'key1', val: 'val1' },
]);
});

test('throws if the statement is already finalized', (t) => {
using db = new DatabaseSync(':memory:');
const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
stmt.close();
t.assert.throws(() => {
stmt.all();
}, {
code: 'ERR_INVALID_STATE',
message: /statement has been finalized/,
});
});
});

suite('StatementSync.prototype.iterate()', () => {
Expand DownExpand Up@@ -295,6 +319,18 @@ suite('StatementSync.prototype.iterate()', () => {
stmt2.get();
it.next();
});

test('throws if the statement is already finalized', (t) => {
using db = new DatabaseSync(':memory:');
const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
stmt.close();
t.assert.throws(() => {
stmt.iterate();
}, {
code: 'ERR_INVALID_STATE',
message: /statement has been finalized/,
});
});
});

suite('StatementSync.prototype.run()', () => {
Expand DownExpand Up@@ -394,6 +430,18 @@ suite('StatementSync.prototype.run()', () => {
const stmt = db.prepare('INSERT INTO data (key, val) VALUES (?1, ?2)');
t.assert.deepStrictEqual(stmt.run(1, 2), { changes: 1, lastInsertRowid: 1 });
});

test('throws if the statement is already finalized', (t) => {
using db = new DatabaseSync(':memory:');
const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
stmt.close();
t.assert.throws(() => {
stmt.run();
}, {
code: 'ERR_INVALID_STATE',
message: /statement has been finalized/,
});
});
});

suite('StatementSync.prototype.sourceSQL', () => {
Expand All@@ -408,6 +456,16 @@ suite('StatementSync.prototype.sourceSQL', () => {
const stmt = db.prepare(sql);
t.assert.strictEqual(stmt.sourceSQL, sql);
});

test('throws if the statement is already finalized', (t) => {
using db = new DatabaseSync(':memory:');
const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
stmt.close();
t.assert.throws(() => stmt.sourceSQL, {
code: 'ERR_INVALID_STATE',
message: /statement has been finalized/,
});
});
});

suite('StatementSync.prototype.expandedSQL', () => {
Expand All@@ -427,6 +485,16 @@ suite('StatementSync.prototype.expandedSQL', () => {
);
t.assert.strictEqual(stmt.expandedSQL, expanded);
});

test('throws if the statement is already finalized', (t) => {
using db = new DatabaseSync(':memory:');
const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
stmt.close();
t.assert.throws(() => stmt.expandedSQL, {
code: 'ERR_INVALID_STATE',
message: /statement has been finalized/,
});
});
});

suite('StatementSync.prototype.setReadBigInts()', () => {
Expand DownExpand Up@@ -496,6 +564,18 @@ suite('StatementSync.prototype.setReadBigInts()', () => {
[`${Number.MAX_SAFE_INTEGER} + 1`]: 2n ** 53n,
});
});

test('throws if the statement is already finalized', (t) => {
using db = new DatabaseSync(':memory:');
const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
stmt.close();
t.assert.throws(() => {
stmt.setReadBigInts(true);
}, {
code: 'ERR_INVALID_STATE',
message: /statement has been finalized/,
});
});
});

suite('StatementSync.prototype.setReturnArrays()', () => {
Expand All@@ -514,6 +594,18 @@ suite('StatementSync.prototype.setReturnArrays()', () => {
message: /The "returnArrays" argument must be a boolean/,
});
});

test('throws if the statement is already finalized', (t) => {
using db = new DatabaseSync(':memory:');
const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
stmt.close();
t.assert.throws(() => {
stmt.setReturnArrays(true);
}, {
code: 'ERR_INVALID_STATE',
message: /statement has been finalized/,
});
});
});

suite('StatementSync.prototype.get() with array output', () => {
Expand DownExpand Up@@ -732,6 +824,18 @@ suite('StatementSync.prototype.setAllowBareNamedParameters()', () => {
message: /The "allowBareNamedParameters" argument must be a boolean/,
});
});

test('throws if the statement is already finalized', (t) => {
using db = new DatabaseSync(':memory:');
const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
stmt.close();
t.assert.throws(() => {
stmt.setAllowBareNamedParameters(true);
}, {
code: 'ERR_INVALID_STATE',
message: /statement has been finalized/,
});
});
});

suite('options.readBigInts', () => {
Expand DownExpand Up@@ -978,3 +1082,71 @@ suite('options.allowBareNamedParameters', () => {
);
});
});


suite('StatementSync.prototype.close()', () => {
test('finalizes an open statement', (t) => {
using db = new DatabaseSync(':memory:');
db.exec('CREATE TABLE storage(key TEXT, val TEXT)');
const stmt = db.prepare('SELECT * FROM storage');
t.assert.strictEqual(stmt.close(), undefined);
t.assert.throws(() => stmt.get(), {
code: 'ERR_INVALID_STATE',
message: /statement has been finalized/,
});
});

test('throws if the statement is already finalized', (t) => {
using db = new DatabaseSync(':memory:');
const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
stmt.close();
t.assert.throws(() => {
stmt.close();
}, {
code: 'ERR_INVALID_STATE',
message: /statement has been finalized/,
});
});
});

suite('StatementSync.prototype[Symbol.dispose]()', () => {
test('finalizes an open statement', (t) => {
using db = new DatabaseSync(':memory:');
db.exec('CREATE TABLE storage(key TEXT, val TEXT)');
const stmt = db.prepare('SELECT * FROM storage');
stmt[Symbol.dispose]();
t.assert.throws(() => stmt.get(), {
code: 'ERR_INVALID_STATE',
message: /statement has been finalized/,
});
});

test('does not throw on an already-finalized statement', () => {
using db = new DatabaseSync(':memory:');
const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
stmt[Symbol.dispose]();
stmt[Symbol.dispose]();
});

test('works with a using declaration', (t) => {
using db = new DatabaseSync(':memory:');
db.exec('CREATE TABLE storage(key TEXT, val TEXT)');
let captured;
{
using stmt = db.prepare('SELECT * FROM storage');
captured = stmt;
t.assert.deepStrictEqual(stmt.all(), []);
}
t.assert.throws(() => captured.get(), {
code: 'ERR_INVALID_STATE',
message: /statement has been finalized/,
});
});

test('closing the database after dispose does not double-finalize', () => {
using db = new DatabaseSync(':memory:');
const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
stmt[Symbol.dispose]();
db.close();
});
});
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: add StatementSync.prototype.close() and [Symbol.dispose]()#64232

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

araujogui
wants to merge
4
commits into

from

 Closed


sqlite: add StatementSync.prototype.close() and [Symbol.dispose]()
#64232
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
5b64452

sqlite: add StatementSync.prototype[Symbol.dispose]()


araujogui Jul 1, 2026
9425bac

sqlite: simplify StatementSync dispose


araujogui Jul 3, 2026
9f6d4eb

sqlite: add StatementSync.prototype.close()


araujogui Jul 4, 2026
7144743

sqlite: remove unnecessary trycatch


araujogui Jul 4, 2026

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


19 changes: 19 additions & 0 deletions
doc/api/sqlite.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -997,6 +997,15 @@ objects. If the prepared statement does not return any results, this method
returns an empty array. The prepared statement [parameters are bound][] using
the values in `namedParameters` and `anonymousParameters`.

### `statement.close()`

<!-- YAML
added: REPLACEME
-->

Finalizes the prepared statement. An exception is thrown if the statement is
already finalized. This method is a wrapper around [`sqlite3_finalize()`][].

### `statement.columns()`

<!-- YAML
Expand DownExpand Up@@ -1202,6 +1211,15 @@ added: v22.5.0
The source SQL text of the prepared statement. This property is a
wrapper around [`sqlite3_sql()`][].

### `statement[Symbol.dispose]()`

<!-- YAML
added: REPLACEME
-->

Finalizes the prepared statement. If the prepared statement is already
finalized, then this is a no-op.

## Class: `SQLTagStore`

<!-- YAML
Expand DownExpand Up@@ -1682,6 +1700,7 @@ callback function to indicate what type of operation is being authorized.
[`sqlite3_deserialize()`]: https://sqlite.org/c3ref/deserialize.html
[`sqlite3_exec()`]: https://www.sqlite.org/c3ref/exec.html
[`sqlite3_expanded_sql()`]: https://www.sqlite.org/c3ref/expanded_sql.html
[`sqlite3_finalize()`]: https://www.sqlite.org/c3ref/finalize.html
[`sqlite3_get_autocommit()`]: https://sqlite.org/c3ref/get_autocommit.html
[`sqlite3_last_insert_rowid()`]: https://www.sqlite.org/c3ref/last_insert_rowid.html
[`sqlite3_load_extension()`]: https://www.sqlite.org/c3ref/load_extension.html
Expand Down

26 changes: 22 additions & 4 deletions
src/node_sqlite.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1037,10 +1037,7 @@ void DatabaseSync::FinalizeStatements() {
}

void DatabaseSync::UntrackStatement(StatementSync* statement) {
 auto it = statements_.find(statement);
 if (it != statements_.end()) {
 statements_.erase(it);
 }
 statements_.erase(statement);
}

inline bool DatabaseSync::IsOpen() {
Expand DownExpand Up@@ -2578,6 +2575,10 @@ StatementSync::StatementSync(Environment* env,
}

StatementSync::~StatementSync() {
 Close();
}

void StatementSync::Close() {
 if (!IsFinalized()) {
 db_->UntrackStatement(this);
 Finalize();
Expand All@@ -2598,6 +2599,21 @@ inline bool StatementSync::IsFinalized() {
 return statement_ == nullptr;
}

void StatementSync::Close(const FunctionCallbackInfo<Value>& args) {
 StatementSync* stmt;
 ASSIGN_OR_RETURN_UNWRAP(&stmt, args.This());
 Environment* env = Environment::GetCurrent(args);
 THROW_AND_RETURN_ON_BAD_STATE(
 env, stmt->IsFinalized(), "statement has been finalized");
 stmt->Close();
}

void StatementSync::Dispose(const FunctionCallbackInfo<Value>& args) {
 StatementSync* stmt;
 ASSIGN_OR_RETURN_UNWRAP(&stmt, args.This());
 stmt->Close();
}

inline int StatementSync::ResetStatement() {
 reset_generation_++;
 return sqlite3_reset(statement_);
Expand DownExpand Up@@ -3629,6 +3645,8 @@ Local<FunctionTemplate> StatementSync::GetConstructorTemplate(
 isolate, tmpl, "setReadBigInts", StatementSync::SetReadBigInts);
 SetProtoMethod(
 isolate, tmpl, "setReturnArrays", StatementSync::SetReturnArrays);
 SetProtoMethod(isolate, tmpl, "close", StatementSync::Close);
 SetProtoDispose(isolate, tmpl, StatementSync::Dispose);
 env->set_sqlite_statement_sync_constructor_template(tmpl);
 }
 return tmpl;
Expand Down

3 changes: 3 additions & 0 deletions
src/node_sqlite.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -278,6 +278,8 @@ class StatementSync : public BaseObject {
 const v8::FunctionCallbackInfo<v8::Value>& args);
 static void SetReadBigInts(const v8::FunctionCallbackInfo<v8::Value>& args);
 static void SetReturnArrays(const v8::FunctionCallbackInfo<v8::Value>& args);
 static void Close(const v8::FunctionCallbackInfo<v8::Value>& args);
 static void Dispose(const v8::FunctionCallbackInfo<v8::Value>& args);
 v8::MaybeLocal<v8::Value> ColumnToValue(const int column);
 v8::MaybeLocal<v8::Name> ColumnNameToName(const int column);
 bool GetCachedColumnNames(v8::LocalVector<v8::Name>* keys);
Expand All@@ -289,6 +291,7 @@ class StatementSync : public BaseObject {

 private:
 ~StatementSync() override;
 void Close();
 BaseObjectPtr<DatabaseSync> db_;
 sqlite3_stmt* statement_;
 bool return_arrays_ = false;
Expand Down

16 changes: 16 additions & 0 deletions
test/parallel/test-sqlite-named-parameters.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -118,6 +118,22 @@ suite('StatementSync.prototype.setAllowUnknownNamedParameters()', () => {
 message: /The "enabled" argument must be a boolean/,
 });
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const setup = db.exec(
 'CREATE TABLE data(key INTEGER PRIMARY KEY, val INTEGER) STRICT;'
 );
 t.assert.strictEqual(setup, undefined);
 const stmt = db.prepare('INSERT INTO data (key, val) VALUES ($k, $v)');
 stmt.close();
 t.assert.throws(() => {
 stmt.setAllowUnknownNamedParameters(true);
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('options.allowUnknownNamedParameters', () => {
Expand Down

172 changes: 172 additions & 0 deletions
test/parallel/test-sqlite-statement-sync.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -76,6 +76,18 @@ suite('StatementSync.prototype.get()', () => {
 __proto__: null, key: 'key1', val: 'val1',
 });
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => {
 stmt.get();
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype.all()', () => {
Expand DownExpand Up@@ -129,6 +141,18 @@ suite('StatementSync.prototype.all()', () => {
 { __proto__: null, key: 'key1', val: 'val1' },
 ]);
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => {
 stmt.all();
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype.iterate()', () => {
Expand DownExpand Up@@ -295,6 +319,18 @@ suite('StatementSync.prototype.iterate()', () => {
 stmt2.get();
 it.next();
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => {
 stmt.iterate();
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype.run()', () => {
Expand DownExpand Up@@ -394,6 +430,18 @@ suite('StatementSync.prototype.run()', () => {
 const stmt = db.prepare('INSERT INTO data (key, val) VALUES (?1, ?2)');
 t.assert.deepStrictEqual(stmt.run(1, 2), { changes: 1, lastInsertRowid: 1 });
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => {
 stmt.run();
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype.sourceSQL', () => {
Expand All@@ -408,6 +456,16 @@ suite('StatementSync.prototype.sourceSQL', () => {
 const stmt = db.prepare(sql);
 t.assert.strictEqual(stmt.sourceSQL, sql);
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => stmt.sourceSQL, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype.expandedSQL', () => {
Expand All@@ -427,6 +485,16 @@ suite('StatementSync.prototype.expandedSQL', () => {
 );
 t.assert.strictEqual(stmt.expandedSQL, expanded);
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => stmt.expandedSQL, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype.setReadBigInts()', () => {
Expand DownExpand Up@@ -496,6 +564,18 @@ suite('StatementSync.prototype.setReadBigInts()', () => {
 [`${Number.MAX_SAFE_INTEGER} + 1`]: 2n ** 53n,
 });
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => {
 stmt.setReadBigInts(true);
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype.setReturnArrays()', () => {
Expand All@@ -514,6 +594,18 @@ suite('StatementSync.prototype.setReturnArrays()', () => {
 message: /The "returnArrays" argument must be a boolean/,
 });
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => {
 stmt.setReturnArrays(true);
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype.get() with array output', () => {
Expand DownExpand Up@@ -732,6 +824,18 @@ suite('StatementSync.prototype.setAllowBareNamedParameters()', () => {
 message: /The "allowBareNamedParameters" argument must be a boolean/,
 });
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => {
 stmt.setAllowBareNamedParameters(true);
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('options.readBigInts', () => {
Expand DownExpand Up@@ -978,3 +1082,71 @@ suite('options.allowBareNamedParameters', () => {
 );
 });
});


suite('StatementSync.prototype.close()', () => {
 test('finalizes an open statement', (t) => {
 using db = new DatabaseSync(':memory:');
 db.exec('CREATE TABLE storage(key TEXT, val TEXT)');
 const stmt = db.prepare('SELECT * FROM storage');
 t.assert.strictEqual(stmt.close(), undefined);
 t.assert.throws(() => stmt.get(), {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => {
 stmt.close();
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype[Symbol.dispose]()', () => {
 test('finalizes an open statement', (t) => {
 using db = new DatabaseSync(':memory:');
 db.exec('CREATE TABLE storage(key TEXT, val TEXT)');
 const stmt = db.prepare('SELECT * FROM storage');
 stmt[Symbol.dispose]();
 t.assert.throws(() => stmt.get(), {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });

 test('does not throw on an already-finalized statement', () => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt[Symbol.dispose]();
 stmt[Symbol.dispose]();
 });

 test('works with a using declaration', (t) => {
 using db = new DatabaseSync(':memory:');
 db.exec('CREATE TABLE storage(key TEXT, val TEXT)');
 let captured;
 {
 using stmt = db.prepare('SELECT * FROM storage');
 captured = stmt;
 t.assert.deepStrictEqual(stmt.all(), []);
 }
 t.assert.throws(() => captured.get(), {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });

 test('closing the database after dispose does not double-finalize', () => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt[Symbol.dispose]();
 db.close();
 });
});
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: add StatementSync.prototype.close() and [Symbol.dispose]()#64232

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

araujogui
wants to merge
4
commits into

from

 Closed


sqlite: add StatementSync.prototype.close() and [Symbol.dispose]()
#64232
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
5b64452

sqlite: add StatementSync.prototype[Symbol.dispose]()


araujogui Jul 1, 2026
9425bac

sqlite: simplify StatementSync dispose


araujogui Jul 3, 2026
9f6d4eb

sqlite: add StatementSync.prototype.close()


araujogui Jul 4, 2026
7144743

sqlite: remove unnecessary trycatch


araujogui Jul 4, 2026

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


19 changes: 19 additions & 0 deletions
doc/api/sqlite.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -997,6 +997,15 @@ objects. If the prepared statement does not return any results, this method
returns an empty array. The prepared statement [parameters are bound][] using
the values in `namedParameters` and `anonymousParameters`.

### `statement.close()`

<!-- YAML
added: REPLACEME
-->

Finalizes the prepared statement. An exception is thrown if the statement is
already finalized. This method is a wrapper around [`sqlite3_finalize()`][].

### `statement.columns()`

<!-- YAML
Expand DownExpand Up@@ -1202,6 +1211,15 @@ added: v22.5.0
The source SQL text of the prepared statement. This property is a
wrapper around [`sqlite3_sql()`][].

### `statement[Symbol.dispose]()`

<!-- YAML
added: REPLACEME
-->

Finalizes the prepared statement. If the prepared statement is already
finalized, then this is a no-op.

## Class: `SQLTagStore`

<!-- YAML
Expand DownExpand Up@@ -1682,6 +1700,7 @@ callback function to indicate what type of operation is being authorized.
[`sqlite3_deserialize()`]: https://sqlite.org/c3ref/deserialize.html
[`sqlite3_exec()`]: https://www.sqlite.org/c3ref/exec.html
[`sqlite3_expanded_sql()`]: https://www.sqlite.org/c3ref/expanded_sql.html
[`sqlite3_finalize()`]: https://www.sqlite.org/c3ref/finalize.html
[`sqlite3_get_autocommit()`]: https://sqlite.org/c3ref/get_autocommit.html
[`sqlite3_last_insert_rowid()`]: https://www.sqlite.org/c3ref/last_insert_rowid.html
[`sqlite3_load_extension()`]: https://www.sqlite.org/c3ref/load_extension.html
Expand Down

26 changes: 22 additions & 4 deletions
src/node_sqlite.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1037,10 +1037,7 @@ void DatabaseSync::FinalizeStatements() {
}

void DatabaseSync::UntrackStatement(StatementSync* statement) {
 auto it = statements_.find(statement);
 if (it != statements_.end()) {
 statements_.erase(it);
 }
 statements_.erase(statement);
}

inline bool DatabaseSync::IsOpen() {
Expand DownExpand Up@@ -2578,6 +2575,10 @@ StatementSync::StatementSync(Environment* env,
}

StatementSync::~StatementSync() {
 Close();
}

void StatementSync::Close() {
 if (!IsFinalized()) {
 db_->UntrackStatement(this);
 Finalize();
Expand All@@ -2598,6 +2599,21 @@ inline bool StatementSync::IsFinalized() {
 return statement_ == nullptr;
}

void StatementSync::Close(const FunctionCallbackInfo<Value>& args) {
 StatementSync* stmt;
 ASSIGN_OR_RETURN_UNWRAP(&stmt, args.This());
 Environment* env = Environment::GetCurrent(args);
 THROW_AND_RETURN_ON_BAD_STATE(
 env, stmt->IsFinalized(), "statement has been finalized");
 stmt->Close();
}

void StatementSync::Dispose(const FunctionCallbackInfo<Value>& args) {
 StatementSync* stmt;
 ASSIGN_OR_RETURN_UNWRAP(&stmt, args.This());
 stmt->Close();
}

inline int StatementSync::ResetStatement() {
 reset_generation_++;
 return sqlite3_reset(statement_);
Expand DownExpand Up@@ -3629,6 +3645,8 @@ Local<FunctionTemplate> StatementSync::GetConstructorTemplate(
 isolate, tmpl, "setReadBigInts", StatementSync::SetReadBigInts);
 SetProtoMethod(
 isolate, tmpl, "setReturnArrays", StatementSync::SetReturnArrays);
 SetProtoMethod(isolate, tmpl, "close", StatementSync::Close);
 SetProtoDispose(isolate, tmpl, StatementSync::Dispose);
 env->set_sqlite_statement_sync_constructor_template(tmpl);
 }
 return tmpl;
Expand Down

3 changes: 3 additions & 0 deletions
src/node_sqlite.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -278,6 +278,8 @@ class StatementSync : public BaseObject {
 const v8::FunctionCallbackInfo<v8::Value>& args);
 static void SetReadBigInts(const v8::FunctionCallbackInfo<v8::Value>& args);
 static void SetReturnArrays(const v8::FunctionCallbackInfo<v8::Value>& args);
 static void Close(const v8::FunctionCallbackInfo<v8::Value>& args);
 static void Dispose(const v8::FunctionCallbackInfo<v8::Value>& args);
 v8::MaybeLocal<v8::Value> ColumnToValue(const int column);
 v8::MaybeLocal<v8::Name> ColumnNameToName(const int column);
 bool GetCachedColumnNames(v8::LocalVector<v8::Name>* keys);
Expand All@@ -289,6 +291,7 @@ class StatementSync : public BaseObject {

 private:
 ~StatementSync() override;
 void Close();
 BaseObjectPtr<DatabaseSync> db_;
 sqlite3_stmt* statement_;
 bool return_arrays_ = false;
Expand Down

16 changes: 16 additions & 0 deletions
test/parallel/test-sqlite-named-parameters.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -118,6 +118,22 @@ suite('StatementSync.prototype.setAllowUnknownNamedParameters()', () => {
 message: /The "enabled" argument must be a boolean/,
 });
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const setup = db.exec(
 'CREATE TABLE data(key INTEGER PRIMARY KEY, val INTEGER) STRICT;'
 );
 t.assert.strictEqual(setup, undefined);
 const stmt = db.prepare('INSERT INTO data (key, val) VALUES ($k, $v)');
 stmt.close();
 t.assert.throws(() => {
 stmt.setAllowUnknownNamedParameters(true);
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('options.allowUnknownNamedParameters', () => {
Expand Down

172 changes: 172 additions & 0 deletions
test/parallel/test-sqlite-statement-sync.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -76,6 +76,18 @@ suite('StatementSync.prototype.get()', () => {
 __proto__: null, key: 'key1', val: 'val1',
 });
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => {
 stmt.get();
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype.all()', () => {
Expand DownExpand Up@@ -129,6 +141,18 @@ suite('StatementSync.prototype.all()', () => {
 { __proto__: null, key: 'key1', val: 'val1' },
 ]);
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => {
 stmt.all();
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype.iterate()', () => {
Expand DownExpand Up@@ -295,6 +319,18 @@ suite('StatementSync.prototype.iterate()', () => {
 stmt2.get();
 it.next();
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => {
 stmt.iterate();
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype.run()', () => {
Expand DownExpand Up@@ -394,6 +430,18 @@ suite('StatementSync.prototype.run()', () => {
 const stmt = db.prepare('INSERT INTO data (key, val) VALUES (?1, ?2)');
 t.assert.deepStrictEqual(stmt.run(1, 2), { changes: 1, lastInsertRowid: 1 });
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => {
 stmt.run();
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype.sourceSQL', () => {
Expand All@@ -408,6 +456,16 @@ suite('StatementSync.prototype.sourceSQL', () => {
 const stmt = db.prepare(sql);
 t.assert.strictEqual(stmt.sourceSQL, sql);
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => stmt.sourceSQL, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype.expandedSQL', () => {
Expand All@@ -427,6 +485,16 @@ suite('StatementSync.prototype.expandedSQL', () => {
 );
 t.assert.strictEqual(stmt.expandedSQL, expanded);
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => stmt.expandedSQL, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype.setReadBigInts()', () => {
Expand DownExpand Up@@ -496,6 +564,18 @@ suite('StatementSync.prototype.setReadBigInts()', () => {
 [`${Number.MAX_SAFE_INTEGER} + 1`]: 2n ** 53n,
 });
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => {
 stmt.setReadBigInts(true);
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype.setReturnArrays()', () => {
Expand All@@ -514,6 +594,18 @@ suite('StatementSync.prototype.setReturnArrays()', () => {
 message: /The "returnArrays" argument must be a boolean/,
 });
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => {
 stmt.setReturnArrays(true);
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype.get() with array output', () => {
Expand DownExpand Up@@ -732,6 +824,18 @@ suite('StatementSync.prototype.setAllowBareNamedParameters()', () => {
 message: /The "allowBareNamedParameters" argument must be a boolean/,
 });
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => {
 stmt.setAllowBareNamedParameters(true);
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('options.readBigInts', () => {
Expand DownExpand Up@@ -978,3 +1082,71 @@ suite('options.allowBareNamedParameters', () => {
 );
 });
});


suite('StatementSync.prototype.close()', () => {
 test('finalizes an open statement', (t) => {
 using db = new DatabaseSync(':memory:');
 db.exec('CREATE TABLE storage(key TEXT, val TEXT)');
 const stmt = db.prepare('SELECT * FROM storage');
 t.assert.strictEqual(stmt.close(), undefined);
 t.assert.throws(() => stmt.get(), {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => {
 stmt.close();
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype[Symbol.dispose]()', () => {
 test('finalizes an open statement', (t) => {
 using db = new DatabaseSync(':memory:');
 db.exec('CREATE TABLE storage(key TEXT, val TEXT)');
 const stmt = db.prepare('SELECT * FROM storage');
 stmt[Symbol.dispose]();
 t.assert.throws(() => stmt.get(), {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });

 test('does not throw on an already-finalized statement', () => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt[Symbol.dispose]();
 stmt[Symbol.dispose]();
 });

 test('works with a using declaration', (t) => {
 using db = new DatabaseSync(':memory:');
 db.exec('CREATE TABLE storage(key TEXT, val TEXT)');
 let captured;
 {
 using stmt = db.prepare('SELECT * FROM storage');
 captured = stmt;
 t.assert.deepStrictEqual(stmt.all(), []);
 }
 t.assert.throws(() => captured.get(), {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });

 test('closing the database after dispose does not double-finalize', () => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt[Symbol.dispose]();
 db.close();
 });
});
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: add StatementSync.prototype.close() and [Symbol.dispose]()#64232

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

araujogui
wants to merge
4
commits into

from

 Closed


sqlite: add StatementSync.prototype.close() and [Symbol.dispose]()
#64232
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
5b64452

sqlite: add StatementSync.prototype[Symbol.dispose]()


araujogui Jul 1, 2026
9425bac

sqlite: simplify StatementSync dispose


araujogui Jul 3, 2026
9f6d4eb

sqlite: add StatementSync.prototype.close()


araujogui Jul 4, 2026
7144743

sqlite: remove unnecessary trycatch


araujogui Jul 4, 2026

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


19 changes: 19 additions & 0 deletions
doc/api/sqlite.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -997,6 +997,15 @@ objects. If the prepared statement does not return any results, this method
returns an empty array. The prepared statement [parameters are bound][] using
the values in `namedParameters` and `anonymousParameters`.

### `statement.close()`

<!-- YAML
added: REPLACEME
-->

Finalizes the prepared statement. An exception is thrown if the statement is
already finalized. This method is a wrapper around [`sqlite3_finalize()`][].

### `statement.columns()`

<!-- YAML
Expand DownExpand Up@@ -1202,6 +1211,15 @@ added: v22.5.0
The source SQL text of the prepared statement. This property is a
wrapper around [`sqlite3_sql()`][].

### `statement[Symbol.dispose]()`

<!-- YAML
added: REPLACEME
-->

Finalizes the prepared statement. If the prepared statement is already
finalized, then this is a no-op.

## Class: `SQLTagStore`

<!-- YAML
Expand DownExpand Up@@ -1682,6 +1700,7 @@ callback function to indicate what type of operation is being authorized.
[`sqlite3_deserialize()`]: https://sqlite.org/c3ref/deserialize.html
[`sqlite3_exec()`]: https://www.sqlite.org/c3ref/exec.html
[`sqlite3_expanded_sql()`]: https://www.sqlite.org/c3ref/expanded_sql.html
[`sqlite3_finalize()`]: https://www.sqlite.org/c3ref/finalize.html
[`sqlite3_get_autocommit()`]: https://sqlite.org/c3ref/get_autocommit.html
[`sqlite3_last_insert_rowid()`]: https://www.sqlite.org/c3ref/last_insert_rowid.html
[`sqlite3_load_extension()`]: https://www.sqlite.org/c3ref/load_extension.html
Expand Down

26 changes: 22 additions & 4 deletions
src/node_sqlite.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1037,10 +1037,7 @@ void DatabaseSync::FinalizeStatements() {
}

void DatabaseSync::UntrackStatement(StatementSync* statement) {
 auto it = statements_.find(statement);
 if (it != statements_.end()) {
 statements_.erase(it);
 }
 statements_.erase(statement);
}

inline bool DatabaseSync::IsOpen() {
Expand DownExpand Up@@ -2578,6 +2575,10 @@ StatementSync::StatementSync(Environment* env,
}

StatementSync::~StatementSync() {
 Close();
}

void StatementSync::Close() {
 if (!IsFinalized()) {
 db_->UntrackStatement(this);
 Finalize();
Expand All@@ -2598,6 +2599,21 @@ inline bool StatementSync::IsFinalized() {
 return statement_ == nullptr;
}

void StatementSync::Close(const FunctionCallbackInfo<Value>& args) {
 StatementSync* stmt;
 ASSIGN_OR_RETURN_UNWRAP(&stmt, args.This());
 Environment* env = Environment::GetCurrent(args);
 THROW_AND_RETURN_ON_BAD_STATE(
 env, stmt->IsFinalized(), "statement has been finalized");
 stmt->Close();
}

void StatementSync::Dispose(const FunctionCallbackInfo<Value>& args) {
 StatementSync* stmt;
 ASSIGN_OR_RETURN_UNWRAP(&stmt, args.This());
 stmt->Close();
}

inline int StatementSync::ResetStatement() {
 reset_generation_++;
 return sqlite3_reset(statement_);
Expand DownExpand Up@@ -3629,6 +3645,8 @@ Local<FunctionTemplate> StatementSync::GetConstructorTemplate(
 isolate, tmpl, "setReadBigInts", StatementSync::SetReadBigInts);
 SetProtoMethod(
 isolate, tmpl, "setReturnArrays", StatementSync::SetReturnArrays);
 SetProtoMethod(isolate, tmpl, "close", StatementSync::Close);
 SetProtoDispose(isolate, tmpl, StatementSync::Dispose);
 env->set_sqlite_statement_sync_constructor_template(tmpl);
 }
 return tmpl;
Expand Down

3 changes: 3 additions & 0 deletions
src/node_sqlite.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -278,6 +278,8 @@ class StatementSync : public BaseObject {
 const v8::FunctionCallbackInfo<v8::Value>& args);
 static void SetReadBigInts(const v8::FunctionCallbackInfo<v8::Value>& args);
 static void SetReturnArrays(const v8::FunctionCallbackInfo<v8::Value>& args);
 static void Close(const v8::FunctionCallbackInfo<v8::Value>& args);
 static void Dispose(const v8::FunctionCallbackInfo<v8::Value>& args);
 v8::MaybeLocal<v8::Value> ColumnToValue(const int column);
 v8::MaybeLocal<v8::Name> ColumnNameToName(const int column);
 bool GetCachedColumnNames(v8::LocalVector<v8::Name>* keys);
Expand All@@ -289,6 +291,7 @@ class StatementSync : public BaseObject {

 private:
 ~StatementSync() override;
 void Close();
 BaseObjectPtr<DatabaseSync> db_;
 sqlite3_stmt* statement_;
 bool return_arrays_ = false;
Expand Down

16 changes: 16 additions & 0 deletions
test/parallel/test-sqlite-named-parameters.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -118,6 +118,22 @@ suite('StatementSync.prototype.setAllowUnknownNamedParameters()', () => {
 message: /The "enabled" argument must be a boolean/,
 });
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const setup = db.exec(
 'CREATE TABLE data(key INTEGER PRIMARY KEY, val INTEGER) STRICT;'
 );
 t.assert.strictEqual(setup, undefined);
 const stmt = db.prepare('INSERT INTO data (key, val) VALUES ($k, $v)');
 stmt.close();
 t.assert.throws(() => {
 stmt.setAllowUnknownNamedParameters(true);
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('options.allowUnknownNamedParameters', () => {
Expand Down

172 changes: 172 additions & 0 deletions
test/parallel/test-sqlite-statement-sync.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -76,6 +76,18 @@ suite('StatementSync.prototype.get()', () => {
 __proto__: null, key: 'key1', val: 'val1',
 });
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => {
 stmt.get();
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype.all()', () => {
Expand DownExpand Up@@ -129,6 +141,18 @@ suite('StatementSync.prototype.all()', () => {
 { __proto__: null, key: 'key1', val: 'val1' },
 ]);
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => {
 stmt.all();
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype.iterate()', () => {
Expand DownExpand Up@@ -295,6 +319,18 @@ suite('StatementSync.prototype.iterate()', () => {
 stmt2.get();
 it.next();
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => {
 stmt.iterate();
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype.run()', () => {
Expand DownExpand Up@@ -394,6 +430,18 @@ suite('StatementSync.prototype.run()', () => {
 const stmt = db.prepare('INSERT INTO data (key, val) VALUES (?1, ?2)');
 t.assert.deepStrictEqual(stmt.run(1, 2), { changes: 1, lastInsertRowid: 1 });
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => {
 stmt.run();
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype.sourceSQL', () => {
Expand All@@ -408,6 +456,16 @@ suite('StatementSync.prototype.sourceSQL', () => {
 const stmt = db.prepare(sql);
 t.assert.strictEqual(stmt.sourceSQL, sql);
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => stmt.sourceSQL, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype.expandedSQL', () => {
Expand All@@ -427,6 +485,16 @@ suite('StatementSync.prototype.expandedSQL', () => {
 );
 t.assert.strictEqual(stmt.expandedSQL, expanded);
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => stmt.expandedSQL, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype.setReadBigInts()', () => {
Expand DownExpand Up@@ -496,6 +564,18 @@ suite('StatementSync.prototype.setReadBigInts()', () => {
 [`${Number.MAX_SAFE_INTEGER} + 1`]: 2n ** 53n,
 });
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => {
 stmt.setReadBigInts(true);
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype.setReturnArrays()', () => {
Expand All@@ -514,6 +594,18 @@ suite('StatementSync.prototype.setReturnArrays()', () => {
 message: /The "returnArrays" argument must be a boolean/,
 });
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => {
 stmt.setReturnArrays(true);
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype.get() with array output', () => {
Expand DownExpand Up@@ -732,6 +824,18 @@ suite('StatementSync.prototype.setAllowBareNamedParameters()', () => {
 message: /The "allowBareNamedParameters" argument must be a boolean/,
 });
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => {
 stmt.setAllowBareNamedParameters(true);
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('options.readBigInts', () => {
Expand DownExpand Up@@ -978,3 +1082,71 @@ suite('options.allowBareNamedParameters', () => {
 );
 });
});


suite('StatementSync.prototype.close()', () => {
 test('finalizes an open statement', (t) => {
 using db = new DatabaseSync(':memory:');
 db.exec('CREATE TABLE storage(key TEXT, val TEXT)');
 const stmt = db.prepare('SELECT * FROM storage');
 t.assert.strictEqual(stmt.close(), undefined);
 t.assert.throws(() => stmt.get(), {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => {
 stmt.close();
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype[Symbol.dispose]()', () => {
 test('finalizes an open statement', (t) => {
 using db = new DatabaseSync(':memory:');
 db.exec('CREATE TABLE storage(key TEXT, val TEXT)');
 const stmt = db.prepare('SELECT * FROM storage');
 stmt[Symbol.dispose]();
 t.assert.throws(() => stmt.get(), {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });

 test('does not throw on an already-finalized statement', () => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt[Symbol.dispose]();
 stmt[Symbol.dispose]();
 });

 test('works with a using declaration', (t) => {
 using db = new DatabaseSync(':memory:');
 db.exec('CREATE TABLE storage(key TEXT, val TEXT)');
 let captured;
 {
 using stmt = db.prepare('SELECT * FROM storage');
 captured = stmt;
 t.assert.deepStrictEqual(stmt.all(), []);
 }
 t.assert.throws(() => captured.get(), {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });

 test('closing the database after dispose does not double-finalize', () => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt[Symbol.dispose]();
 db.close();
 });
});
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: add StatementSync.prototype.close() and [Symbol.dispose]()#64232

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

araujogui
wants to merge
4
commits into

from

 Closed


sqlite: add StatementSync.prototype.close() and [Symbol.dispose]()
#64232
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
5b64452

sqlite: add StatementSync.prototype[Symbol.dispose]()


araujogui Jul 1, 2026
9425bac

sqlite: simplify StatementSync dispose


araujogui Jul 3, 2026
9f6d4eb

sqlite: add StatementSync.prototype.close()


araujogui Jul 4, 2026
7144743

sqlite: remove unnecessary trycatch


araujogui Jul 4, 2026

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


19 changes: 19 additions & 0 deletions
doc/api/sqlite.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -997,6 +997,15 @@ objects. If the prepared statement does not return any results, this method
returns an empty array. The prepared statement [parameters are bound][] using
the values in `namedParameters` and `anonymousParameters`.

### `statement.close()`

<!-- YAML
added: REPLACEME
-->

Finalizes the prepared statement. An exception is thrown if the statement is
already finalized. This method is a wrapper around [`sqlite3_finalize()`][].

### `statement.columns()`

<!-- YAML
Expand DownExpand Up@@ -1202,6 +1211,15 @@ added: v22.5.0
The source SQL text of the prepared statement. This property is a
wrapper around [`sqlite3_sql()`][].

### `statement[Symbol.dispose]()`

<!-- YAML
added: REPLACEME
-->

Finalizes the prepared statement. If the prepared statement is already
finalized, then this is a no-op.

## Class: `SQLTagStore`

<!-- YAML
Expand DownExpand Up@@ -1682,6 +1700,7 @@ callback function to indicate what type of operation is being authorized.
[`sqlite3_deserialize()`]: https://sqlite.org/c3ref/deserialize.html
[`sqlite3_exec()`]: https://www.sqlite.org/c3ref/exec.html
[`sqlite3_expanded_sql()`]: https://www.sqlite.org/c3ref/expanded_sql.html
[`sqlite3_finalize()`]: https://www.sqlite.org/c3ref/finalize.html
[`sqlite3_get_autocommit()`]: https://sqlite.org/c3ref/get_autocommit.html
[`sqlite3_last_insert_rowid()`]: https://www.sqlite.org/c3ref/last_insert_rowid.html
[`sqlite3_load_extension()`]: https://www.sqlite.org/c3ref/load_extension.html
Expand Down

26 changes: 22 additions & 4 deletions
src/node_sqlite.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1037,10 +1037,7 @@ void DatabaseSync::FinalizeStatements() {
}

void DatabaseSync::UntrackStatement(StatementSync* statement) {
 auto it = statements_.find(statement);
 if (it != statements_.end()) {
 statements_.erase(it);
 }
 statements_.erase(statement);
}

inline bool DatabaseSync::IsOpen() {
Expand DownExpand Up@@ -2578,6 +2575,10 @@ StatementSync::StatementSync(Environment* env,
}

StatementSync::~StatementSync() {
 Close();
}

void StatementSync::Close() {
 if (!IsFinalized()) {
 db_->UntrackStatement(this);
 Finalize();
Expand All@@ -2598,6 +2599,21 @@ inline bool StatementSync::IsFinalized() {
 return statement_ == nullptr;
}

void StatementSync::Close(const FunctionCallbackInfo<Value>& args) {
 StatementSync* stmt;
 ASSIGN_OR_RETURN_UNWRAP(&stmt, args.This());
 Environment* env = Environment::GetCurrent(args);
 THROW_AND_RETURN_ON_BAD_STATE(
 env, stmt->IsFinalized(), "statement has been finalized");
 stmt->Close();
}

void StatementSync::Dispose(const FunctionCallbackInfo<Value>& args) {
 StatementSync* stmt;
 ASSIGN_OR_RETURN_UNWRAP(&stmt, args.This());
 stmt->Close();
}

inline int StatementSync::ResetStatement() {
 reset_generation_++;
 return sqlite3_reset(statement_);
Expand DownExpand Up@@ -3629,6 +3645,8 @@ Local<FunctionTemplate> StatementSync::GetConstructorTemplate(
 isolate, tmpl, "setReadBigInts", StatementSync::SetReadBigInts);
 SetProtoMethod(
 isolate, tmpl, "setReturnArrays", StatementSync::SetReturnArrays);
 SetProtoMethod(isolate, tmpl, "close", StatementSync::Close);
 SetProtoDispose(isolate, tmpl, StatementSync::Dispose);
 env->set_sqlite_statement_sync_constructor_template(tmpl);
 }
 return tmpl;
Expand Down

3 changes: 3 additions & 0 deletions
src/node_sqlite.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -278,6 +278,8 @@ class StatementSync : public BaseObject {
 const v8::FunctionCallbackInfo<v8::Value>& args);
 static void SetReadBigInts(const v8::FunctionCallbackInfo<v8::Value>& args);
 static void SetReturnArrays(const v8::FunctionCallbackInfo<v8::Value>& args);
 static void Close(const v8::FunctionCallbackInfo<v8::Value>& args);
 static void Dispose(const v8::FunctionCallbackInfo<v8::Value>& args);
 v8::MaybeLocal<v8::Value> ColumnToValue(const int column);
 v8::MaybeLocal<v8::Name> ColumnNameToName(const int column);
 bool GetCachedColumnNames(v8::LocalVector<v8::Name>* keys);
Expand All@@ -289,6 +291,7 @@ class StatementSync : public BaseObject {

 private:
 ~StatementSync() override;
 void Close();
 BaseObjectPtr<DatabaseSync> db_;
 sqlite3_stmt* statement_;
 bool return_arrays_ = false;
Expand Down

16 changes: 16 additions & 0 deletions
test/parallel/test-sqlite-named-parameters.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -118,6 +118,22 @@ suite('StatementSync.prototype.setAllowUnknownNamedParameters()', () => {
 message: /The "enabled" argument must be a boolean/,
 });
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const setup = db.exec(
 'CREATE TABLE data(key INTEGER PRIMARY KEY, val INTEGER) STRICT;'
 );
 t.assert.strictEqual(setup, undefined);
 const stmt = db.prepare('INSERT INTO data (key, val) VALUES ($k, $v)');
 stmt.close();
 t.assert.throws(() => {
 stmt.setAllowUnknownNamedParameters(true);
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('options.allowUnknownNamedParameters', () => {
Expand Down

172 changes: 172 additions & 0 deletions
test/parallel/test-sqlite-statement-sync.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -76,6 +76,18 @@ suite('StatementSync.prototype.get()', () => {
 __proto__: null, key: 'key1', val: 'val1',
 });
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => {
 stmt.get();
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype.all()', () => {
Expand DownExpand Up@@ -129,6 +141,18 @@ suite('StatementSync.prototype.all()', () => {
 { __proto__: null, key: 'key1', val: 'val1' },
 ]);
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => {
 stmt.all();
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype.iterate()', () => {
Expand DownExpand Up@@ -295,6 +319,18 @@ suite('StatementSync.prototype.iterate()', () => {
 stmt2.get();
 it.next();
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => {
 stmt.iterate();
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype.run()', () => {
Expand DownExpand Up@@ -394,6 +430,18 @@ suite('StatementSync.prototype.run()', () => {
 const stmt = db.prepare('INSERT INTO data (key, val) VALUES (?1, ?2)');
 t.assert.deepStrictEqual(stmt.run(1, 2), { changes: 1, lastInsertRowid: 1 });
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => {
 stmt.run();
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype.sourceSQL', () => {
Expand All@@ -408,6 +456,16 @@ suite('StatementSync.prototype.sourceSQL', () => {
 const stmt = db.prepare(sql);
 t.assert.strictEqual(stmt.sourceSQL, sql);
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => stmt.sourceSQL, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype.expandedSQL', () => {
Expand All@@ -427,6 +485,16 @@ suite('StatementSync.prototype.expandedSQL', () => {
 );
 t.assert.strictEqual(stmt.expandedSQL, expanded);
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => stmt.expandedSQL, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype.setReadBigInts()', () => {
Expand DownExpand Up@@ -496,6 +564,18 @@ suite('StatementSync.prototype.setReadBigInts()', () => {
 [`${Number.MAX_SAFE_INTEGER} + 1`]: 2n ** 53n,
 });
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => {
 stmt.setReadBigInts(true);
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype.setReturnArrays()', () => {
Expand All@@ -514,6 +594,18 @@ suite('StatementSync.prototype.setReturnArrays()', () => {
 message: /The "returnArrays" argument must be a boolean/,
 });
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => {
 stmt.setReturnArrays(true);
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype.get() with array output', () => {
Expand DownExpand Up@@ -732,6 +824,18 @@ suite('StatementSync.prototype.setAllowBareNamedParameters()', () => {
 message: /The "allowBareNamedParameters" argument must be a boolean/,
 });
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => {
 stmt.setAllowBareNamedParameters(true);
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('options.readBigInts', () => {
Expand DownExpand Up@@ -978,3 +1082,71 @@ suite('options.allowBareNamedParameters', () => {
 );
 });
});


suite('StatementSync.prototype.close()', () => {
 test('finalizes an open statement', (t) => {
 using db = new DatabaseSync(':memory:');
 db.exec('CREATE TABLE storage(key TEXT, val TEXT)');
 const stmt = db.prepare('SELECT * FROM storage');
 t.assert.strictEqual(stmt.close(), undefined);
 t.assert.throws(() => stmt.get(), {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => {
 stmt.close();
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype[Symbol.dispose]()', () => {
 test('finalizes an open statement', (t) => {
 using db = new DatabaseSync(':memory:');
 db.exec('CREATE TABLE storage(key TEXT, val TEXT)');
 const stmt = db.prepare('SELECT * FROM storage');
 stmt[Symbol.dispose]();
 t.assert.throws(() => stmt.get(), {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });

 test('does not throw on an already-finalized statement', () => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt[Symbol.dispose]();
 stmt[Symbol.dispose]();
 });

 test('works with a using declaration', (t) => {
 using db = new DatabaseSync(':memory:');
 db.exec('CREATE TABLE storage(key TEXT, val TEXT)');
 let captured;
 {
 using stmt = db.prepare('SELECT * FROM storage');
 captured = stmt;
 t.assert.deepStrictEqual(stmt.all(), []);
 }
 t.assert.throws(() => captured.get(), {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });

 test('closing the database after dispose does not double-finalize', () => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt[Symbol.dispose]();
 db.close();
 });
});
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: add StatementSync.prototype.close() and [Symbol.dispose]()#64232

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

araujogui
wants to merge
4
commits into

from

 Closed


sqlite: add StatementSync.prototype.close() and [Symbol.dispose]()
#64232
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
5b64452

sqlite: add StatementSync.prototype[Symbol.dispose]()


araujogui Jul 1, 2026
9425bac

sqlite: simplify StatementSync dispose


araujogui Jul 3, 2026
9f6d4eb

sqlite: add StatementSync.prototype.close()


araujogui Jul 4, 2026
7144743

sqlite: remove unnecessary trycatch


araujogui Jul 4, 2026

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


19 changes: 19 additions & 0 deletions
doc/api/sqlite.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -997,6 +997,15 @@ objects. If the prepared statement does not return any results, this method
returns an empty array. The prepared statement [parameters are bound][] using
the values in `namedParameters` and `anonymousParameters`.

### `statement.close()`

<!-- YAML
added: REPLACEME
-->

Finalizes the prepared statement. An exception is thrown if the statement is
already finalized. This method is a wrapper around [`sqlite3_finalize()`][].

### `statement.columns()`

<!-- YAML
Expand DownExpand Up@@ -1202,6 +1211,15 @@ added: v22.5.0
The source SQL text of the prepared statement. This property is a
wrapper around [`sqlite3_sql()`][].

### `statement[Symbol.dispose]()`

<!-- YAML
added: REPLACEME
-->

Finalizes the prepared statement. If the prepared statement is already
finalized, then this is a no-op.

## Class: `SQLTagStore`

<!-- YAML
Expand DownExpand Up@@ -1682,6 +1700,7 @@ callback function to indicate what type of operation is being authorized.
[`sqlite3_deserialize()`]: https://sqlite.org/c3ref/deserialize.html
[`sqlite3_exec()`]: https://www.sqlite.org/c3ref/exec.html
[`sqlite3_expanded_sql()`]: https://www.sqlite.org/c3ref/expanded_sql.html
[`sqlite3_finalize()`]: https://www.sqlite.org/c3ref/finalize.html
[`sqlite3_get_autocommit()`]: https://sqlite.org/c3ref/get_autocommit.html
[`sqlite3_last_insert_rowid()`]: https://www.sqlite.org/c3ref/last_insert_rowid.html
[`sqlite3_load_extension()`]: https://www.sqlite.org/c3ref/load_extension.html
Expand Down

26 changes: 22 additions & 4 deletions
src/node_sqlite.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1037,10 +1037,7 @@ void DatabaseSync::FinalizeStatements() {
}

void DatabaseSync::UntrackStatement(StatementSync* statement) {
 auto it = statements_.find(statement);
 if (it != statements_.end()) {
 statements_.erase(it);
 }
 statements_.erase(statement);
}

inline bool DatabaseSync::IsOpen() {
Expand DownExpand Up@@ -2578,6 +2575,10 @@ StatementSync::StatementSync(Environment* env,
}

StatementSync::~StatementSync() {
 Close();
}

void StatementSync::Close() {
 if (!IsFinalized()) {
 db_->UntrackStatement(this);
 Finalize();
Expand All@@ -2598,6 +2599,21 @@ inline bool StatementSync::IsFinalized() {
 return statement_ == nullptr;
}

void StatementSync::Close(const FunctionCallbackInfo<Value>& args) {
 StatementSync* stmt;
 ASSIGN_OR_RETURN_UNWRAP(&stmt, args.This());
 Environment* env = Environment::GetCurrent(args);
 THROW_AND_RETURN_ON_BAD_STATE(
 env, stmt->IsFinalized(), "statement has been finalized");
 stmt->Close();
}

void StatementSync::Dispose(const FunctionCallbackInfo<Value>& args) {
 StatementSync* stmt;
 ASSIGN_OR_RETURN_UNWRAP(&stmt, args.This());
 stmt->Close();
}

inline int StatementSync::ResetStatement() {
 reset_generation_++;
 return sqlite3_reset(statement_);
Expand DownExpand Up@@ -3629,6 +3645,8 @@ Local<FunctionTemplate> StatementSync::GetConstructorTemplate(
 isolate, tmpl, "setReadBigInts", StatementSync::SetReadBigInts);
 SetProtoMethod(
 isolate, tmpl, "setReturnArrays", StatementSync::SetReturnArrays);
 SetProtoMethod(isolate, tmpl, "close", StatementSync::Close);
 SetProtoDispose(isolate, tmpl, StatementSync::Dispose);
 env->set_sqlite_statement_sync_constructor_template(tmpl);
 }
 return tmpl;
Expand Down

3 changes: 3 additions & 0 deletions
src/node_sqlite.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -278,6 +278,8 @@ class StatementSync : public BaseObject {
 const v8::FunctionCallbackInfo<v8::Value>& args);
 static void SetReadBigInts(const v8::FunctionCallbackInfo<v8::Value>& args);
 static void SetReturnArrays(const v8::FunctionCallbackInfo<v8::Value>& args);
 static void Close(const v8::FunctionCallbackInfo<v8::Value>& args);
 static void Dispose(const v8::FunctionCallbackInfo<v8::Value>& args);
 v8::MaybeLocal<v8::Value> ColumnToValue(const int column);
 v8::MaybeLocal<v8::Name> ColumnNameToName(const int column);
 bool GetCachedColumnNames(v8::LocalVector<v8::Name>* keys);
Expand All@@ -289,6 +291,7 @@ class StatementSync : public BaseObject {

 private:
 ~StatementSync() override;
 void Close();
 BaseObjectPtr<DatabaseSync> db_;
 sqlite3_stmt* statement_;
 bool return_arrays_ = false;
Expand Down

16 changes: 16 additions & 0 deletions
test/parallel/test-sqlite-named-parameters.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -118,6 +118,22 @@ suite('StatementSync.prototype.setAllowUnknownNamedParameters()', () => {
 message: /The "enabled" argument must be a boolean/,
 });
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const setup = db.exec(
 'CREATE TABLE data(key INTEGER PRIMARY KEY, val INTEGER) STRICT;'
 );
 t.assert.strictEqual(setup, undefined);
 const stmt = db.prepare('INSERT INTO data (key, val) VALUES ($k, $v)');
 stmt.close();
 t.assert.throws(() => {
 stmt.setAllowUnknownNamedParameters(true);
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('options.allowUnknownNamedParameters', () => {
Expand Down

172 changes: 172 additions & 0 deletions
test/parallel/test-sqlite-statement-sync.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -76,6 +76,18 @@ suite('StatementSync.prototype.get()', () => {
 __proto__: null, key: 'key1', val: 'val1',
 });
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => {
 stmt.get();
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype.all()', () => {
Expand DownExpand Up@@ -129,6 +141,18 @@ suite('StatementSync.prototype.all()', () => {
 { __proto__: null, key: 'key1', val: 'val1' },
 ]);
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => {
 stmt.all();
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype.iterate()', () => {
Expand DownExpand Up@@ -295,6 +319,18 @@ suite('StatementSync.prototype.iterate()', () => {
 stmt2.get();
 it.next();
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => {
 stmt.iterate();
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype.run()', () => {
Expand DownExpand Up@@ -394,6 +430,18 @@ suite('StatementSync.prototype.run()', () => {
 const stmt = db.prepare('INSERT INTO data (key, val) VALUES (?1, ?2)');
 t.assert.deepStrictEqual(stmt.run(1, 2), { changes: 1, lastInsertRowid: 1 });
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => {
 stmt.run();
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype.sourceSQL', () => {
Expand All@@ -408,6 +456,16 @@ suite('StatementSync.prototype.sourceSQL', () => {
 const stmt = db.prepare(sql);
 t.assert.strictEqual(stmt.sourceSQL, sql);
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => stmt.sourceSQL, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype.expandedSQL', () => {
Expand All@@ -427,6 +485,16 @@ suite('StatementSync.prototype.expandedSQL', () => {
 );
 t.assert.strictEqual(stmt.expandedSQL, expanded);
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => stmt.expandedSQL, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype.setReadBigInts()', () => {
Expand DownExpand Up@@ -496,6 +564,18 @@ suite('StatementSync.prototype.setReadBigInts()', () => {
 [`${Number.MAX_SAFE_INTEGER} + 1`]: 2n ** 53n,
 });
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => {
 stmt.setReadBigInts(true);
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype.setReturnArrays()', () => {
Expand All@@ -514,6 +594,18 @@ suite('StatementSync.prototype.setReturnArrays()', () => {
 message: /The "returnArrays" argument must be a boolean/,
 });
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => {
 stmt.setReturnArrays(true);
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype.get() with array output', () => {
Expand DownExpand Up@@ -732,6 +824,18 @@ suite('StatementSync.prototype.setAllowBareNamedParameters()', () => {
 message: /The "allowBareNamedParameters" argument must be a boolean/,
 });
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => {
 stmt.setAllowBareNamedParameters(true);
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('options.readBigInts', () => {
Expand DownExpand Up@@ -978,3 +1082,71 @@ suite('options.allowBareNamedParameters', () => {
 );
 });
});


suite('StatementSync.prototype.close()', () => {
 test('finalizes an open statement', (t) => {
 using db = new DatabaseSync(':memory:');
 db.exec('CREATE TABLE storage(key TEXT, val TEXT)');
 const stmt = db.prepare('SELECT * FROM storage');
 t.assert.strictEqual(stmt.close(), undefined);
 t.assert.throws(() => stmt.get(), {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => {
 stmt.close();
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype[Symbol.dispose]()', () => {
 test('finalizes an open statement', (t) => {
 using db = new DatabaseSync(':memory:');
 db.exec('CREATE TABLE storage(key TEXT, val TEXT)');
 const stmt = db.prepare('SELECT * FROM storage');
 stmt[Symbol.dispose]();
 t.assert.throws(() => stmt.get(), {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });

 test('does not throw on an already-finalized statement', () => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt[Symbol.dispose]();
 stmt[Symbol.dispose]();
 });

 test('works with a using declaration', (t) => {
 using db = new DatabaseSync(':memory:');
 db.exec('CREATE TABLE storage(key TEXT, val TEXT)');
 let captured;
 {
 using stmt = db.prepare('SELECT * FROM storage');
 captured = stmt;
 t.assert.deepStrictEqual(stmt.all(), []);
 }
 t.assert.throws(() => captured.get(), {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });

 test('closing the database after dispose does not double-finalize', () => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt[Symbol.dispose]();
 db.close();
 });
});
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: add StatementSync.prototype.close() and [Symbol.dispose]()#64232

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

araujogui
wants to merge
4
commits into

from

 Closed


sqlite: add StatementSync.prototype.close() and [Symbol.dispose]()
#64232
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
5b64452

sqlite: add StatementSync.prototype[Symbol.dispose]()


araujogui Jul 1, 2026
9425bac

sqlite: simplify StatementSync dispose


araujogui Jul 3, 2026
9f6d4eb

sqlite: add StatementSync.prototype.close()


araujogui Jul 4, 2026
7144743

sqlite: remove unnecessary trycatch


araujogui Jul 4, 2026

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


19 changes: 19 additions & 0 deletions
doc/api/sqlite.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -997,6 +997,15 @@ objects. If the prepared statement does not return any results, this method
returns an empty array. The prepared statement [parameters are bound][] using
the values in `namedParameters` and `anonymousParameters`.

### `statement.close()`

<!-- YAML
added: REPLACEME
-->

Finalizes the prepared statement. An exception is thrown if the statement is
already finalized. This method is a wrapper around [`sqlite3_finalize()`][].

### `statement.columns()`

<!-- YAML
Expand DownExpand Up@@ -1202,6 +1211,15 @@ added: v22.5.0
The source SQL text of the prepared statement. This property is a
wrapper around [`sqlite3_sql()`][].

### `statement[Symbol.dispose]()`

<!-- YAML
added: REPLACEME
-->

Finalizes the prepared statement. If the prepared statement is already
finalized, then this is a no-op.

## Class: `SQLTagStore`

<!-- YAML
Expand DownExpand Up@@ -1682,6 +1700,7 @@ callback function to indicate what type of operation is being authorized.
[`sqlite3_deserialize()`]: https://sqlite.org/c3ref/deserialize.html
[`sqlite3_exec()`]: https://www.sqlite.org/c3ref/exec.html
[`sqlite3_expanded_sql()`]: https://www.sqlite.org/c3ref/expanded_sql.html
[`sqlite3_finalize()`]: https://www.sqlite.org/c3ref/finalize.html
[`sqlite3_get_autocommit()`]: https://sqlite.org/c3ref/get_autocommit.html
[`sqlite3_last_insert_rowid()`]: https://www.sqlite.org/c3ref/last_insert_rowid.html
[`sqlite3_load_extension()`]: https://www.sqlite.org/c3ref/load_extension.html
Expand Down

26 changes: 22 additions & 4 deletions
src/node_sqlite.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1037,10 +1037,7 @@ void DatabaseSync::FinalizeStatements() {
}

void DatabaseSync::UntrackStatement(StatementSync* statement) {
 auto it = statements_.find(statement);
 if (it != statements_.end()) {
 statements_.erase(it);
 }
 statements_.erase(statement);
}

inline bool DatabaseSync::IsOpen() {
Expand DownExpand Up@@ -2578,6 +2575,10 @@ StatementSync::StatementSync(Environment* env,
}

StatementSync::~StatementSync() {
 Close();
}

void StatementSync::Close() {
 if (!IsFinalized()) {
 db_->UntrackStatement(this);
 Finalize();
Expand All@@ -2598,6 +2599,21 @@ inline bool StatementSync::IsFinalized() {
 return statement_ == nullptr;
}

void StatementSync::Close(const FunctionCallbackInfo<Value>& args) {
 StatementSync* stmt;
 ASSIGN_OR_RETURN_UNWRAP(&stmt, args.This());
 Environment* env = Environment::GetCurrent(args);
 THROW_AND_RETURN_ON_BAD_STATE(
 env, stmt->IsFinalized(), "statement has been finalized");
 stmt->Close();
}

void StatementSync::Dispose(const FunctionCallbackInfo<Value>& args) {
 StatementSync* stmt;
 ASSIGN_OR_RETURN_UNWRAP(&stmt, args.This());
 stmt->Close();
}

inline int StatementSync::ResetStatement() {
 reset_generation_++;
 return sqlite3_reset(statement_);
Expand DownExpand Up@@ -3629,6 +3645,8 @@ Local<FunctionTemplate> StatementSync::GetConstructorTemplate(
 isolate, tmpl, "setReadBigInts", StatementSync::SetReadBigInts);
 SetProtoMethod(
 isolate, tmpl, "setReturnArrays", StatementSync::SetReturnArrays);
 SetProtoMethod(isolate, tmpl, "close", StatementSync::Close);
 SetProtoDispose(isolate, tmpl, StatementSync::Dispose);
 env->set_sqlite_statement_sync_constructor_template(tmpl);
 }
 return tmpl;
Expand Down

3 changes: 3 additions & 0 deletions
src/node_sqlite.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -278,6 +278,8 @@ class StatementSync : public BaseObject {
 const v8::FunctionCallbackInfo<v8::Value>& args);
 static void SetReadBigInts(const v8::FunctionCallbackInfo<v8::Value>& args);
 static void SetReturnArrays(const v8::FunctionCallbackInfo<v8::Value>& args);
 static void Close(const v8::FunctionCallbackInfo<v8::Value>& args);
 static void Dispose(const v8::FunctionCallbackInfo<v8::Value>& args);
 v8::MaybeLocal<v8::Value> ColumnToValue(const int column);
 v8::MaybeLocal<v8::Name> ColumnNameToName(const int column);
 bool GetCachedColumnNames(v8::LocalVector<v8::Name>* keys);
Expand All@@ -289,6 +291,7 @@ class StatementSync : public BaseObject {

 private:
 ~StatementSync() override;
 void Close();
 BaseObjectPtr<DatabaseSync> db_;
 sqlite3_stmt* statement_;
 bool return_arrays_ = false;
Expand Down

16 changes: 16 additions & 0 deletions
test/parallel/test-sqlite-named-parameters.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -118,6 +118,22 @@ suite('StatementSync.prototype.setAllowUnknownNamedParameters()', () => {
 message: /The "enabled" argument must be a boolean/,
 });
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const setup = db.exec(
 'CREATE TABLE data(key INTEGER PRIMARY KEY, val INTEGER) STRICT;'
 );
 t.assert.strictEqual(setup, undefined);
 const stmt = db.prepare('INSERT INTO data (key, val) VALUES ($k, $v)');
 stmt.close();
 t.assert.throws(() => {
 stmt.setAllowUnknownNamedParameters(true);
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('options.allowUnknownNamedParameters', () => {
Expand Down

172 changes: 172 additions & 0 deletions
test/parallel/test-sqlite-statement-sync.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -76,6 +76,18 @@ suite('StatementSync.prototype.get()', () => {
 __proto__: null, key: 'key1', val: 'val1',
 });
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => {
 stmt.get();
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype.all()', () => {
Expand DownExpand Up@@ -129,6 +141,18 @@ suite('StatementSync.prototype.all()', () => {
 { __proto__: null, key: 'key1', val: 'val1' },
 ]);
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => {
 stmt.all();
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype.iterate()', () => {
Expand DownExpand Up@@ -295,6 +319,18 @@ suite('StatementSync.prototype.iterate()', () => {
 stmt2.get();
 it.next();
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => {
 stmt.iterate();
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype.run()', () => {
Expand DownExpand Up@@ -394,6 +430,18 @@ suite('StatementSync.prototype.run()', () => {
 const stmt = db.prepare('INSERT INTO data (key, val) VALUES (?1, ?2)');
 t.assert.deepStrictEqual(stmt.run(1, 2), { changes: 1, lastInsertRowid: 1 });
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => {
 stmt.run();
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype.sourceSQL', () => {
Expand All@@ -408,6 +456,16 @@ suite('StatementSync.prototype.sourceSQL', () => {
 const stmt = db.prepare(sql);
 t.assert.strictEqual(stmt.sourceSQL, sql);
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => stmt.sourceSQL, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype.expandedSQL', () => {
Expand All@@ -427,6 +485,16 @@ suite('StatementSync.prototype.expandedSQL', () => {
 );
 t.assert.strictEqual(stmt.expandedSQL, expanded);
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => stmt.expandedSQL, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype.setReadBigInts()', () => {
Expand DownExpand Up@@ -496,6 +564,18 @@ suite('StatementSync.prototype.setReadBigInts()', () => {
 [`${Number.MAX_SAFE_INTEGER} + 1`]: 2n ** 53n,
 });
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => {
 stmt.setReadBigInts(true);
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype.setReturnArrays()', () => {
Expand All@@ -514,6 +594,18 @@ suite('StatementSync.prototype.setReturnArrays()', () => {
 message: /The "returnArrays" argument must be a boolean/,
 });
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => {
 stmt.setReturnArrays(true);
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype.get() with array output', () => {
Expand DownExpand Up@@ -732,6 +824,18 @@ suite('StatementSync.prototype.setAllowBareNamedParameters()', () => {
 message: /The "allowBareNamedParameters" argument must be a boolean/,
 });
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => {
 stmt.setAllowBareNamedParameters(true);
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('options.readBigInts', () => {
Expand DownExpand Up@@ -978,3 +1082,71 @@ suite('options.allowBareNamedParameters', () => {
 );
 });
});


suite('StatementSync.prototype.close()', () => {
 test('finalizes an open statement', (t) => {
 using db = new DatabaseSync(':memory:');
 db.exec('CREATE TABLE storage(key TEXT, val TEXT)');
 const stmt = db.prepare('SELECT * FROM storage');
 t.assert.strictEqual(stmt.close(), undefined);
 t.assert.throws(() => stmt.get(), {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => {
 stmt.close();
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype[Symbol.dispose]()', () => {
 test('finalizes an open statement', (t) => {
 using db = new DatabaseSync(':memory:');
 db.exec('CREATE TABLE storage(key TEXT, val TEXT)');
 const stmt = db.prepare('SELECT * FROM storage');
 stmt[Symbol.dispose]();
 t.assert.throws(() => stmt.get(), {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });

 test('does not throw on an already-finalized statement', () => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt[Symbol.dispose]();
 stmt[Symbol.dispose]();
 });

 test('works with a using declaration', (t) => {
 using db = new DatabaseSync(':memory:');
 db.exec('CREATE TABLE storage(key TEXT, val TEXT)');
 let captured;
 {
 using stmt = db.prepare('SELECT * FROM storage');
 captured = stmt;
 t.assert.deepStrictEqual(stmt.all(), []);
 }
 t.assert.throws(() => captured.get(), {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });

 test('closing the database after dispose does not double-finalize', () => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt[Symbol.dispose]();
 db.close();
 });
});
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: add StatementSync.prototype.close() and [Symbol.dispose]()#64232

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

araujogui
wants to merge
4
commits into

from

 Closed


sqlite: add StatementSync.prototype.close() and [Symbol.dispose]()
#64232
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
5b64452

sqlite: add StatementSync.prototype[Symbol.dispose]()


araujogui Jul 1, 2026
9425bac

sqlite: simplify StatementSync dispose


araujogui Jul 3, 2026
9f6d4eb

sqlite: add StatementSync.prototype.close()


araujogui Jul 4, 2026
7144743

sqlite: remove unnecessary trycatch


araujogui Jul 4, 2026

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


19 changes: 19 additions & 0 deletions
doc/api/sqlite.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -997,6 +997,15 @@ objects. If the prepared statement does not return any results, this method
returns an empty array. The prepared statement [parameters are bound][] using
the values in `namedParameters` and `anonymousParameters`.

### `statement.close()`

<!-- YAML
added: REPLACEME
-->

Finalizes the prepared statement. An exception is thrown if the statement is
already finalized. This method is a wrapper around [`sqlite3_finalize()`][].

### `statement.columns()`

<!-- YAML
Expand DownExpand Up@@ -1202,6 +1211,15 @@ added: v22.5.0
The source SQL text of the prepared statement. This property is a
wrapper around [`sqlite3_sql()`][].

### `statement[Symbol.dispose]()`

<!-- YAML
added: REPLACEME
-->

Finalizes the prepared statement. If the prepared statement is already
finalized, then this is a no-op.

## Class: `SQLTagStore`

<!-- YAML
Expand DownExpand Up@@ -1682,6 +1700,7 @@ callback function to indicate what type of operation is being authorized.
[`sqlite3_deserialize()`]: https://sqlite.org/c3ref/deserialize.html
[`sqlite3_exec()`]: https://www.sqlite.org/c3ref/exec.html
[`sqlite3_expanded_sql()`]: https://www.sqlite.org/c3ref/expanded_sql.html
[`sqlite3_finalize()`]: https://www.sqlite.org/c3ref/finalize.html
[`sqlite3_get_autocommit()`]: https://sqlite.org/c3ref/get_autocommit.html
[`sqlite3_last_insert_rowid()`]: https://www.sqlite.org/c3ref/last_insert_rowid.html
[`sqlite3_load_extension()`]: https://www.sqlite.org/c3ref/load_extension.html
Expand Down

26 changes: 22 additions & 4 deletions
src/node_sqlite.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1037,10 +1037,7 @@ void DatabaseSync::FinalizeStatements() {
}

void DatabaseSync::UntrackStatement(StatementSync* statement) {
 auto it = statements_.find(statement);
 if (it != statements_.end()) {
 statements_.erase(it);
 }
 statements_.erase(statement);
}

inline bool DatabaseSync::IsOpen() {
Expand DownExpand Up@@ -2578,6 +2575,10 @@ StatementSync::StatementSync(Environment* env,
}

StatementSync::~StatementSync() {
 Close();
}

void StatementSync::Close() {
 if (!IsFinalized()) {
 db_->UntrackStatement(this);
 Finalize();
Expand All@@ -2598,6 +2599,21 @@ inline bool StatementSync::IsFinalized() {
 return statement_ == nullptr;
}

void StatementSync::Close(const FunctionCallbackInfo<Value>& args) {
 StatementSync* stmt;
 ASSIGN_OR_RETURN_UNWRAP(&stmt, args.This());
 Environment* env = Environment::GetCurrent(args);
 THROW_AND_RETURN_ON_BAD_STATE(
 env, stmt->IsFinalized(), "statement has been finalized");
 stmt->Close();
}

void StatementSync::Dispose(const FunctionCallbackInfo<Value>& args) {
 StatementSync* stmt;
 ASSIGN_OR_RETURN_UNWRAP(&stmt, args.This());
 stmt->Close();
}

inline int StatementSync::ResetStatement() {
 reset_generation_++;
 return sqlite3_reset(statement_);
Expand DownExpand Up@@ -3629,6 +3645,8 @@ Local<FunctionTemplate> StatementSync::GetConstructorTemplate(
 isolate, tmpl, "setReadBigInts", StatementSync::SetReadBigInts);
 SetProtoMethod(
 isolate, tmpl, "setReturnArrays", StatementSync::SetReturnArrays);
 SetProtoMethod(isolate, tmpl, "close", StatementSync::Close);
 SetProtoDispose(isolate, tmpl, StatementSync::Dispose);
 env->set_sqlite_statement_sync_constructor_template(tmpl);
 }
 return tmpl;
Expand Down

3 changes: 3 additions & 0 deletions
src/node_sqlite.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -278,6 +278,8 @@ class StatementSync : public BaseObject {
 const v8::FunctionCallbackInfo<v8::Value>& args);
 static void SetReadBigInts(const v8::FunctionCallbackInfo<v8::Value>& args);
 static void SetReturnArrays(const v8::FunctionCallbackInfo<v8::Value>& args);
 static void Close(const v8::FunctionCallbackInfo<v8::Value>& args);
 static void Dispose(const v8::FunctionCallbackInfo<v8::Value>& args);
 v8::MaybeLocal<v8::Value> ColumnToValue(const int column);
 v8::MaybeLocal<v8::Name> ColumnNameToName(const int column);
 bool GetCachedColumnNames(v8::LocalVector<v8::Name>* keys);
Expand All@@ -289,6 +291,7 @@ class StatementSync : public BaseObject {

 private:
 ~StatementSync() override;
 void Close();
 BaseObjectPtr<DatabaseSync> db_;
 sqlite3_stmt* statement_;
 bool return_arrays_ = false;
Expand Down

16 changes: 16 additions & 0 deletions
test/parallel/test-sqlite-named-parameters.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -118,6 +118,22 @@ suite('StatementSync.prototype.setAllowUnknownNamedParameters()', () => {
 message: /The "enabled" argument must be a boolean/,
 });
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const setup = db.exec(
 'CREATE TABLE data(key INTEGER PRIMARY KEY, val INTEGER) STRICT;'
 );
 t.assert.strictEqual(setup, undefined);
 const stmt = db.prepare('INSERT INTO data (key, val) VALUES ($k, $v)');
 stmt.close();
 t.assert.throws(() => {
 stmt.setAllowUnknownNamedParameters(true);
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('options.allowUnknownNamedParameters', () => {
Expand Down

172 changes: 172 additions & 0 deletions
test/parallel/test-sqlite-statement-sync.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -76,6 +76,18 @@ suite('StatementSync.prototype.get()', () => {
 __proto__: null, key: 'key1', val: 'val1',
 });
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => {
 stmt.get();
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype.all()', () => {
Expand DownExpand Up@@ -129,6 +141,18 @@ suite('StatementSync.prototype.all()', () => {
 { __proto__: null, key: 'key1', val: 'val1' },
 ]);
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => {
 stmt.all();
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype.iterate()', () => {
Expand DownExpand Up@@ -295,6 +319,18 @@ suite('StatementSync.prototype.iterate()', () => {
 stmt2.get();
 it.next();
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => {
 stmt.iterate();
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype.run()', () => {
Expand DownExpand Up@@ -394,6 +430,18 @@ suite('StatementSync.prototype.run()', () => {
 const stmt = db.prepare('INSERT INTO data (key, val) VALUES (?1, ?2)');
 t.assert.deepStrictEqual(stmt.run(1, 2), { changes: 1, lastInsertRowid: 1 });
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => {
 stmt.run();
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype.sourceSQL', () => {
Expand All@@ -408,6 +456,16 @@ suite('StatementSync.prototype.sourceSQL', () => {
 const stmt = db.prepare(sql);
 t.assert.strictEqual(stmt.sourceSQL, sql);
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => stmt.sourceSQL, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype.expandedSQL', () => {
Expand All@@ -427,6 +485,16 @@ suite('StatementSync.prototype.expandedSQL', () => {
 );
 t.assert.strictEqual(stmt.expandedSQL, expanded);
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => stmt.expandedSQL, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype.setReadBigInts()', () => {
Expand DownExpand Up@@ -496,6 +564,18 @@ suite('StatementSync.prototype.setReadBigInts()', () => {
 [`${Number.MAX_SAFE_INTEGER} + 1`]: 2n ** 53n,
 });
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => {
 stmt.setReadBigInts(true);
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype.setReturnArrays()', () => {
Expand All@@ -514,6 +594,18 @@ suite('StatementSync.prototype.setReturnArrays()', () => {
 message: /The "returnArrays" argument must be a boolean/,
 });
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => {
 stmt.setReturnArrays(true);
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype.get() with array output', () => {
Expand DownExpand Up@@ -732,6 +824,18 @@ suite('StatementSync.prototype.setAllowBareNamedParameters()', () => {
 message: /The "allowBareNamedParameters" argument must be a boolean/,
 });
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => {
 stmt.setAllowBareNamedParameters(true);
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('options.readBigInts', () => {
Expand DownExpand Up@@ -978,3 +1082,71 @@ suite('options.allowBareNamedParameters', () => {
 );
 });
});


suite('StatementSync.prototype.close()', () => {
 test('finalizes an open statement', (t) => {
 using db = new DatabaseSync(':memory:');
 db.exec('CREATE TABLE storage(key TEXT, val TEXT)');
 const stmt = db.prepare('SELECT * FROM storage');
 t.assert.strictEqual(stmt.close(), undefined);
 t.assert.throws(() => stmt.get(), {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });

 test('throws if the statement is already finalized', (t) => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt.close();
 t.assert.throws(() => {
 stmt.close();
 }, {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });
});

suite('StatementSync.prototype[Symbol.dispose]()', () => {
 test('finalizes an open statement', (t) => {
 using db = new DatabaseSync(':memory:');
 db.exec('CREATE TABLE storage(key TEXT, val TEXT)');
 const stmt = db.prepare('SELECT * FROM storage');
 stmt[Symbol.dispose]();
 t.assert.throws(() => stmt.get(), {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });

 test('does not throw on an already-finalized statement', () => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt[Symbol.dispose]();
 stmt[Symbol.dispose]();
 });

 test('works with a using declaration', (t) => {
 using db = new DatabaseSync(':memory:');
 db.exec('CREATE TABLE storage(key TEXT, val TEXT)');
 let captured;
 {
 using stmt = db.prepare('SELECT * FROM storage');
 captured = stmt;
 t.assert.deepStrictEqual(stmt.all(), []);
 }
 t.assert.throws(() => captured.get(), {
 code: 'ERR_INVALID_STATE',
 message: /statement has been finalized/,
 });
 });

 test('closing the database after dispose does not double-finalize', () => {
 using db = new DatabaseSync(':memory:');
 const stmt = db.prepare('CREATE TABLE storage(key TEXT, val TEXT)');
 stmt[Symbol.dispose]();
 db.close();
 });
});
Loading