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
Browse filesBrowse the repository at this point in the historyBrowse files
Conrad Hofmeyr
committed
Polish:
- Terminology consistent with docs
- Slight tweaks to messaging
- README improvements
- Center the SQLite File Inspector content on the page
- Fix issue with hover color for link in tooltip
Copy file name to clipboardExpand all lines: tools/diagnostics-app/README.md
+15-17Lines changed: 15 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,10 @@
1
1
# Sync Diagnostics Client
2
2
3
-
A browser-based tool for inspecting PowerSync databases. Both live (via sync) and offline (via SQLite file upload).
3
+
A browser-based tool for inspecting PowerSync sync behavior and databases. Supports both live syncing from a PowerSync instance, and offline inspection of a SQLite database (by uploading a file).
4
4
5
-
The app is available at [https://diagnostics-app.powersync.com/](https://diagnostics-app.powersync.com/)
5
+
A hosted version of the Sync Diagnostics Client is available at [https://diagnostics-app.powersync.com/](https://diagnostics-app.powersync.com/). It can also be run as a local standalone web app. It is based on the [PowerSync Web SDK](/packages/web/).
6
6
7
-
It can also be run as a local standalone web app, and is based on the [web SDK](/packages/web/).
8
-
9
-
## Running the App
7
+
## Running the Sync Diagnostics Client
10
8
11
9
### Docker
12
10
@@ -18,7 +16,7 @@ The app will be available on http://localhost:8082.
18
16
19
17
### Local Development
20
18
21
-
In the root of the repository, run:
19
+
In the **root of the repository**, run:
22
20
23
21
```sh
24
22
pnpm install
@@ -39,8 +37,8 @@ The landing page offers two paths:
39
37
40
38

41
39
42
-
-**Connect to PowerSync**: Live sync diagnostics using a JWT token. View real-time sync status, bucket data, and manage client parameters.
43
-
-**Inspect SQLite File**: Offline inspection of a local `SQLite` file. No authentication required.
40
+
-**Connect to PowerSync**: Live sync diagnostics using a JWT token. View real-time sync status, bucket data, and manage connection/client parameters.
41
+
-**Inspect SQLite File**: Offline inspection of a local SQLite database file. No authentication required.
44
42
45
43
---
46
44
@@ -77,10 +75,10 @@ The main dashboard after connecting:
77
75
78
76

79
77
80
-
Manage sync stream subscriptions directly from the Sync Overview page:
78
+
Manage Sync Stream subscriptions directly from the _Sync Overview_ page:
81
79
82
-
- View all active stream subscriptions with their parameters, priority, sync time, and eviction time.
83
-
-**Add Subscription**: Subscribe to a new stream with optional parameters and priority.
80
+
- View all active Sync Stream subscriptions with their parameters, priority, sync time, and eviction time.
81
+
-**Add Subscription**: Subscribe to a new Sync Stream with optional subscription parameters and priority.
84
82
-**Unsubscribe**: Remove explicit subscriptions (triggers a reconnect to apply the change).
85
83
86
84
### SQL Console
@@ -99,13 +97,13 @@ Execute read-only SQL queries against the live PowerSync database:
99
97
100
98
The schema is dynamically inferred from downloaded data and automatically updated as new data arrives. This page displays the current inferred schema for reference.
101
99
102
-
Note: Tables with 0 synced rows won't appear in the schema. To refresh after sync rule/stream changes, use "Clear & Redownload" on the Sync Overview page.
100
+
Note: Tables with 0 synced rows won't appear in the schema. To refresh after Sync Streams / Sync Rules changes, use "Clear & Redownload" on the _Sync Overview_ page.
103
101
104
-
### Client Parameters
102
+
### Connection Parameters / Client Parameters
105
103
106
104

107
105
108
-
Manage client parameters that are sent with sync requests:
106
+
Manage [Connection Parameters](https://docs.powersync.com/sync/streams/parameters#connection-parameters) (Sync Streams) / [Client Parameters](https://docs.powersync.com/sync/rules/client-parameters) (Sync Rules) that are sent with sync requests:
109
107
110
108
- Add, edit, and delete key-value parameters.
111
109
- Supports string, number, boolean, array, and object types.
@@ -115,13 +113,13 @@ Manage client parameters that are sent with sync requests:
115
113
116
114
## SQLite File Inspector
117
115
118
-
The File Inspector allows offline inspection of SQLite database files. It is useful for post-mortem analysis of database files extracted from devices. No authentication is required.
116
+
The File Inspector allows offline inspection of SQLite database files. It is useful for analysis of database files extracted from devices. No authentication is required.
119
117
120
118
### Opening a File
121
119
122
120

123
121
124
-
Drag and drop a `SQLite`file, or click to browse. The file is opened in-browser using wa-sqlite - nothing is uploaded to a server.
122
+
Drag and drop a SQLite database file, or click to browse. The file is opened in-browser using `wa-sqlite` - nothing is uploaded to a server.
125
123
126
124
### Database Overview
127
125
@@ -135,7 +133,7 @@ Drag and drop a `SQLite` file, or click to browse. The file is opened in-browser
135
133
136
134

137
135
138
-
Execute read-only SQL queries against the uploaded file. Works the same as the sync SQL console, with separate query history.
136
+
Execute read-only SQL queries against the uploaded file. Works the same as the _SQL Console_ for live synced databases, with separate query history.
<CardDescription>Configure key-value Connection Parameters (Sync Streams) / Client Parameters (Sync Rules) that will be sent with sync requests.</CardDescription>
0 commit comments