Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions doc/api/sqlite.md
Original file line number Diff line number Diff line change
Expand Up @@ -690,10 +690,14 @@ changes:
database options or `true`.
* `allowUnknownNamedParameters` {boolean} If `true`, unknown named parameters
are ignored. **Default:** inherited from database options or `false`.
* `persistent` {boolean} If `true`, hints to SQLite that this statement will

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Please add a history entry for this new public option; otherwise the docs imply it has been available since v22.5.0.

 changes:
   - version: REPLACEME
     pr-url: https://github.com/nodejs/node/pull/65157
     description: Throw `ERR_INVALID_ARG_VALUE` if `sql` contains no statements.
+  - version: REPLACEME
+    pr-url: https://github.com/nodejs/node/pull/62757
+    description: Add the `persistent` option.

be reused many times, causing it to use a different memory allocation
strategy that reduces heap fragmentation. Corresponds to the
[`SQLITE_PREPARE_PERSISTENT`][] flag. **Default:** `false`.
Comment on lines +693 to +696

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

SQLite does not guarantee reduced heap fragmentation; its documented current behavior is to avoid depleting lookaside memory.

Suggested change
* `persistent` {boolean} If `true`, hints to SQLite that this statement will
be reused many times, causing it to use a different memory allocation
strategy that reduces heap fragmentation. Corresponds to the
[`SQLITE_PREPARE_PERSISTENT`][] flag. **Default:** `false`.
* `persistent` {boolean} If `true`, hints to SQLite that this statement will
be retained for a long time and likely reused many times. SQLite currently
responds to this hint by avoiding lookaside memory. Corresponds to the
[`SQLITE_PREPARE_PERSISTENT`][] flag. **Default:** `false`.

* Returns: {StatementSync} The prepared statement.

Compiles a SQL statement into a [prepared statement][]. This method is a wrapper
around [`sqlite3_prepare_v2()`][].
around [`sqlite3_prepare_v3()`][].

### `database.createTagStore([maxSize])`

Expand Down Expand Up @@ -1860,6 +1864,7 @@ callback function to indicate what type of operation is being authorized.
[`SQLITE_DETERMINISTIC`]: https://www.sqlite.org/c3ref/c_deterministic.html
[`SQLITE_DIRECTONLY`]: https://www.sqlite.org/c3ref/c_deterministic.html
[`SQLITE_MAX_FUNCTION_ARG`]: https://www.sqlite.org/limits.html#max_function_arg
[`SQLITE_PREPARE_PERSISTENT`]: https://sqlite.org/c3ref/c_prepare_dont_log.html#sqlitepreparepersistent
[`SQLTagStore`]: #class-sqltagstore
[`database.applyChangeset()`]: #databaseapplychangesetchangeset-options
[`database.createTagStore()`]: #databasecreatetagstoremaxsize
Expand All @@ -1885,7 +1890,7 @@ callback function to indicate what type of operation is being authorized.
[`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
[`sqlite3_prepare_v2()`]: https://www.sqlite.org/c3ref/prepare.html
[`sqlite3_prepare_v3()`]: https://www.sqlite.org/c3ref/prepare.html
[`sqlite3_serialize()`]: https://sqlite.org/c3ref/serialize.html
[`sqlite3_set_authorizer()`]: https://sqlite.org/c3ref/set_authorizer.html
[`sqlite3_sql()`]: https://www.sqlite.org/c3ref/expanded_sql.html
Expand Down
34 changes: 31 additions & 3 deletions src/node_sqlite.cc
Original file line number Diff line number Diff line change
Expand Up @@ -1510,6 +1510,7 @@ void DatabaseSync::Prepare(const FunctionCallbackInfo<Value>& args) {
std::optional<bool> use_big_ints;
std::optional<bool> allow_bare_named_params;
std::optional<bool> allow_unknown_named_params;
std::optional<bool> persistent;

if (args.Length() > 1 && !args[1]->IsUndefined()) {
if (!args[1]->IsObject()) {
Expand Down Expand Up @@ -1590,11 +1591,34 @@ void DatabaseSync::Prepare(const FunctionCallbackInfo<Value>& args) {
}
allow_unknown_named_params = allow_unknown_named_params_v->IsTrue();
}

Local<Value> persistent_v;
if (!options
->Get(env->context(),
FIXED_ONE_BYTE_STRING(env->isolate(), "persistent"))
.ToLocal(&persistent_v)) {
return;
}
if (!persistent_v->IsUndefined()) {
if (!persistent_v->IsBoolean()) {
THROW_ERR_INVALID_ARG_TYPE(
env->isolate(),
"The \"options.persistent\" argument must be a boolean.");
return;
}
persistent = persistent_v->IsTrue();
}
}

Utf8Value sql(env->isolate(), args[0].As<String>());
sqlite3_stmt* s = nullptr;
int r = sqlite3_prepare_v2(db->connection_, *sql, -1, &s, nullptr);

unsigned int prep_flags =
persistent.value_or(false) ? SQLITE_PREPARE_PERSISTENT : 0;

int r =
sqlite3_prepare_v3(db->connection_, *sql, -1, prep_flags, &s, nullptr);

StatementPtr stmt_ptr(s);

CHECK_ERROR_OR_THROW(env->isolate(), db, r, SQLITE_OK, void());
Expand Down Expand Up @@ -3766,8 +3790,12 @@ BaseObjectPtr<StatementSync> SQLTagStore::PrepareStatement(

if (stmt == nullptr) {
sqlite3_stmt* s = nullptr;
int r = sqlite3_prepare_v2(
session->database_->connection_, sql.data(), sql.size(), &s, nullptr);
int r = sqlite3_prepare_v3(session->database_->connection_,
sql.data(),
sql.size(),
SQLITE_PREPARE_PERSISTENT,
&s,
nullptr);
StatementPtr stmt_ptr(s);

if (r != SQLITE_OK) {
Expand Down
Loading
Loading