Skip to content

Commit e64723e

Browse files
authored
Merge pull request #146 from sqlitecloud/stage
feat: add cloudsync management api documentation
2 parents 18811eb + 7c1c8a4 commit e64723e

6 files changed

Lines changed: 425 additions & 6 deletions

File tree

‎sqlite-cloud/_nav.ts‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,12 @@ const sidebarNav: SidebarNavStruct = [
9595
type: "inner",
9696
level: 1,
9797
},
98+
{
99+
title: "Management API",
100+
filePath: "sqlite-sync-cloudsync-management-api",
101+
type: "inner",
102+
level: 1,
103+
},
98104
{
99105
title: "Best Practices",
100106
filePath: "sqlite-sync-best-practices",
@@ -113,9 +119,9 @@ const sidebarNav: SidebarNavStruct = [
113119
type: "inner",
114120
level: 1,
115121
},
116-
{ title: "API Reference", type: "inner", level: 1 },
122+
{ title: "Client API Reference", type: "inner", level: 1 },
117123
{
118-
title: "API Overview",
124+
title: "Overview",
119125
filePath: "sqlite-sync-api-reference",
120126
type: "inner",
121127
level: 2,

‎sqlite-cloud/platform/cloudsync.mdx‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,11 @@ When combined with [Row-Level Security (RLS)](/docs/rls), CloudSync allows you t
3434

3535
You can enable and manage CloudSync for your databases directly from the SQLite Cloud dashboard. Select a database from the left panel — the list shows all databases in your project along with their CloudSync status. The right panel has four tabs: **Database Setup**, **Client Integration**, **Devices**, and **Metrics**.
3636

37+
If you prefer automation, you can also register databases, inspect tables, and enable CloudSync programmatically with the [Management API](/docs/sqlite-sync-cloudsync-management-api). That page documents the workspace-scoped management endpoints used with a `workspace-admin` key.
38+
3739
### Enabling and Disabling CloudSync
3840

3941
When CloudSync is not yet active for a database, the right panel shows a brief explanation and an **Enable CloudSync** button. Clicking it opens a confirmation dialog; after confirming, the database is registered with the sync service and the tabbed view appears.
40-
4142
To disable CloudSync, click the **Disable CloudSync** button in the top-right corner of the panel and confirm in the dialog that appears.
4243

4344
{/* <VideoPlayer src={enableDisableSync} /> */}

‎sqlite-cloud/sqlite-ai/sqlite-sync/api-reference.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: "SQLite-Sync API Reference"
3-
description: "Comprehensive SQLite-Sync API reference for configuration, filters, block-level LWW, helpers, schema changes, and networking."
2+
title: "Client API Reference"
3+
description: "Reference for the SQLite Sync client runtime functions for configuration, filters, block-level LWW, helpers, schema changes, and networking."
44
category: platform
55
status: publish
66
slug: sqlite-sync-api-reference

‎sqlite-cloud/sqlite-ai/sqlite-sync/block-lww.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,4 +127,4 @@ SELECT cloudsync_set_column('docs', 'body', 'algo', 'block');
127127
- **Mixed columns**: A table can have both regular and block-level LWW columns.
128128
- **Transparent reads**: The base column always contains the current full text.
129129

130-
For API details, see the [API Reference](/docs/sqlite-sync-api-reference).
130+
For API details, see the [Client API Reference](/docs/sqlite-sync-api-reference).

0 commit comments

Comments
 (0)