Skip to content

Commit af74b30

Browse files
authored
Merge branch 'stage' into jacob/update-architecture
2 parents 37c14e8 + bcf5dc5 commit af74b30

File tree

6 files changed

+210
-4
lines changed

6 files changed

+210
-4
lines changed

sqlite-cloud/_nav.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ const sidebarNav: SidebarNavStruct = [
2525
{ title: "Integrations", type: "inner", level: 0 },
2626
{ title: "Knex.js", filePath: "knex-integration", type: "inner", level: 1 },
2727

28-
{ title: "Platform", type: "secondary", icon: "docs-plat" },
28+
{ title: "Platform", filePath:"platform", type: "secondary", icon: "docs-plat" },
2929
{ title: "Edge Functions", filePath: "edge-functions", type: "inner", level: 0 },
3030
{ title: "Webhooks", filePath: "webhooks", type: "inner", level: 0 },
3131
{ title: "Pub/Sub", filePath: "pub-sub", type: "inner", level: 0 },
@@ -39,7 +39,7 @@ const sidebarNav: SidebarNavStruct = [
3939
// { title: "Storage", type: "inner", level: 0 },
4040
// { title: "Partitioning", type: "inner", level: 0 },
4141

42-
{ title: "SDKs", type: "secondary", icon: "docs-sdk" },
42+
{ title: "SDKs", filePath:"sdks", type: "secondary", icon: "docs-sdk" },
4343
{ title: "C/C++", type: "inner", level: 0 },
4444
{ title: "Introduction", type: "inner", filePath: "sdk-c-introduction", level: 1, },
4545
{ title: 'Basic APIs', type: "inner", level: 1 },
@@ -175,7 +175,7 @@ const sidebarNav: SidebarNavStruct = [
175175
{ title: "Swift", type: "inner", level: 0 },
176176
{ title: 'Introduction', type: "inner", filePath: "sdk-swift-introduction", level: 1 },
177177

178-
{ title: "Reference", type: "secondary", icon: "docs-ref" },
178+
{ title: "Reference", filePath:"reference", type: "secondary", icon: "docs-ref" },
179179
{ title: "Server-side Commands", type: "inner", level: 0 },
180180
{ title: "Introduction", filePath: "server-side-commands", type: "inner", level: 1 },
181181
{ title: "API Keys", filePath: "api-key-commands", type: "inner", level: 1 },

sqlite-cloud/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,4 @@ SQLite Cloud provides a comprehensive suite of tools for building realtime, loca
2626
* **[Edge Functions](/docs/edge-functions)**: Run serverless functions on the same nodes that store your data for lightning-fast data access.
2727
* **[Pub/Sub](/docs/pub-sub)**: Subscribe to changes in your database to replicate data, power notifications, and build multiplayer experiences.
2828
* **[Weblite](/docs/weblite)**: Autogenerated REST APIs to interact with the SQLite Cloud platform.
29-
* **[Query Analyzer](/docs/analyzer)**: Receive optimization recommendations for your queries to improve performance.
29+
* **[Query Analyzer](/docs/analyzer)**: Receive optimization recommendations for your queries to improve performance.

sqlite-cloud/introduction.mdx

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
title: Introduction to SQLite Cloud
3+
description: SQLite Cloud is a distributed relational database system built on top of the SQLite database engine.
4+
category: getting-started
5+
status: publish
6+
slug: introduction
7+
---
8+
9+
## Overview
10+
**SQLite Cloud** is a managed, distributed relational database system built on top of the SQLite database engine.
11+
12+
It has been designed from the ground up to ensure strong consistency across all nodes in a cluster while simultaneously managing the technical aspects of scaling, security, and data distribution. This ensures that you can focus on your core tasks while relying on **SQLite Cloud** to handle the complexities of managing your databases.
13+
14+
**SQLite Cloud** is written in ANSI C and GO, and it works on most POSIX systems like Linux, *BSD, and Mac OS X (Windows is supported too). You can use **SQLite Cloud** from the most popular programming languages or its REST API.
15+
16+
---
17+
18+
## Architecture
19+
20+
**SQLite Cloud** uses the [Raft](https://raft.github.io) consensus algorithm to distribute your data changes across a cluster of computing systems, ensuring that each node in the cluster agrees upon the same series of state transitions. Raft implements consensus with a leader approach.
21+
22+
**SQLite Cloud** supports all the SQLite features without any limitations. It is fully ACID compliant, supports non-deterministic SQL statements, and guarantees strong consistency across all your cluster nodes. This ensures that data read from any node in the system returns the most up-to-date version of the data that has been committed.
23+
24+
In a distributed database system, where data is distributed across multiple nodes, ensuring strong consistency can be challenging due to the potential for network delays, node failures, and concurrent transactions. Maintaining strong consistency is crucial for ensuring that the system behaves as expected and that applications built on top of the system can rely on the accuracy and integrity of the data.
25+
26+
## Features
27+
SQLite Cloud provides a comprehensive suite of tools for building realtime, local-first applications.
28+
* **Local Sync**: Query your local SQLite database and synchronize with the cloud and across devices in real-time (**In development**).
29+
* **Offline-first**: Resolve conflicts between devices and the cloud with CRDTs (**In development**).
30+
* **[Webhooks](/docs/webhooks)**: Send changes to your database to external endpoints, or use to trigger edge functions via HTTP, Websockets, or on database events like INSERT, UPDATE, and DELETE.
31+
* **[Edge Functions](/docs/edge-functions)**: Run serverless functions on the same node that stores your data for low-latency operations. Trigger with webhooks or on database operations.
32+
* **[Pub/Sub](/docs/pub-sub)**: Subscribe to changes in your database to replicate data, power notifications, and build multiplayer experiences.
33+
* **Weblite**: Autogenerated REST APIs to interact with your database and edge functions.
34+
* **[Query Analyzer](/docs/analyzer)**: Receive optimization recommendations for your queries to improve performance.
35+
* **Multi-region Load Balancer**: Connect to SQLite Cloud from anywhere in the world and SQLite Cloud automatically routes traffic to the nearest node for optimal performance.

sqlite-cloud/platform/index.mdx

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
---
2+
title: Platform
3+
description: Index page for platform section
4+
category: platform
5+
status: publish
6+
icon: docs-plat
7+
slug: platform
8+
---
9+
import IndexPage from "@docs-website-components/Docs/IndexPage.astro"
10+
11+
export const 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."
12+
13+
export const sections = [
14+
{
15+
icon: "puzzle",
16+
title: "Edge Functions",
17+
description: "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
18+
href: "/docs/edge-functions",
19+
},
20+
{
21+
icon: "puzzle",
22+
title: "Webhooks",
23+
description: "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
24+
href: "/docs/webhooks",
25+
},
26+
{
27+
icon: "puzzle",
28+
title: "Pub/Sub",
29+
description: "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
30+
href: "/docs/pub-sub",
31+
},
32+
{
33+
icon: "puzzle",
34+
title: "Vector",
35+
description: "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
36+
href: "/docs/vector",
37+
},
38+
{
39+
icon: "puzzle",
40+
title: "Scaling",
41+
description: "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
42+
href: "/docs/scaling",
43+
},
44+
{
45+
icon: "puzzle",
46+
title: "Security and Access Control",
47+
description: "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
48+
href: "/docs/security",
49+
},
50+
{
51+
icon: "puzzle",
52+
title: "Backups",
53+
description: "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
54+
href: "/docs/backups",
55+
},
56+
{
57+
icon: "puzzle",
58+
title: "Query Analyzer",
59+
description: "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
60+
href: "/docs/analyzer",
61+
},
62+
{
63+
icon: "puzzle",
64+
title: "Extensions",
65+
description: "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
66+
href: "/docs/extensions",
67+
},
68+
{
69+
icon: "puzzle",
70+
title: "Weblite",
71+
description: "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
72+
href: "/docs/weblite",
73+
},
74+
{
75+
icon: "puzzle",
76+
title: "Settings",
77+
description: "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
78+
href: "/docs/settings",
79+
},
80+
]
81+
82+
83+
<IndexPage introduction={introduction} sections={sections} />

sqlite-cloud/reference/index.mdx

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
title: Reference
3+
description: Index page for reference section
4+
category: reference
5+
status: publish
6+
icon: docs-ref
7+
slug: reference
8+
---
9+
import IndexPage from "@docs-website-components/Docs/IndexPage.astro"
10+
11+
export const 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."
12+
13+
export const sections = [
14+
{
15+
icon: "curvedArrow",
16+
title: "Server-side Commands",
17+
description: "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
18+
href: "/docs/server-side-commands",
19+
},
20+
{
21+
icon: "twoColsGrid",
22+
title: "CLI",
23+
description: "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
24+
href: "/docs/cli-commands",
25+
},
26+
{
27+
icon: "sqlite-stacked",
28+
title: "SQLite",
29+
description: "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
30+
href: "/docs/sqlite",
31+
},
32+
]
33+
34+
35+
<IndexPage introduction={introduction} sections={sections} />

sqlite-cloud/sdks/index.mdx

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
---
2+
title: SDKs
3+
description: Index page for sdks section
4+
category: sdks
5+
status: publish
6+
icon: docs-sdks
7+
slug: sdks
8+
---
9+
import IndexPage from "@docs-website-components/Docs/IndexPage.astro"
10+
11+
export const 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."
12+
13+
export const sections = [
14+
{
15+
icon: "docsSdkC",
16+
title: "C/C++",
17+
description: "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
18+
href: "/docs/sdk-c-introduction",
19+
},
20+
{
21+
icon: "docsSdkJs",
22+
title: "JavaScript",
23+
description: "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
24+
href: "/docs/sdk-js-introduction",
25+
},
26+
{
27+
icon: "docsSdkPython",
28+
title: "Python",
29+
description: "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
30+
href: "/docs/sdk-python-introduction",
31+
},
32+
{
33+
icon: "docsSdkGo",
34+
title: "Go",
35+
description: "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
36+
href: "/docs/sdk-go-introduction",
37+
},
38+
{
39+
icon: "docsSdkPhp",
40+
title: "PHP",
41+
description: "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
42+
href: "/docs/sdk-php-introduction",
43+
},
44+
{
45+
icon: "docsSdkSwift",
46+
title: "Swift",
47+
description: "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
48+
href: "/docs/sdk-swift-introduction",
49+
},
50+
]
51+
52+
53+
<IndexPage introduction={introduction} sections={sections} />

0 commit comments

Comments
 (0)