sqlite: rename verbose to trace

Author: araujogui

doc/api/sqlite.md

@@ -132,7 +132,7 @@ added: v22.5.0
 changes:
   - version: REPLACEME
     pr-url: https://github.com/nodejs/node/pull/62241
-    description: Add `verbose` option.
+    description: Add `trace` option.
   - version:
      - v25.5.0
      - v24.14.0
@@ -206,7 +206,7 @@ changes:
     * `likePatternLength` {number} Maximum length of a LIKE pattern.
     * `variableNumber` {number} Maximum number of SQL variables.
     * `triggerDepth` {number} Maximum trigger recursion depth.
-  * `verbose` {Function} An optional callback function that is invoked for
+  * `trace` {Function} An optional callback function that is invoked for
     every SQL statement executed against the database. The callback receives
     the expanded SQL string (with bound parameter values substituted) as its
     only argument. If expansion fails, the source SQL (with unsubstituted
@@ -1662,8 +1662,8 @@ callback function to indicate what type of operation is being authorized.
 [`sqlite3_prepare_v2()`]: 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_trace_v2()`]: https://www.sqlite.org/c3ref/trace_v2.html
 [`sqlite3_sql()`]: https://www.sqlite.org/c3ref/expanded_sql.html
+[`sqlite3_trace_v2()`]: https://www.sqlite.org/c3ref/trace_v2.html
 [`sqlite3changeset_apply()`]: https://www.sqlite.org/session/sqlite3changeset_apply.html
 [`sqlite3session_attach()`]: https://www.sqlite.org/session/sqlite3session_attach.html
 [`sqlite3session_changeset()`]: https://www.sqlite.org/session/sqlite3session_changeset.html

src/env_properties.h

@@ -376,7 +376,7 @@
   V(url_string, "url")                                                         \
   V(username_string, "username")                                               \
   V(value_string, "value")                                                     \
-  V(verbose_string, "verbose")                                                 \
+  V(trace_string, "trace")                                                     \
   V(verify_error_string, "verifyError")                                        \
   V(version_string, "version")                                                 \
   V(windows_hide_string, "windowsHide")                                        \

src/node_sqlite.cc

@@ -995,7 +995,7 @@ bool DatabaseSync::Open() {
 
   {
     Local<Value> cb =
-        object()->GetInternalField(kVerboseCallback).template As<Value>();
+        object()->GetInternalField(kTraceCallback).template As<Value>();
     if (cb->IsFunction()) {
       sqlite3_trace_v2(
           connection_, SQLITE_TRACE_STMT, DatabaseSync::TraceCallback, this);
@@ -1368,21 +1368,19 @@ void DatabaseSync::New(const FunctionCallbackInfo<Value>& args) {
       }
     }
 
-    // Parse verbose option
-    Local<Value> verbose_v;
-    if (!options->Get(env->context(), env->verbose_string())
-             .ToLocal(&verbose_v)) {
+    // Parse trace option
+    Local<Value> trace_v;
+    if (!options->Get(env->context(), env->trace_string()).ToLocal(&trace_v)) {
       return;
     }
-    if (!verbose_v->IsUndefined() && !verbose_v->IsNull()) {
-      if (!verbose_v->IsFunction()) {
+    if (!trace_v->IsUndefined() && !trace_v->IsNull()) {
+      if (!trace_v->IsFunction()) {
         THROW_ERR_INVALID_ARG_TYPE(
             env->isolate(),
-            "The \"options.verbose\" argument must be a function.");
+            "The \"options.trace\" argument must be a function.");
         return;
       }
-      args.This()->SetInternalField(kVerboseCallback,
-                                    verbose_v.As<Function>());
+      args.This()->SetInternalField(kTraceCallback, trace_v.As<Function>());
     }
   }
 
@@ -2581,7 +2579,7 @@ int DatabaseSync::TraceCallback(unsigned int type,
   Local<Context> context = env->context();
 
   Local<Value> cb =
-      db->object()->GetInternalField(kVerboseCallback).template As<Value>();
+      db->object()->GetInternalField(kTraceCallback).template As<Value>();
 
   if (!cb->IsFunction()) {
     return 0;

src/node_sqlite.h

@@ -166,7 +166,7 @@ class DatabaseSync : public BaseObject {
   enum InternalFields {
     kAuthorizerCallback = BaseObject::kInternalFieldCount,
     kLimitsObject,
-    kVerboseCallback,
+    kTraceCallback,
     kInternalFieldCount
   };
 

test/parallel/test-sqlite-verbose.js test/parallel/test-sqlite-trace.jstest/parallel/test-sqlite-verbose.js renamed to test/parallel/test-sqlite-trace.js

@@ -7,11 +7,11 @@ const assert = require('node:assert');
 const { DatabaseSync } = require('node:sqlite');
 const { suite, it } = require('node:test');
 
-suite('DatabaseSync verbose option', () => {
+suite('DatabaseSync trace option', () => {
   it('callback receives SQL string for exec() statements', (t) => {
     const calls = [];
     const db = new DatabaseSync(':memory:', {
-      verbose: (sql) => calls.push(sql),
+      trace: (sql) => calls.push(sql),
     });
 
     db.exec('CREATE TABLE t (x INTEGER)');
@@ -26,7 +26,7 @@ suite('DatabaseSync verbose option', () => {
   it('callback receives SQL string for prepared statement execution', (t) => {
     let calls = [];
     const db = new DatabaseSync(':memory:', {
-      verbose: (sql) => calls.push(sql),
+      trace: (sql) => calls.push(sql),
     });
 
     db.exec('CREATE TABLE t (x INTEGER)');
@@ -43,7 +43,7 @@ suite('DatabaseSync verbose option', () => {
   it('callback receives SQL string for SELECT statements', () => {
     let calls = [];
     const db = new DatabaseSync(':memory:', {
-      verbose: (sql) => calls.push(sql),
+      trace: (sql) => calls.push(sql),
     });
 
     db.exec('CREATE TABLE t (x INTEGER)');
@@ -61,7 +61,7 @@ suite('DatabaseSync verbose option', () => {
   it('callback receives SQL string for UPDATE statements', () => {
     let calls = [];
     const db = new DatabaseSync(':memory:', {
-      verbose: (sql) => calls.push(sql),
+      trace: (sql) => calls.push(sql),
     });
 
     db.exec('CREATE TABLE t (x INTEGER)');
@@ -79,7 +79,7 @@ suite('DatabaseSync verbose option', () => {
   it('callback receives SQL string for DELETE statements', () => {
     let calls = [];
     const db = new DatabaseSync(':memory:', {
-      verbose: (sql) => calls.push(sql),
+      trace: (sql) => calls.push(sql),
     });
 
     db.exec('CREATE TABLE t (x INTEGER)');
@@ -98,7 +98,7 @@ suite('DatabaseSync verbose option', () => {
     let calls = [];
 
     const db = new DatabaseSync(':memory:', {
-      verbose: (sql) => calls.push(sql),
+      trace: (sql) => calls.push(sql),
       limits: { length: 1000 },
     });
 
@@ -116,19 +116,19 @@ suite('DatabaseSync verbose option', () => {
     db.close();
   });
 
-  it('invalid type for verbose throws ERR_INVALID_ARG_TYPE', () => {
+  it('invalid type for trace throws ERR_INVALID_ARG_TYPE', () => {
     assert.throws(() => {
-      new DatabaseSync(':memory:', { verbose: 'not-a-function' });
+      new DatabaseSync(':memory:', { trace: 'not-a-function' });
     }, {
       code: 'ERR_INVALID_ARG_TYPE',
-      message: /The "options\.verbose" argument must be a function\./,
+      message: /The "options\.trace" argument must be a function\./,
     });
 
     assert.throws(() => {
-      new DatabaseSync(':memory:', { verbose: 42 });
+      new DatabaseSync(':memory:', { trace: 42 });
     }, {
       code: 'ERR_INVALID_ARG_TYPE',
-      message: /The "options\.verbose" argument must be a function\./,
+      message: /The "options\.trace" argument must be a function\./,
     });
   });
 });