Add cacheSizeKb option for web; defaults to 50MB.

Author: rkistner

packages/web/src/db/adapters/wa-sqlite/WASQLiteConnection.ts

@@ -235,6 +235,7 @@ export class WASqliteConnection
     await this.openDB();
     this.registerBroadcastListeners();
     await this.executeSingleStatement(`PRAGMA temp_store = ${this.options.temporaryStorage};`);
+    await this.executeSingleStatement(`PRAGMA cache_size = -${this.options.cacheSizeKb};`);
     await this.executeEncryptionPragma();
 
     this.sqliteAPI.update_hook(this.dbP, (updateType: number, dbName: string | null, tableName: string | null) => {

packages/web/src/db/adapters/wa-sqlite/WASQLiteDBAdapter.ts

@@ -3,7 +3,12 @@ import * as Comlink from 'comlink';
 import { resolveWebPowerSyncFlags } from '../../PowerSyncDatabase';
 import { OpenAsyncDatabaseConnection } from '../AsyncDatabaseConnection';
 import { LockedAsyncDatabaseAdapter } from '../LockedAsyncDatabaseAdapter';
-import { ResolvedWebSQLOpenOptions, TemporaryStorageOption, WebSQLFlags } from '../web-sql-flags';
+import {
+  DEFAULT_CACHE_SIZE_KB,
+  ResolvedWebSQLOpenOptions,
+  TemporaryStorageOption,
+  WebSQLFlags
+} from '../web-sql-flags';
 import { WorkerWrappedAsyncDatabaseConnection } from '../WorkerWrappedAsyncDatabaseConnection';
 import { WASQLiteVFS } from './WASQLiteConnection';
 import { WASQLiteOpenFactory } from './WASQLiteOpenFactory';
@@ -27,6 +32,7 @@ export interface WASQLiteDBAdapterOptions extends Omit<PowerSyncOpenFactoryOptio
 
   vfs?: WASQLiteVFS;
   temporaryStorage?: TemporaryStorageOption;
+  cacheSizeKb?: number;
 
   /**
    * Encryption key for the database.
@@ -43,7 +49,7 @@ export class WASQLiteDBAdapter extends LockedAsyncDatabaseAdapter {
     super({
       name: options.dbFilename,
       openConnection: async () => {
-        const { workerPort, temporaryStorage } = options;
+        const { workerPort, temporaryStorage, cacheSizeKb } = options;
         if (workerPort) {
           const remote = Comlink.wrap<OpenAsyncDatabaseConnection>(workerPort);
           return new WorkerWrappedAsyncDatabaseConnection({
@@ -52,6 +58,7 @@ export class WASQLiteDBAdapter extends LockedAsyncDatabaseAdapter {
             baseConnection: await remote({
               ...options,
               temporaryStorage: temporaryStorage ?? TemporaryStorageOption.MEMORY,
+              cacheSizeKb: cacheSizeKb ?? DEFAULT_CACHE_SIZE_KB,
               flags: resolveWebPowerSyncFlags(options.flags),
               encryptionKey: options.encryptionKey
             })
@@ -63,6 +70,7 @@ export class WASQLiteDBAdapter extends LockedAsyncDatabaseAdapter {
           debugMode: options.debugMode,
           flags: options.flags,
           temporaryStorage,
+          cacheSizeKb,
           logger: options.logger,
           vfs: options.vfs,
           encryptionKey: options.encryptionKey,

packages/web/src/db/adapters/wa-sqlite/WASQLiteOpenFactory.ts

@@ -4,7 +4,12 @@ import { openWorkerDatabasePort, resolveWorkerDatabasePortFactory } from '../../
 import { AbstractWebSQLOpenFactory } from '../AbstractWebSQLOpenFactory';
 import { AsyncDatabaseConnection, OpenAsyncDatabaseConnection } from '../AsyncDatabaseConnection';
 import { LockedAsyncDatabaseAdapter } from '../LockedAsyncDatabaseAdapter';
-import { ResolvedWebSQLOpenOptions, TemporaryStorageOption, WebSQLOpenFactoryOptions } from '../web-sql-flags';
+import {
+  DEFAULT_CACHE_SIZE_KB,
+  ResolvedWebSQLOpenOptions,
+  TemporaryStorageOption,
+  WebSQLOpenFactoryOptions
+} from '../web-sql-flags';
 import { WorkerWrappedAsyncDatabaseConnection } from '../WorkerWrappedAsyncDatabaseConnection';
 import { WASqliteConnection, WASQLiteVFS } from './WASQLiteConnection';
 
@@ -44,6 +49,7 @@ export class WASQLiteOpenFactory extends AbstractWebSQLOpenFactory {
     const {
       vfs = WASQLiteVFS.IDBBatchAtomicVFS,
       temporaryStorage = TemporaryStorageOption.MEMORY,
+      cacheSizeKb = DEFAULT_CACHE_SIZE_KB,
       encryptionKey
     } = this.waOptions;
 
@@ -60,6 +66,7 @@ export class WASQLiteOpenFactory extends AbstractWebSQLOpenFactory {
               optionsDbWorker({
                 ...this.options,
                 temporaryStorage,
+                cacheSizeKb,
                 flags: this.resolvedFlags,
                 encryptionKey
               })
@@ -74,6 +81,7 @@ export class WASQLiteOpenFactory extends AbstractWebSQLOpenFactory {
           dbFilename: this.options.dbFilename,
           vfs,
           temporaryStorage,
+          cacheSizeKb,
           flags: this.resolvedFlags,
           encryptionKey: encryptionKey
         }),
@@ -94,6 +102,7 @@ export class WASQLiteOpenFactory extends AbstractWebSQLOpenFactory {
         debugMode: this.options.debugMode,
         vfs,
         temporaryStorage,
+        cacheSizeKb,
         flags: this.resolvedFlags,
         encryptionKey: encryptionKey
       });

packages/web/src/db/adapters/web-sql-flags.ts

@@ -47,6 +47,8 @@ export interface ResolvedWebSQLOpenOptions extends SQLOpenOptions {
    */
   temporaryStorage: TemporaryStorageOption;
 
+  cacheSizeKb: number;
+
   /**
    * Encryption key for the database.
    * If set, the database will be encrypted using ChaCha20.
@@ -59,6 +61,8 @@ export enum TemporaryStorageOption {
   FILESYSTEM = 'file'
 }
 
+export const DEFAULT_CACHE_SIZE_KB = 100 * 1024;
+
 /**
  * Options for opening a Web SQL connection
  */
@@ -74,12 +78,22 @@ export interface WebSQLOpenFactoryOptions extends SQLOpenOptions {
   worker?: string | URL | ((options: ResolvedWebSQLOpenOptions) => Worker | SharedWorker);
 
   logger?: ILogger;
+
   /**
    * Where to store SQLite temporary files. Defaults to 'MEMORY'.
    * Setting this to `FILESYSTEM` can cause issues with larger queries or datasets.
+   *
+   * For details, see: https://www.sqlite.org/pragma.html#pragma_temp_store
    */
   temporaryStorage?: TemporaryStorageOption;
 
+  /**
+   * Maximum SQLite cache size. Defaults to 50MB.
+   *
+   * For details, see: https://www.sqlite.org/pragma.html#pragma_cache_size
+   */
+  cacheSizeKb?: number;
+
   /**
    * Encryption key for the database.
    * If set, the database will be encrypted using ChaCha20.