Skip to content

Commit 6e6c458

Browse files
committed
Updated documentation
1 parent 5941268 commit 6e6c458

28 files changed

+166
-105
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.DS_Store

sqlite-cloud/_nav.ts

Lines changed: 45 additions & 89 deletions
Original file line numberDiff line numberDiff line change
@@ -2,101 +2,56 @@ import type { SidebarNavStruct } from "@docs-website/types/sidebar-navigation";
22

33
const sidebarNav: SidebarNavStruct = [
44
{ title: "", type: "primary" },
5-
{
6-
title: "Introduction",
7-
type: "secondary",
8-
icon: "docs-star",
9-
},
5+
// ### AI ###
6+
{ title: "AI", type: "secondary", icon: "docs-star",},
7+
{ title: "Overview", filePath: "ai-overview", type: "inner", level: 0 },
8+
{ title: "SQLite-AI", filePath: "sqlite-ai", type: "inner", level: 0 },
9+
{ title: "SQLite-JS", filePath: "sqlite-js", type: "inner", level: 0 },
10+
{ title: "SQLite-Sync", filePath: "sqlite-sync", type: "inner", level: 0 },
11+
{ title: "SQLite-Vector", filePath: "sqlite-vector", type: "inner", level: 0 },
12+
{ title: "MCP (Model Context Protocol)", filePath: "mcp-server", type: "inner", level: 0 },
13+
14+
// ### CLOUD ###
15+
{ title: "Cloud", type: "secondary", icon: "docs-star",},
1016
{ title: "Overview", filePath: "overview", type: "inner", level: 0 },
17+
{ title: "Scaling", filePath: "architecture", type: "inner", level: 0 },
1118
{ title: "Getting Started", type: "inner", level: 0 },
12-
{ title: "Connecting", filePath: "connect-cluster", type: "inner", level: 1 },
13-
{
14-
title: "Creating a database",
15-
filePath: "create-database",
16-
type: "inner",
17-
level: 1,
18-
},
19-
{ title: "Writing data", filePath: "write-data", type: "inner", level: 1 },
19+
{ title: "Connecting", filePath: "connect-cluster", type: "inner", level: 1 },
20+
{ title: "Creating a database", filePath: "create-database", type: "inner", level: 1 },
21+
{ title: "Writing data", filePath: "write-data", type: "inner", level: 1 },
2022
{ title: "Quick Start Guides", type: "inner", level: 0 },
21-
{ title: "CDN", filePath: "quick-start-cdn", type: "inner", level: 1 },
22-
{ title: "Node.js", filePath: "quick-start-node", type: "inner", level: 1 },
23-
{ title: "React", filePath: "quick-start-react", type: "inner", level: 1 },
24-
{
25-
title: "React Native",
26-
filePath: "quick-start-react-native",
27-
type: "inner",
28-
level: 1,
29-
},
30-
{
31-
title: "Apollo / GraphQL",
32-
filePath: "quick-start-apollo-graphql",
33-
type: "inner",
34-
level: 1,
35-
},
36-
{ title: "Next.js", filePath: "quick-start-next", type: "inner", level: 1 },
37-
{ title: "Django", filePath: "quick-start-django", type: "inner", level: 1 },
38-
{ title: "Flask", filePath: "quick-start-flask", type: "inner", level: 1 },
39-
{
40-
title: "SQLAlchemy",
41-
filePath: "quick-start-sqlalchemy-orm",
42-
type: "inner",
43-
level: 1,
44-
},
45-
{
46-
title: "Streamlit",
47-
filePath: "quick-start-streamlit",
48-
type: "inner",
49-
level: 1,
50-
},
51-
{
52-
title: "PHP / Laravel",
53-
filePath: "quick-start-php-laravel",
54-
type: "inner",
55-
level: 1,
56-
},
57-
{ title: "Gin", filePath: "quick-start-gin", type: "inner", level: 1 },
58-
{ title: "Tutorials", type: "inner", level: 0 },
59-
{ title: "Geopoly", filePath: "tutorial-geopoly", type: "inner", level: 1 },
60-
{ title: "Integrations", type: "inner", level: 0 },
61-
{ title: "Knex.js", filePath: "knex-integration", type: "inner", level: 1 },
23+
{ title: "CDN", filePath: "quick-start-cdn", type: "inner", level: 1 },
24+
{ title: "Node.js", filePath: "quick-start-node", type: "inner", level: 1 },
25+
{ title: "React", filePath: "quick-start-react", type: "inner", level: 1 },
26+
{ title: "React Native", filePath: "quick-start-react-native", type: "inner", level: 1 },
27+
{ title: "Apollo / GraphQL", filePath: "quick-start-apollo-graphql", type: "inner", level: 1 },
28+
{ title: "Next.js", filePath: "quick-start-next", type: "inner", level: 1 },
29+
{ title: "Django", filePath: "quick-start-django", type: "inner", level: 1 },
30+
{ title: "Flask", filePath: "quick-start-flask", type: "inner", level: 1 },
31+
{ title: "SQLAlchemy", filePath: "quick-start-sqlalchemy-orm", type: "inner", level: 1 },
32+
{ title: "Streamlit", filePath: "quick-start-streamlit", type: "inner", level: 1 },
33+
{ title: "PHP / Laravel", filePath: "quick-start-php-laravel", type: "inner", level: 1 },
34+
{ title: "Gin", filePath: "quick-start-gin", type: "inner", level: 1 },
35+
{ title: "Knex.js", filePath: "quick-start-knex", type: "inner", level: 1 },
6236

37+
// ### PLATFORM ###
6338
{ title: "Platform", type: "secondary", icon: "docs-plat" },
64-
{
65-
title: "Edge Functions",
66-
filePath: "edge-functions",
67-
type: "inner",
68-
level: 0,
69-
},
70-
{ title: "Webhooks", filePath: "webhooks", type: "inner", level: 0 },
71-
{ title: "Pub/Sub", filePath: "pub-sub", type: "inner", level: 0 },
72-
{ title: "Vector", filePath: "vector", type: "inner", level: 0 },
73-
{ title: "Scaling", type: "inner", filePath: "architecture", level: 0 },
74-
{
75-
title: "Security and Access Control",
76-
filePath: "security",
77-
type: "inner",
78-
level: 0,
79-
},
80-
{
81-
title: "Row-Level Security",
82-
filePath: "rls",
83-
type: "inner",
84-
level: 0,
85-
},
86-
{ title: "OffSync", filePath: "offsync", type: "inner", level: 0 },
87-
{
88-
title: "Access Tokens",
89-
filePath: "access-tokens",
90-
type: "inner",
91-
level: 0,
92-
},
93-
{ title: "Backups", filePath: "backups", type: "inner", level: 0 },
94-
{ title: "Query Analyzer", filePath: "analyzer", type: "inner", level: 0 },
95-
{ title: "Extensions", filePath: "extensions", type: "inner", level: 0 },
96-
{ title: "Weblite", filePath: "weblite", type: "inner", level: 0 },
97-
{ title: "AI - Model Context Protocol (MCP)", filePath: "mcp-server", type: "inner", level: 0 },
39+
{ title: "Edge Functions", filePath: "edge-functions", type: "inner", level: 0 },
40+
{ title: "Webhooks", filePath: "webhooks", type: "inner", level: 0 },
41+
{ title: "Pub/Sub", filePath: "pub-sub", type: "inner", level: 0 },
42+
//{ title: "Vector", filePath: "vector", type: "inner", level: 0 },
43+
{ title: "Users and Roles", filePath: "security", type: "inner", level: 0 },
44+
{ title: "API Keys", filePath: "apikey", type: "inner", level: 0 },
45+
{ title: "Row-Level Security", filePath: "rls", type: "inner", level: 0},
46+
{ title: "OffSync", filePath: "offsync", type: "inner", level: 0 },
47+
{ title: "Access Tokens", filePath: "access-tokens", type: "inner", level: 0 },
48+
{ title: "Backups", filePath: "backups", type: "inner", level: 0 },
49+
{ title: "Query Analyzer", filePath: "analyzer", type: "inner", level: 0 },
50+
{ title: "Extensions", filePath: "extensions", type: "inner", level: 0 },
51+
{ title: "Weblite (REST API)", filePath: "weblite", type: "inner", level: 0 },
9852

99-
{ title: "SDKs", type: "secondary", icon: "docs-sdk" },
53+
// ### CLOUD SDK ###
54+
{ title: "Cloud SDK", type: "secondary", icon: "docs-sdk" },
10055
{ title: "C/C++", type: "inner", level: 0 },
10156
{
10257
title: "Introduction",
@@ -578,6 +533,7 @@ const sidebarNav: SidebarNavStruct = [
578533
level: 1,
579534
},
580535

536+
// ### REFERENCE ###
581537
{ title: "Reference", type: "secondary", icon: "docs-ref" },
582538
{ title: "Server-side Commands", type: "inner", level: 0 },
583539
{
File renamed without changes.
File renamed without changes.

sqlite-cloud/platform/apikey.mdx

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
title: Security and Access Control
3+
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.
16+
17+
![Dashboard Create APIKEY](@docs-website-assets/introduction/dashboard_create_apikey.png)
18+
19+
The resulting table will display all the API keys associated with each user, along with their name and restrictions.
20+
![Dashboard List APIKEY](@docs-website-assets/introduction/dashboard_list_apikey.png)

sqlite-cloud/platform/extensions.mdx

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,17 @@ status: publish
66
slug: extensions
77
---
88

9-
SQLite Cloud comes with the following pre-installed SQLite extensions. These extensions are available for use in your SQLite Cloud databases.
9+
SQLite Cloud comes with the following pre-installed SQLite extensions.
10+
These extensions are available for use in your SQLite Cloud databases.
1011

1112
## Extensions
13+
- **[SQLite-Vector](sqlite-vector)**: High performance vector storage extension for similarity search.
14+
- **[SQLite-Sync](sqlite-sync)**: Local-first extension for true local-first data synchronization for your applications.
15+
- **[SQLite-JS](sqlite-js)**: Enables JavaScript integration in SQLite for executing server-side logic.
1216
- **[Full-text Search 5](https://www.sqlite.org/fts5.html)**: Full-text search engine that allows you to search for text in a database.
1317
- **[JSON1](https://www.sqlite.org/json1.html)**: Allows you to easily store, query, and manipulate JSON data.
1418
- **[Math](https://www.sqlite.org/lang_mathfunc.html)**: Mathematical functions.
1519
- **[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).
1821

1922
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).

sqlite-cloud/platform/security.mdx

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ A role can contains any combination of privileges.
148148
-----------------|
149149
```
150150

151-
151+
{/*
152152
## IP Restrictions
153153
The IP Restrictions panel enables the restriction of access for a role or user by allowing only specific IP addresses or ranges in [CIDR notation](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) (for example 10.10.10.0/24). Both IPv4 and IPv6 addresses are supported.
154154
@@ -159,14 +159,4 @@ To add a new IP restriction to a user or role, click on the **Add IP** button.
159159
The IP Restrictions table will display all current IP restrictions for the selected user or role.
160160
161161
![Dashboard List IP Restrictions](@docs-website-assets/introduction/dashboard_list_ip.png)
162-
163-
## API KEYs
164-
165-
API KEYs can be used as an alternative authentication mechanism. Authentication through API keys ensures the same privileges as the user to which they are associated. 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.
166-
167-
To create an API key for a user, click on the **Create API KEY** button.
168-
169-
![Dashboard Create APIKEY](@docs-website-assets/introduction/dashboard_create_apikey.png)
170-
171-
The resulting table will display all the API keys associated with each user, along with their name and restrictions.
172-
![Dashboard List APIKEY](@docs-website-assets/introduction/dashboard_list_apikey.png)
162+
*/}
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)