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
Copy file name to clipboardExpand all lines: sqlite-cloud/platform/_wip-index-with-card.mdx
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,6 +11,8 @@ import IndexPage from "@docs-website-components/Docs/IndexPage.astro"
11
11
12
12
exportconst introduction ="SQLite Cloud is a distributed relational database system built on top of the SQLite database engine. It has been specifically designed from the ground up to ensure the strong consistency of your data across all nodes in a cluster while simultaneously managing the technical aspects of scaling, security, and data distribution."
description: SQLite Cloud provides secure access to resources through role-based authorization, which ensures user isolation and enhances security and manageability.
4
+
category: platform
5
+
status: publish
6
+
slug: apikey
7
+
---
8
+
9
+
## API KEYs
10
+
11
+
API KEYs can be used as an alternative authentication mechanism.
12
+
Authentication through API keys ensures the same privileges as the user to which they are associated.
13
+
API KEYs are recommended for all server-to-server authentication cases and are necessary for using the REST APIs and the SDKs that uses the WebSocket APIs.
14
+
15
+
To create an API key for a user, click on the **Create API KEY** button.
-**[RTree](https://www.sqlite.org/rtree.html)**: R-Tree index for storing and querying spatial data.
16
-
-**[Geopoly](https://www.sqlite.org/geopoly.html)**: Functions for working with geospatial data.
17
-
-**[sqlite-vec](/docs/vector)**: Vector storage extension for similarity search.
20
+
-**[Geopoly](https://www.sqlite.org/geopoly.html)**: A set of functions for working with geospatial data. For a complete guide, see the [comprehensive tutorial here](tutorial-geopoly).
18
21
19
22
In the future, we plan to allow users to install their own extensions. If you have a specific extension you would like to use, please let us know by [adding to this issue](https://github.com/sqlitecloud/docs/issues/34).
OffSync is a powerful SQLite Cloud feature that enables true **local-first** data synchronization for your applications. Powered by the [SQLite Sync](https://github.com/sqliteai/sqlite-sync) 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.
12
+
13
+
This architecture is ideal for mobile apps, IoT devices, and any application requiring high availability and low latency, even with intermittent network connectivity. By leveraging Conflict-free Replicated Data Types (CRDTs), OffSync ensures that changes made offline are merged automatically and without conflicts when the device reconnects.
14
+
15
+
## How It Works
16
+
17
+
OffSync extends standard SQLite tables with built-in support for offline work and automatic synchronization. This allows multiple devices to operate independently and then seamlessly merge their changes.
18
+
19
+
-**Offline-First by Design**: Applications work seamlessly even when devices are offline. Changes are queued locally and synced automatically when connectivity is restored.
20
+
-**CRDT-Based Conflict Resolution**: Merges updates deterministically and efficiently, ensuring eventual consistency across all replicas without complex merge logic.
21
+
-**Seamless Integration**: The sync layer is tightly integrated with SQLite Cloud, enabling secure data sharing across devices, users, and platforms.
22
+
23
+
When combined with [Row-Level Security (RLS)](/docs/rls), OffSync allows you to build secure, multi-tenant applications where each user's data is safely isolated, both on the edge and in the cloud.
24
+
25
+
## Configuring OffSync
26
+
27
+
You can enable and manage OffSync for your databases directly from the SQLite Cloud dashboard.
28
+
29
+
1.**Navigate to the Databases Page**: From the main dashboard, go to the "Databases" page.
30
+
2.**Select the Offsync Column**: In the list of your databases, click on the button in the "Offsync" column for the desired database.
3.**Enable Tables for Synchronization**: On the Offsync settings page, you will see a list of all tables in your database. Toggle the switch next to each table you want to enable for synchronization.
<Callouttype="note"title="Matching Schemas and Tables">
39
+
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.
40
+
</Callout>
41
+
42
+
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