You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
OffSync is a powerful SQLite Cloud feature that enables true **local-first** data synchronization for your applications. Powered by the <ahref="https://github.com/sqliteai/sqlite-sync"target="_blank">SQLite Sync</a> extension, it allows you to build robust, offline-capable applications where data is stored and processed on edge devices and seamlessly synchronized with a central SQLite Cloud database.
@@ -39,11 +42,16 @@ When OffSync is not yet active for a database, the panel shows a brief explanati
39
42
40
43
To disable OffSync, click the **Disable OffSync** button in the top-right corner of the panel and confirm the action in the dialog that appears.
41
44
45
+
<VideoPlayersrc={enableDisableSync} />
46
+
42
47
### Enable Tables for Synchronization
43
48
44
49
From the **Sync Tables** tab, select which tables in your database you want to keep synchronized.
45
50
Once enabled, all changes to those tables will automatically sync with connected devices.
46
51
52
+
{/* VIDEO: dashboard_offsync_sync_tables.mp4
53
+
Show: Sync Tables tab open → toggle one or more tables on → confirmation that sync is active for those tables. */}
54
+
47
55
### Configuration Tab
48
56
49
57
The **Configuration** tab contains two sub-sections:
**Push Notifications** — Configure an Expo access token to enable push notifications when using `sqlite-sync-react-native` in push mode. The tab shows the current notification status: **Working**, **Paused**, or **Not working**.
58
66
67
+
{/* VIDEO: dashboard_offsync_configuration.mp4
68
+
Show: Configuration tab open → Database ID field with copy button clicked → scroll down to Push Notifications section → paste an Expo token → save → status changes to "Working". */}
69
+
59
70
### Manage Connected Devices
60
71
61
72
In the **Devices** tab, you can view all devices currently connected to your database.
62
73
Here you can check their sync status and remove devices if needed.
63
74
75
+
{/* VIDEO: dashboard_offsync_devices.mp4
76
+
Show: Devices tab open with a list of connected devices → inspect sync status of one device → remove a device from the list. */}
77
+
64
78
<Callouttype="note"title="Matching Schemas and Tables">
65
79
For OffSync to work correctly, the list of tables configured for synchronization—and their corresponding schemas—must be identical in both your local SQLite database and your SQLite Cloud database.
66
80
</Callout>
@@ -73,4 +87,7 @@ The **Metrics** tab provides visibility into daily and cumulative usage for your
73
87
-**Upload bytes** — data sent from devices to SQLite Cloud
74
88
-**Download bytes** — data sent from SQLite Cloud to devices
75
89
90
+
{/* VIDEO: dashboard_offsync_metrics.mp4
91
+
Show: Metrics tab open → scroll through active devices chart → upload bytes chart → download bytes chart, ideally with some non-zero data visible. */}
92
+
76
93
Once enabled, any changes made to the selected tables via the SQLite Sync extension will be automatically synchronized with your SQLite Cloud database.
0 commit comments