Merge pull request #312 from joshua-journey-apps/execute-raw-sync

Add execute sync raw endpoint

Author: ospfranco

cpp/DBHostObject.cpp

@@ -361,6 +361,23 @@ void DBHostObject::create_jsi_functions() {
 
         return create_js_rows(rt, status);
     });
+    
+    function_map["executeRawSync"] = HOSTFN("executeRawSync") {
+        const std::string query = args[0].asString(rt).utf8(rt);
+        std::vector<JSVariant> params = count == 2 && args[1].isObject()
+                                            ? to_variant_vec(rt, args[1])
+                                            : std::vector<JSVariant>();
+
+        std::vector<std::vector<JSVariant>> results;
+
+#ifdef OP_SQLITE_USE_LIBSQL
+        auto status = opsqlite_libsql_execute_raw(db, query, &params, &results);
+#else
+        auto status = opsqlite_execute_raw(db, query, &params, &results);
+#endif
+
+        return create_raw_result(rt, status, &results);
+    });
 
     function_map["execute"] = HOSTFN("execute") {
         const std::string query = args[0].asString(rt).utf8(rt);

example/src/tests/queries.spec.ts

@@ -721,6 +721,23 @@ export function queriesTests() {
       expect(res).to.eql([[id, name, age, networth]]);
     });
 
+    it('Execute raw sync should return just an array of objects', async () => {
+      const id = chance.integer();
+      const name = chance.name();
+      const age = chance.integer();
+      const networth = chance.floating();
+      
+      await db.execute(
+        'INSERT INTO User (id, name, age, networth) VALUES(?, ?, ?, ?)',
+        [id, name, age, networth],
+      );
+
+      const res = db.executeRawSync(
+        'SELECT id, name, age, networth FROM User',
+      );
+      expect(res).to.eql([[id, name, age, networth]]);
+    });
+
     it('Create fts5 virtual table', async () => {
       await db.execute(
         'CREATE VIRTUAL TABLE fts5_table USING fts5(name, content);',

src/index.ts

@@ -134,6 +134,7 @@ type InternalDB = {
   prepareStatement: (query: string) => PreparedStatement;
   loadExtension: (path: string, entryPoint?: string) => void;
   executeRaw: (query: string, params?: Scalar[]) => Promise<any[]>;
+  executeRawSync: (query: string, params?: Scalar[]) => any[];
   getDbPath: (location?: string) => string;
   reactiveExecute: (params: {
     query: string;
@@ -262,6 +263,11 @@ export type DB = {
    * It will be faster since a lot of repeated work is skipped and only the values you care about are returned
    */
   executeRaw: (query: string, params?: Scalar[]) => Promise<any[]>;
+  /**
+   * Same as `executeRaw` but it will block the JS thread and therefore your UI and should be used with caution
+   * It will return an array of arrays with just the values and not the keys
+   */
+  executeRawSync: (query: string, params?: Scalar[]) => any[];
   /**
    * Get's the absolute path to the db file. Useful for debugging on local builds and for attaching the DB from users devices
    */
@@ -478,6 +484,10 @@ function enhanceDB(db: InternalDB, options: DBParams): DB {
 
       return db.executeRaw(query, sanitizedParams as Scalar[]);
     },
+    executeRawSync: (query: string, params?: Scalar[]) => {
+      const sanitizedParams = sanitizeArrayBuffersInArray(params);
+      return db.executeRawSync(query, sanitizedParams as Scalar[]);
+    },
     executeSync: (query: string, params?: Scalar[]): QueryResult => {
       const sanitizedParams = sanitizeArrayBuffersInArray(params);