@op-engineering/op-sqlite 2.0.2 → 2.0.4

package/README.md

@@ -22,7 +22,7 @@ You can find the [benchmarking code in the example app](https://github.com/OP-En
 
 Memory consumption is also 1/4 compared to `react-native-quick-sqlite`. This query used to take 1.2 GB of peak memory usage, and now runs in 250mbs.
 
-You can also turn on Memory Mapping to make your queries even faster by skipping the kernel during I/O, this comes with some disadvantages though. If you want even more speed and you can re-use your queries you can use prepared statements.
+You can also turn on [Memory Mapping](#speed) to make your queries even faster by skipping the kernel during I/O and potentially reduce RAM usage, this comes with some disadvantages though. If you want even more speed and you can re-use your queries you can use [Prepared Statements](#prepared-statements).
 
 # Encryption
 
@@ -115,10 +115,14 @@ const db = open({
   name: 'mydb.sqlite',
 });
 
-// 0 turns of memory mapping, any other number enables it with the cache size
+// 0 turns off memory mapping, any other number enables it with the cache size
 db.execute('PRAGMA mmap_size=268435456');
 ```
 
+If you use prepared statements plus memory mapping, you can get to inches of MMKV for the most performance critical queries, here is a simple example writing/reading a single value.
+
+![mmkv comparison](mmkv.png)
+
 # API
 
 ```typescript

package/cpp/bindings.cpp

@@ -53,12 +53,12 @@ void install(jsi::Runtime &rt,
 
   auto open = HOSTFN("open", 3) {
     if (count == 0) {
-      throw jsi::JSError(rt, "[op-sqlite][open] database name is required");
+      throw std::runtime_error("[op-sqlite][open] database name is required");
     }
 
     if (!args[0].isString()) {
-      throw jsi::JSError(rt,
-                         "[op-sqlite][open] database name must be a string");
+      throw std::runtime_error(
+          "[op-sqlite][open] database name must be a string");
     }
 
     std::string dbName = args[0].asString(rt).utf8(rt);
@@ -66,8 +66,8 @@ void install(jsi::Runtime &rt,
 
     if (count > 1 && !args[1].isUndefined() && !args[1].isNull()) {
       if (!args[1].isString()) {
-        throw jsi::JSError(
-            rt, "[op-sqlite][open] database location must be a string");
+        throw std::runtime_error(
+            "[op-sqlite][open] database location must be a string");
       }
 
       std::string lastPath = args[1].asString(rt).utf8(rt);
@@ -84,7 +84,7 @@ void install(jsi::Runtime &rt,
     BridgeResult result = sqliteOpenDb(dbName, path);
 
     if (result.type == SQLiteError) {
-      throw jsi::JSError(rt, result.message.c_str());
+      throw std::runtime_error(result.message);
     }
 
     return {};
@@ -104,8 +104,8 @@ void install(jsi::Runtime &rt,
     std::string tempDocPath = std::string(basePath);
     if (count > 3 && !args[3].isUndefined() && !args[3].isNull()) {
       if (!args[3].isString()) {
-        throw jsi::JSError(
-            rt, "[op-sqlite][attach] database location must be a string");
+        throw std::runtime_error(
+            "[op-sqlite][attach] database location must be a string");
       }
 
       tempDocPath = tempDocPath + "/" + args[3].asString(rt).utf8(rt);
@@ -118,7 +118,7 @@ void install(jsi::Runtime &rt,
         sqliteAttachDb(dbName, tempDocPath, databaseToAttach, alias);
 
     if (result.type == SQLiteError) {
-      throw jsi::JSError(rt, result.message.c_str());
+      throw std::runtime_error(result.message);
     }
 
     return {};
@@ -126,12 +126,12 @@ void install(jsi::Runtime &rt,
 
   auto detach = HOSTFN("detach", 2) {
     if (count < 2) {
-      throw jsi::JSError(rt,
-                         "[op-sqlite][detach] Incorrect number of arguments");
+      throw std::runtime_error(
+          "[op-sqlite][detach] Incorrect number of arguments");
     }
     if (!args[0].isString() || !args[1].isString()) {
-      throw jsi::JSError(
-          rt, "dbName, databaseToAttach and alias must be a strings");
+      throw std::runtime_error(
+          "dbName, databaseToAttach and alias must be a strings");
       return {};
     }
 
@@ -148,12 +148,12 @@ void install(jsi::Runtime &rt,
 
   auto close = HOSTFN("close", 1) {
     if (count == 0) {
-      throw jsi::JSError(rt, "[op-sqlite][close] database name is required");
+      throw std::runtime_error("[op-sqlite][close] database name is required");
     }
 
     if (!args[0].isString()) {
-      throw jsi::JSError(rt,
-                         "[op-sqlite][close] database name must be a string");
+      throw std::runtime_error(
+          "[op-sqlite][close] database name must be a string");
     }
 
     std::string dbName = args[0].asString(rt).utf8(rt);
@@ -169,12 +169,12 @@ void install(jsi::Runtime &rt,
 
   auto remove = HOSTFN("delete", 2) {
     if (count == 0) {
-      throw jsi::JSError(rt, "[op-sqlite][open] database name is required");
+      throw std::runtime_error("[op-sqlite][open] database name is required");
     }
 
     if (!args[0].isString()) {
-      throw jsi::JSError(rt,
-                         "[op-sqlite][open] database name must be a string");
+      throw std::runtime_error(
+          "[op-sqlite][open] database name must be a string");
     }
 
     std::string dbName = args[0].asString(rt).utf8(rt);
@@ -183,8 +183,8 @@ void install(jsi::Runtime &rt,
 
     if (count > 1 && !args[1].isUndefined() && !args[1].isNull()) {
       if (!args[1].isString()) {
-        throw jsi::JSError(
-            rt, "[op-sqlite][open] database location must be a string");
+        throw std::runtime_error(
+            "[op-sqlite][open] database location must be a string");
       }
 
       tempDocPath = tempDocPath + "/" + args[1].asString(rt).utf8(rt);
@@ -193,7 +193,7 @@ void install(jsi::Runtime &rt,
     BridgeResult result = sqliteRemoveDb(dbName, tempDocPath);
 
     if (result.type == SQLiteError) {
-      throw jsi::JSError(rt, result.message.c_str());
+      throw std::runtime_error(result.message);
     }
 
     return {};
@@ -203,33 +203,30 @@ void install(jsi::Runtime &rt,
     const std::string dbName = args[0].asString(rt).utf8(rt);
     const std::string query = args[1].asString(rt).utf8(rt);
     std::vector<JSVariant> params;
-    try {
-      if (count == 3) {
-        const jsi::Value &originalParams = args[2];
-        params = toVariantVec(rt, originalParams);
-      }
 
-      std::vector<DumbHostObject> results;
-      std::shared_ptr<std::vector<SmartHostObject>> metadata =
-          std::make_shared<std::vector<SmartHostObject>>();
+    if (count == 3) {
+      const jsi::Value &originalParams = args[2];
+      params = toVariantVec(rt, originalParams);
+    }
 
-      auto status = sqliteExecute(dbName, query, &params, &results, metadata);
+    std::vector<DumbHostObject> results;
+    std::shared_ptr<std::vector<SmartHostObject>> metadata =
+        std::make_shared<std::vector<SmartHostObject>>();
 
-      if (status.type == SQLiteError) {
-        throw jsi::JSError(rt, status.message);
-      }
+    auto status = sqliteExecute(dbName, query, &params, &results, metadata);
 
-      auto jsiResult = createResult(rt, status, &results, metadata);
-      return jsiResult;
-    } catch (const std::exception &e) {
-      throw jsi::JSError(rt, e.what());
+    if (status.type == SQLiteError) {
+      throw std::runtime_error(status.message);
     }
+
+    auto jsiResult = createResult(rt, status, &results, metadata);
+    return jsiResult;
   });
 
   auto executeAsync = HOSTFN("executeAsync", 3) {
     if (count < 3) {
-      throw jsi::JSError(
-          rt, "[op-sqlite][executeAsync] Incorrect arguments for executeAsync");
+      throw std::runtime_error(
+          "[op-sqlite][executeAsync] Incorrect arguments for executeAsync");
     }
 
     const std::string dbName = args[0].asString(rt).utf8(rt);
@@ -239,7 +236,8 @@ void install(jsi::Runtime &rt,
     std::vector<JSVariant> params = toVariantVec(rt, originalParams);
 
     auto promiseCtr = rt.global().getPropertyAsFunction(rt, "Promise");
-        auto promise = promiseCtr.callAsConstructor(rt, HOSTFN("executor", 2) {
+
+    auto promise = promiseCtr.callAsConstructor(rt, HOSTFN("executor", 2) {
       auto resolve = std::make_shared<jsi::Value>(rt, args[0]);
       auto reject = std::make_shared<jsi::Value>(rt, args[1]);
 
@@ -249,7 +247,6 @@ void install(jsi::Runtime &rt,
           std::vector<DumbHostObject> results;
           std::shared_ptr<std::vector<SmartHostObject>> metadata =
               std::make_shared<std::vector<SmartHostObject>>();
-          ;
 
           auto status =
               sqliteExecute(dbName, query, &params, &results, metadata);
@@ -289,23 +286,23 @@ void install(jsi::Runtime &rt,
       pool.queueWork(task);
 
       return {};
-        }));
+    }));
 
-        return promise;
+    return promise;
   });
 
   // Execute a batch of SQL queries in a transaction
   // Parameters can be: [[sql: string, arguments: any[] | arguments: any[][] ]]
   auto executeBatch = HOSTFN("executeBatch", 2) {
     if (sizeof(args) < 2) {
-      throw jsi::JSError(
-          rt, "[op-sqlite][executeBatch] - Incorrect parameter count");
+      throw std::runtime_error(
+          "[op-sqlite][executeBatch] - Incorrect parameter count");
     }
 
     const jsi::Value &params = args[1];
     if (params.isNull() || params.isUndefined()) {
-      throw jsi::JSError(rt, "[op-sqlite][executeBatch] - An array of SQL "
-                             "commands or parameters is needed");
+      throw std::runtime_error("[op-sqlite][executeBatch] - An array of SQL "
+                               "commands or parameters is needed");
     }
     const std::string dbName = args[0].asString(rt).utf8(rt);
     const jsi::Array &batchParams = params.asObject(rt).asArray(rt);
@@ -318,22 +315,23 @@ void install(jsi::Runtime &rt,
       res.setProperty(rt, "rowsAffected", jsi::Value(batchResult.affectedRows));
       return std::move(res);
     } else {
-      throw jsi::JSError(rt, batchResult.message);
+      throw std::runtime_error(batchResult.message);
     }
   });
 
   auto executeBatchAsync = HOSTFN("executeBatchAsync", 2) {
     if (sizeof(args) < 2) {
-      throw jsi::JSError(
-          rt, "[op-sqlite][executeAsyncBatch] Incorrect parameter count");
+      throw std::runtime_error(
+          "[op-sqlite][executeAsyncBatch] Incorrect parameter count");
       return {};
     }
 
     const jsi::Value &params = args[1];
 
     if (params.isNull() || params.isUndefined()) {
-      throw jsi::JSError(rt, "[op-sqlite][executeAsyncBatch] - An array of SQL "
-                             "commands or parameters is needed");
+      throw std::runtime_error(
+          "[op-sqlite][executeAsyncBatch] - An array of SQL "
+          "commands or parameters is needed");
       return {};
     }
 
@@ -362,6 +360,7 @@ void install(jsi::Runtime &rt,
                                   jsi::Value(batchResult.affectedRows));
                   resolve->asObject(rt).asFunction(rt).call(rt, std::move(res));
                 } else {
+                  // TODO replace with reject
                   throw jsi::JSError(rt, batchResult.message);
                 }
               });
@@ -380,8 +379,8 @@ void install(jsi::Runtime &rt,
 
   auto loadFile = HOSTFN("loadFile", 2) {
     if (sizeof(args) < 2) {
-      throw jsi::JSError(
-          rt, "[op-sqlite][loadFileAsync] Incorrect parameter count");
+      throw std::runtime_error(
+          "[op-sqlite][loadFileAsync] Incorrect parameter count");
       return {};
     }
 
@@ -423,8 +422,9 @@ void install(jsi::Runtime &rt,
 
   auto updateHook = HOSTFN("updateHook", 2) {
     if (sizeof(args) < 2) {
-      throw jsi::JSError(rt, "[op-sqlite][loadFileAsync] Incorrect parameters: "
-                             "dbName and callback needed");
+      throw std::runtime_error(
+          "[op-sqlite][loadFileAsync] Incorrect parameters: "
+          "dbName and callback needed");
       return {};
     }
 
@@ -481,8 +481,9 @@ void install(jsi::Runtime &rt,
 
   auto commitHook = HOSTFN("commitHook", 2) {
     if (sizeof(args) < 2) {
-      throw jsi::JSError(rt, "[op-sqlite][loadFileAsync] Incorrect parameters: "
-                             "dbName and callback needed");
+      throw std::runtime_error(
+          "[op-sqlite][loadFileAsync] Incorrect parameters: "
+          "dbName and callback needed");
       return {};
     }
 
@@ -506,8 +507,9 @@ void install(jsi::Runtime &rt,
 
   auto rollbackHook = HOSTFN("rollbackHook", 2) {
     if (sizeof(args) < 2) {
-      throw jsi::JSError(rt, "[op-sqlite][loadFileAsync] Incorrect parameters: "
-                             "dbName and callback needed");
+      throw std::runtime_error(
+          "[op-sqlite][loadFileAsync] Incorrect parameters: "
+          "dbName and callback needed");
       return {};
     }
 

package/cpp/bridge.cpp

@@ -543,8 +543,11 @@ sqliteExecute(std::string const dbName, std::string const &query,
   if (isFailed) {
 
     return {.type = SQLiteError,
-            .message = "[op-sqlite] SQLite code: " + std::to_string(result) +
-                       " execution error: " + std::string(errorMessage)};
+            .message =
+                "[op-sqlite] SQLite error code: " + std::to_string(result) +
+                ", description: " + std::string(errorMessage) +
+                ".\nSee SQLite error codes reference: "
+                "https://www.sqlite.org/rescode.html"};
   }
 
   int changedRowCount = sqlite3_changes(db);

package/op-sqlite.podspec

@@ -11,7 +11,7 @@ Pod::Spec.new do |s|
   s.license      = package["license"]
   s.authors      = package["author"]
 
-  s.platforms    = { :ios => "12.0", :osx => "10.7" }
+  s.platforms    = { :ios => "12.0", :osx => "10.13" }
   s.source       = { :git => "https://github.com/op-engineering/op-sqlite.git", :tag => "#{s.version}" }
 
   s.pod_target_xcconfig = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@op-engineering/op-sqlite",
-  "version": "2.0.2",
+  "version": "2.0.4",
   "description": "Next generation SQLite for React Native",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",