Experimental: Trigger Based Table Diff Tracking (#663)

Co-authored-by: benitav <benitav@users.noreply.github.com>

Author: stevensJourney

.changeset/tame-islands-deliver.md

@@ -0,0 +1,8 @@
+---
+'@powersync/common': minor
+'@powersync/node': minor
+'@powersync/react-native': minor
+'@powersync/web': minor
+---
+
+Added SQLite trigger based table change tracking.

docs/.gitignore

@@ -25,5 +25,6 @@ docs/react-sdk/
 docs/vue-sdk/
 docs/web-sdk/
 docs/tanstack-react-query-sdk
+docs/node-sdk
 
 .env

docs/docusaurus.config.ts

@@ -1,10 +1,10 @@
-import { themes as prismThemes } from 'prism-react-renderer';
-import type { TypeDocOptionMap } from 'typedoc';
-import type { Config } from '@docusaurus/types';
 import type * as Preset from '@docusaurus/preset-classic';
+import type { Config } from '@docusaurus/types';
 import type { PluginOptions } from 'docusaurus-plugin-typedoc';
-import { DOC_FOLDER, packageMap } from './utils/packageMap';
 import 'dotenv/config';
+import { themes as prismThemes } from 'prism-react-renderer';
+import type { TypeDocOptionMap } from 'typedoc';
+import { DOC_FOLDER, packageMap } from './utils/packageMap';
 
 const PROJECT_NAME = process.env.GH_PROJECT_NAME;
 
@@ -155,8 +155,8 @@ const config: Config = {
       darkTheme: prismThemes.dracula
     },
     future: {
-      experimental_faster: true,
-    },
+      experimental_faster: true
+    }
   } satisfies Preset.ThemeConfig
 };
 

packages/common/src/client/AbstractPowerSyncDatabase.ts

@@ -35,6 +35,8 @@ import {
   type PowerSyncConnectionOptions,
   type RequiredAdditionalConnectionOptions
 } from './sync/stream/AbstractStreamingSyncImplementation.js';
+import { TriggerManager } from './triggers/TriggerManager.js';
+import { TriggerManagerImpl } from './triggers/TriggerManagerImpl.js';
 import { DEFAULT_WATCH_THROTTLE_MS, WatchCompatibleQuery } from './watched/WatchedQuery.js';
 import { OnChangeQueryProcessor } from './watched/processors/OnChangeQueryProcessor.js';
 import { WatchedQueryComparator } from './watched/processors/comparators.js';
@@ -191,6 +193,12 @@ export abstract class AbstractPowerSyncDatabase extends BaseObserver<PowerSyncDB
 
   protected runExclusiveMutex: Mutex;
 
+  /**
+   * @experimental
+   * Allows creating SQLite triggers which can be used to track various operations on SQLite tables.
+   */
+  readonly triggers: TriggerManager;
+
   logger: ILogger;
 
   constructor(options: PowerSyncDatabaseOptionsWithDBAdapter);
@@ -226,6 +234,7 @@ export abstract class AbstractPowerSyncDatabase extends BaseObserver<PowerSyncDB
     this.ready = false;
     this.sdkVersion = '';
     this.runExclusiveMutex = new Mutex();
+
     // Start async init
     this.connectionManager = new ConnectionManager({
       createSyncImplementation: async (connector, options) => {
@@ -252,7 +261,13 @@ export abstract class AbstractPowerSyncDatabase extends BaseObserver<PowerSyncDB
       },
       logger: this.logger
     });
+
     this._isReadyPromise = this.initialize();
+
+    this.triggers = new TriggerManagerImpl({
+      db: this,
+      schema: this.schema
+    });
   }
 
   /**