Added jsdoc result example to executeRaw. Simplified RNQS adapter changes.

Author: Chriztiaan

packages/common/src/db/DBAdapter.ts

@@ -44,7 +44,20 @@ export interface DBGetUtils {
 export interface LockContext extends DBGetUtils {
   /** Execute a single write statement. */
   execute: (query: string, params?: any[] | undefined) => Promise<QueryResult>;
-  /** Execute a single write statement and return raw results. */
+  /**
+   * Execute a single write statement and return raw results.
+   * Unlike `execute`, which returns an object with structured key-value pairs,
+   * `executeRaw` returns a nested array of raw values, where each row is
+   * represented as an array of column values without field names.
+   *
+   * Example result:
+   *
+   * ```[ [ '1', 'list 1', '33', 'Post content', '1' ] ]```
+   *
+   * Where as `execute`'s `rows._array` would have been:
+   *
+   * ```[ { id: '33', name: 'list 1', content: 'Post content', list_id: '1' } ]```
+   */
   executeRaw: (query: string, params?: any[] | undefined) => Promise<any[][]>;
 }
 

packages/react-native/src/db/adapters/react-native-quick-sqlite/RNQSDBAdapter.ts

@@ -47,25 +47,19 @@ export class RNQSDBAdapter extends BaseObserver<DBAdapterListener> implements DB
   }
 
   readLock<T>(fn: (tx: PowerSyncLockContext) => Promise<T>, options?: DBLockOptions): Promise<T> {
-    return this.baseDB.readLock((dbTx) => fn(this.generateDBHelpers(this.generateLockContext(dbTx))), options);
+    return this.baseDB.readLock((dbTx) => fn(this.generateDBHelpers(this.generateContext(dbTx))), options);
   }
 
   readTransaction<T>(fn: (tx: PowerSyncTransaction) => Promise<T>, options?: DBLockOptions): Promise<T> {
-    return this.baseDB.readTransaction(
-      (dbTx) => fn(this.generateDBHelpers(this.generateTransactionContext(dbTx))),
-      options
-    );
+    return this.baseDB.readTransaction((dbTx) => fn(this.generateDBHelpers(this.generateContext(dbTx))), options);
   }
 
   writeLock<T>(fn: (tx: PowerSyncLockContext) => Promise<T>, options?: DBLockOptions): Promise<T> {
-    return this.baseDB.writeLock((dbTx) => fn(this.generateDBHelpers(this.generateLockContext(dbTx))), options);
+    return this.baseDB.writeLock((dbTx) => fn(this.generateDBHelpers(this.generateContext(dbTx))), options);
   }
 
   writeTransaction<T>(fn: (tx: PowerSyncTransaction) => Promise<T>, options?: DBLockOptions): Promise<T> {
-    return this.baseDB.writeTransaction(
-      (dbTx) => fn(this.generateDBHelpers(this.generateTransactionContext(dbTx))),
-      options
-    );
+    return this.baseDB.writeTransaction((dbTx) => fn(this.generateDBHelpers(this.generateContext(dbTx))), options);
   }
 
   execute(query: string, params?: any[]) {
@@ -93,18 +87,7 @@ export class RNQSDBAdapter extends BaseObserver<DBAdapterListener> implements DB
     };
   }
 
-  generateLockContext(ctx: RNQSLockContext) {
-    return {
-      ...ctx,
-      // 'executeRaw' is not implemented in RNQS, this falls back to 'execute'.
-      executeRaw: async (sql: string, params?: any[]) => {
-        const result = await ctx.execute(sql, params);
-        return result.rows?._array ?? [];
-      }
-    };
-  }
-
-  generateTransactionContext(ctx: RNQSTransactionContext) {
+  generateContext<T extends RNQSLockContext>(ctx: T) {
     return {
       ...ctx,
       // 'executeRaw' is not implemented in RNQS, this falls back to 'execute'.