@rocicorp/zero-sqlite3 1.0.7 → 1.0.9

package/lib/index.d.ts

@@ -5,6 +5,17 @@ type VariableArgFunction = (...params: any[]) => unknown;
 type ArgumentTypes<F extends VariableArgFunction> = F extends (...args: infer A) => unknown ? A : never;
 type ElementOf<T> = T extends Array<infer E> ? E : T;
 
+declare const enum ScanStatOpcode {
+    SQLITE_SCANSTAT_NLOOP = 0,
+    SQLITE_SCANSTAT_NVISIT = 1,
+    SQLITE_SCANSTAT_EST = 2,
+    SQLITE_SCANSTAT_NAME = 3,
+    SQLITE_SCANSTAT_EXPLAIN = 4,
+    SQLITE_SCANSTAT_SELECTID = 5,
+    SQLITE_SCANSTAT_PARENTID = 6,
+    SQLITE_SCANSTAT_NCYCLE = 7,
+}
+
 declare namespace BetterSqlite3 {
     interface Statement<BindParameters extends unknown[], Result = unknown> {
         database: Database;
@@ -23,6 +34,15 @@ declare namespace BetterSqlite3 {
         bind(...params: BindParameters): this;
         columns(): ColumnDefinition[];
         safeIntegers(toggleState?: boolean): this;
+        scanStatusV2(idx: number, opcode: ScanStatOpcode.SQLITE_SCANSTAT_NAME, resetFlag: number): string | undefined;
+        scanStatusV2(idx: number, opcode: ScanStatOpcode.SQLITE_SCANSTAT_EXPLAIN, resetFlag: number): string | undefined;
+        scanStatusV2(idx: number, opcode: ScanStatOpcode.SQLITE_SCANSTAT_NLOOP, resetFlag: number): number | undefined;
+        scanStatusV2(idx: number, opcode: ScanStatOpcode.SQLITE_SCANSTAT_NVISIT, resetFlag: number): number | undefined;
+        scanStatusV2(idx: number, opcode: ScanStatOpcode.SQLITE_SCANSTAT_EST, resetFlag: number): number | undefined;
+        scanStatusV2(idx: number, opcode: ScanStatOpcode.SQLITE_SCANSTAT_SELECTID, resetFlag: number): number | undefined;
+        scanStatusV2(idx: number, opcode: ScanStatOpcode.SQLITE_SCANSTAT_PARENTID, resetFlag: number): number | undefined;
+        scanStatusV2(idx: number, opcode: ScanStatOpcode.SQLITE_SCANSTAT_NCYCLE, resetFlag: number): number | undefined;
+        scanStatusV2(idx: number, opcode: ScanStatOpcode, resetFlag: number): number | string | undefined;
     }
 
     interface ColumnDefinition {
@@ -89,6 +109,16 @@ declare namespace BetterSqlite3 {
         prototype: Database;
 
         SqliteError: typeof SqliteError;
+
+        // scanstatus constants
+        SQLITE_SCANSTAT_NLOOP: ScanStatOpcode.SQLITE_SCANSTAT_NLOOP;
+        SQLITE_SCANSTAT_NVISIT: ScanStatOpcode.SQLITE_SCANSTAT_NVISIT;
+        SQLITE_SCANSTAT_EST: ScanStatOpcode.SQLITE_SCANSTAT_EST;
+        SQLITE_SCANSTAT_NAME: ScanStatOpcode.SQLITE_SCANSTAT_NAME;
+        SQLITE_SCANSTAT_EXPLAIN: ScanStatOpcode.SQLITE_SCANSTAT_EXPLAIN;
+        SQLITE_SCANSTAT_SELECTID: ScanStatOpcode.SQLITE_SCANSTAT_SELECTID;
+        SQLITE_SCANSTAT_PARENTID: ScanStatOpcode.SQLITE_SCANSTAT_PARENTID;
+        SQLITE_SCANSTAT_NCYCLE: ScanStatOpcode.SQLITE_SCANSTAT_NCYCLE;
     }
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rocicorp/zero-sqlite3",
-  "version": "1.0.7",
+  "version": "1.0.9",
   "description": "better-sqlite3 on bedrock",
   "homepage": "https://github.com/rocicorp/zero-sqlite3",
   "author": "Rocicorp",
@@ -24,6 +24,11 @@
     "bindings": "^1.5.0",
     "prebuild-install": "^7.1.1"
   },
+  "overrides": {
+    "prebuild": {
+      "node-abi": "4.11.0"
+    }
+  },
   "devDependencies": {
     "chai": "^4.3.8",
     "cli-color": "^2.0.3",

package/src/better_sqlite3.cpp

@@ -73,6 +73,17 @@ NODE_MODULE_INIT(/* exports, context */) {
 	exports->Set(context, InternalizedFromLatin1(isolate, "Backup"), Backup::Init(isolate, data)).FromJust();
 	exports->Set(context, InternalizedFromLatin1(isolate, "setErrorConstructor"), v8::FunctionTemplate::New(isolate, Addon::JS_setErrorConstructor, data)->GetFunction(context).ToLocalChecked()).FromJust();
 
+	// Export SQLITE_SCANSTAT_* constants
+	exports->Set(context, InternalizedFromLatin1(isolate, "SQLITE_SCANSTAT_NLOOP"), v8::Int32::New(isolate, SQLITE_SCANSTAT_NLOOP)).FromJust();
+	exports->Set(context, InternalizedFromLatin1(isolate, "SQLITE_SCANSTAT_NVISIT"), v8::Int32::New(isolate, SQLITE_SCANSTAT_NVISIT)).FromJust();
+	exports->Set(context, InternalizedFromLatin1(isolate, "SQLITE_SCANSTAT_EST"), v8::Int32::New(isolate, SQLITE_SCANSTAT_EST)).FromJust();
+	exports->Set(context, InternalizedFromLatin1(isolate, "SQLITE_SCANSTAT_NAME"), v8::Int32::New(isolate, SQLITE_SCANSTAT_NAME)).FromJust();
+	exports->Set(context, InternalizedFromLatin1(isolate, "SQLITE_SCANSTAT_EXPLAIN"), v8::Int32::New(isolate, SQLITE_SCANSTAT_EXPLAIN)).FromJust();
+	exports->Set(context, InternalizedFromLatin1(isolate, "SQLITE_SCANSTAT_SELECTID"), v8::Int32::New(isolate, SQLITE_SCANSTAT_SELECTID)).FromJust();
+	exports->Set(context, InternalizedFromLatin1(isolate, "SQLITE_SCANSTAT_PARENTID"), v8::Int32::New(isolate, SQLITE_SCANSTAT_PARENTID)).FromJust();
+	exports->Set(context, InternalizedFromLatin1(isolate, "SQLITE_SCANSTAT_NCYCLE"), v8::Int32::New(isolate, SQLITE_SCANSTAT_NCYCLE)).FromJust();
+	exports->Set(context, InternalizedFromLatin1(isolate, "SQLITE_SCANSTAT_COMPLEX"), v8::Int32::New(isolate, SQLITE_SCANSTAT_COMPLEX)).FromJust();
+
 	// Store addon instance data.
 	addon->Statement.Reset(isolate, exports->Get(context, InternalizedFromLatin1(isolate, "Statement")).ToLocalChecked().As<v8::Function>());
 	addon->StatementIterator.Reset(isolate, exports->Get(context, InternalizedFromLatin1(isolate, "StatementIterator")).ToLocalChecked().As<v8::Function>());
@@ -773,6 +784,7 @@ v8::Local <v8 :: Function> Statement::Init (v8::Isolate * isolate, v8::Local <v8
                 SetPrototypeMethod(isolate, data, t, "raw", JS_raw);
                 SetPrototypeMethod(isolate, data, t, "safeIntegers", JS_safeIntegers);
                 SetPrototypeMethod(isolate, data, t, "columns", JS_columns);
+                SetPrototypeMethod(isolate, data, t, "scanStatusV2", JS_scanStatusV2);
                 SetPrototypeGetter(isolate, data, t, "busy", JS_busy);
                 return t->GetFunction( isolate -> GetCurrentContext ( ) ).ToLocalChecked();
 }
@@ -1083,9 +1095,59 @@ void Statement::JS_columns (v8::FunctionCallbackInfo <v8 :: Value> const & info)
 
                 info.GetReturnValue().Set(columns);
 }
-#line 321 "./src/objects/statement.lzz"
+#line 322 "./src/objects/statement.lzz"
+void Statement::JS_scanStatusV2 (v8::FunctionCallbackInfo <v8 :: Value> const & info)
+#line 322 "./src/objects/statement.lzz"
+                                                     {
+                Statement* stmt = node :: ObjectWrap :: Unwrap <Statement>(info.This());
+                if (!stmt->db->GetState()->open) return ThrowTypeError("The database connection is not open");
+                if (!stmt->alive) return ThrowTypeError("The statement has been finalized and can no longer be used");
+
+                int idx; if (info.Length() < (0 + 1) || !info[0]->IsInt32()) return ThrowTypeError("Expected " "first" " argument to be " "a 32-bit signed integer"); idx = (info[0].As<v8::Int32>()->Value());;
+                int iScanStatusOp; if (info.Length() < (1 + 1) || !info[1]->IsInt32()) return ThrowTypeError("Expected " "second" " argument to be " "a 32-bit signed integer"); iScanStatusOp = (info[1].As<v8::Int32>()->Value());;
+                int flags; if (info.Length() < (2 + 1) || !info[2]->IsInt32()) return ThrowTypeError("Expected " "third" " argument to be " "a 32-bit signed integer"); flags = (info[2].As<v8::Int32>()->Value());;
+
+                v8::Isolate* isolate = info.GetIsolate();;
+
+                // Based on iScanStatusOp, we know what type of output to expect
+                int rc;
+                if (iScanStatusOp == 0 || iScanStatusOp == 1 || iScanStatusOp == 5 || iScanStatusOp == 6 || iScanStatusOp == 7) {
+                        // NLOOP, NVISIT, SELECTID, PARENTID, NCYCLE - return sqlite3_int64
+                        sqlite3_int64 iOut;
+                        rc = sqlite3_stmt_scanstatus_v2(stmt->handle, idx, iScanStatusOp, flags, (void*)&iOut);
+                        if (rc == 0) {
+                                info.GetReturnValue().Set(stmt->safe_ints
+                                        ? v8::BigInt::New(isolate, iOut).As<v8::Value>()
+                                        : v8::Number::New(isolate, (double)iOut).As<v8::Value>());
+                                return;
+                        }
+                } else if (iScanStatusOp == 2) {
+                        // EST - return double
+                        double dOut;
+                        rc = sqlite3_stmt_scanstatus_v2(stmt->handle, idx, iScanStatusOp, flags, (void*)&dOut);
+                        if (rc == 0) {
+                                info.GetReturnValue().Set(v8::Number::New(isolate, dOut));
+                                return;
+                        }
+                } else if (iScanStatusOp == 3 || iScanStatusOp == 4) {
+                        // NAME, EXPLAIN - return const char*
+                        const char* zOut;
+                        rc = sqlite3_stmt_scanstatus_v2(stmt->handle, idx, iScanStatusOp, flags, (void*)&zOut);
+                        if (rc == 0 && zOut != NULL) {
+                                info.GetReturnValue().Set(StringFromUtf8(isolate, zOut, -1));
+                                return;
+                        } else if (rc == 0) {
+                                info.GetReturnValue().Set(v8::Null(isolate));
+                                return;
+                        }
+                }
+
+                // Error or invalid operation - return undefined
+                info.GetReturnValue().Set(v8::Undefined(isolate));
+}
+#line 370 "./src/objects/statement.lzz"
 void Statement::JS_busy (v8::Local <v8 :: Name> _, v8::PropertyCallbackInfo <v8 :: Value> const & info)
-#line 321 "./src/objects/statement.lzz"
+#line 370 "./src/objects/statement.lzz"
                              {
                 Statement* stmt = node :: ObjectWrap :: Unwrap <Statement>(info.This());
                 info.GetReturnValue().Set(stmt->alive && stmt->locked);

package/src/better_sqlite3.hpp

@@ -362,7 +362,9 @@ private:
   static void JS_safeIntegers (v8::FunctionCallbackInfo <v8 :: Value> const & info);
 #line 278 "./src/objects/statement.lzz"
   static void JS_columns (v8::FunctionCallbackInfo <v8 :: Value> const & info);
-#line 321 "./src/objects/statement.lzz"
+#line 322 "./src/objects/statement.lzz"
+  static void JS_scanStatusV2 (v8::FunctionCallbackInfo <v8 :: Value> const & info);
+#line 370 "./src/objects/statement.lzz"
   static void JS_busy (v8::Local <v8 :: Name> _, v8::PropertyCallbackInfo <v8 :: Value> const & info);
 #line 326 "./src/objects/statement.lzz"
   Database * const db;