@@ -77,8 +70,8 @@ We have a list of [good first issues](https://github.com/surrealdb/docs.surreald
To get started with contributing to the SurrealDB documentation, first install the required packages using the following command.
-```
-$ pnpm install
+```bash
+bun i
```
### Development
@@ -86,7 +79,7 @@ $ pnpm install
The following command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
```
-$ pnpm start
+bun dev
```
### Building
@@ -94,5 +87,5 @@ $ pnpm start
The following command builds and generates static content into the `build` directory, and can then be served using any static contents hosting service.
```
-$ pnpm build
+bun build
```
diff --git a/src/assets/img/black/logo.svg b/src/assets/img/black/logo.svg
new file mode 100644
index 000000000..3b2d1afa6
--- /dev/null
+++ b/src/assets/img/black/logo.svg
@@ -0,0 +1,53 @@
+
+
+
diff --git a/src/assets/img/black/text.svg b/src/assets/img/black/text.svg
new file mode 100644
index 000000000..5a8ebb3de
--- /dev/null
+++ b/src/assets/img/black/text.svg
@@ -0,0 +1,41 @@
+
+
+
diff --git a/src/assets/img/social/blog.svg b/src/assets/img/social/blog.svg
new file mode 100644
index 000000000..c66ccc5a1
--- /dev/null
+++ b/src/assets/img/social/blog.svg
@@ -0,0 +1,14 @@
+
+
+
diff --git a/src/assets/img/social/dev.svg b/src/assets/img/social/dev.svg
new file mode 100644
index 000000000..46c7bf7aa
--- /dev/null
+++ b/src/assets/img/social/dev.svg
@@ -0,0 +1,14 @@
+
+
+
diff --git a/src/assets/img/social/discord.svg b/src/assets/img/social/discord.svg
new file mode 100644
index 000000000..209d067de
--- /dev/null
+++ b/src/assets/img/social/discord.svg
@@ -0,0 +1,18 @@
+
+
+
diff --git a/src/assets/img/social/github.svg b/src/assets/img/social/github.svg
new file mode 100644
index 000000000..7dd88f864
--- /dev/null
+++ b/src/assets/img/social/github.svg
@@ -0,0 +1,22 @@
+
+
+
diff --git a/src/assets/img/social/linkedin.svg b/src/assets/img/social/linkedin.svg
new file mode 100644
index 000000000..614b0074a
--- /dev/null
+++ b/src/assets/img/social/linkedin.svg
@@ -0,0 +1,12 @@
+
+
+
diff --git a/src/assets/img/social/stack-overflow.svg b/src/assets/img/social/stack-overflow.svg
new file mode 100644
index 000000000..443448c0f
--- /dev/null
+++ b/src/assets/img/social/stack-overflow.svg
@@ -0,0 +1,11 @@
+
+
+
diff --git a/src/assets/img/social/twitter.svg b/src/assets/img/social/twitter.svg
new file mode 100644
index 000000000..54b1dc0c6
--- /dev/null
+++ b/src/assets/img/social/twitter.svg
@@ -0,0 +1,14 @@
+
+
+
diff --git a/src/assets/img/social/youtube.svg b/src/assets/img/social/youtube.svg
new file mode 100644
index 000000000..7f664a7e9
--- /dev/null
+++ b/src/assets/img/social/youtube.svg
@@ -0,0 +1,12 @@
+
+
+
diff --git a/src/assets/img/white/logo.svg b/src/assets/img/white/logo.svg
new file mode 100644
index 000000000..8f25d9aae
--- /dev/null
+++ b/src/assets/img/white/logo.svg
@@ -0,0 +1,53 @@
+
+
+
diff --git a/src/assets/img/white/text.svg b/src/assets/img/white/text.svg
new file mode 100644
index 000000000..9c556a7f0
--- /dev/null
+++ b/src/assets/img/white/text.svg
@@ -0,0 +1,41 @@
+
+
+
diff --git a/src/content/doc-sdk-dotnet/setup.mdx b/src/content/doc-sdk-dotnet/setup.mdx
index 5c46f6237..9ab0979b5 100644
--- a/src/content/doc-sdk-dotnet/setup.mdx
+++ b/src/content/doc-sdk-dotnet/setup.mdx
@@ -280,7 +280,7 @@ new SurrealDbClient(endpoint)
httpClientFactory
- OPTIONAL
+
An IHttpClientFactory instance.
@@ -320,7 +320,7 @@ db.Configure(ns, db, credentials)
ns
- OPTIONAL
+
The table namespace to use.
@@ -329,7 +329,7 @@ db.Configure(ns, db, credentials)
db
- OPTIONAL
+
The table database to use.
@@ -338,7 +338,7 @@ db.Configure(ns, db, credentials)
username
- OPTIONAL
+
The username with root access.
@@ -347,7 +347,7 @@ db.Configure(ns, db, credentials)
password
- OPTIONAL
+
The password with root access.
@@ -356,7 +356,7 @@ db.Configure(ns, db, credentials)
token
- OPTIONAL
+
The value of the JWT token.
@@ -400,7 +400,7 @@ await db.Connect()
cancellationToken
- OPTIONAL
+
The cancellationToken enables graceful cancellation of asynchronous operations.
@@ -685,7 +685,7 @@ await db.Invalidate()
cancellationToken
- OPTIONAL
+
The cancellationToken enables graceful cancellation of asynchronous operations.
@@ -721,7 +721,7 @@ await db.Info()
cancellationToken
- OPTIONAL
+
The cancellationToken enables graceful cancellation of asynchronous operations.
@@ -775,7 +775,7 @@ await db.Set(key, val)
cancellationToken
- OPTIONAL
+
The cancellationToken enables graceful cancellation of asynchronous operations.
@@ -827,7 +827,7 @@ await db.Unset(key)
cancellationToken
- OPTIONAL
+
The cancellationToken enables graceful cancellation of asynchronous operations.
@@ -872,7 +872,7 @@ await db.Query(sql)
cancellationToken
- OPTIONAL
+
The cancellationToken enables graceful cancellation of asynchronous operations.
@@ -925,7 +925,7 @@ await db.RawQuery(sql, params)
params
- OPTIONAL
+
Assigns variables which can be used in the query.
@@ -934,7 +934,7 @@ await db.RawQuery(sql, params)
cancellationToken
- OPTIONAL
+
The cancellationToken enables graceful cancellation of asynchronous operations.
@@ -987,7 +987,7 @@ await db.Select(resource)
cancellationToken
- OPTIONAL
+
The cancellationToken enables graceful cancellation of asynchronous operations.
@@ -1039,7 +1039,7 @@ await db.Create(resource, data)
data
- OPTIONAL
+
The document / record data to insert.
@@ -1048,7 +1048,7 @@ await db.Create(resource, data)
cancellationToken
- OPTIONAL
+
The cancellationToken enables graceful cancellation of asynchronous operations.
@@ -1114,7 +1114,7 @@ await db.Upsert(data)
cancellationToken
- OPTIONAL
+
The cancellationToken enables graceful cancellation of asynchronous operations.
@@ -1183,7 +1183,7 @@ await db.UpdateAll(table, data)
cancellationToken
- OPTIONAL
+
The cancellationToken enables graceful cancellation of asynchronous operations.
@@ -1238,7 +1238,7 @@ await db.Merge(resource, data)
data
- OPTIONAL
+
The data with which to modify the records.
@@ -1247,7 +1247,7 @@ await db.Merge(resource, data)
cancellationToken
- OPTIONAL
+
The cancellationToken enables graceful cancellation of asynchronous operations.
@@ -1310,7 +1310,7 @@ await db.MergeAll(table, data)
data
- OPTIONAL
+
The data with which to modify the records.
@@ -1319,7 +1319,7 @@ await db.MergeAll(table, data)
cancellationToken
- OPTIONAL
+
The cancellationToken enables graceful cancellation of asynchronous operations.
@@ -1384,7 +1384,7 @@ await db.Patch(resource, data)
data
- OPTIONAL
+
The JSON Patch data with which to patch the records.
@@ -1393,7 +1393,7 @@ await db.Patch(resource, data)
cancellationToken
- OPTIONAL
+
The cancellationToken enables graceful cancellation of asynchronous operations.
@@ -1441,7 +1441,7 @@ await db.PatchAll(table, data)
data
- OPTIONAL
+
The JSON Patch data with which to patch the records.
@@ -1450,7 +1450,7 @@ await db.PatchAll(table, data)
cancellationToken
- OPTIONAL
+
The cancellationToken enables graceful cancellation of asynchronous operations.
@@ -1495,7 +1495,7 @@ await db.Delete(resource)
cancellationToken
- OPTIONAL
+
The cancellationToken enables graceful cancellation of asynchronous operations.
@@ -1599,7 +1599,7 @@ await db.LiveQuery(sql)
cancellationToken
- OPTIONAL
+
The cancellationToken enables graceful cancellation of asynchronous operations.
@@ -1647,7 +1647,7 @@ await db.LiveRawQuery(sql, params)
params
- OPTIONAL
+
Assigns variables which can be used in the query.
@@ -1656,7 +1656,7 @@ await db.LiveRawQuery(sql, params)
cancellationToken
- OPTIONAL
+
The cancellationToken enables graceful cancellation of asynchronous operations.
@@ -1703,7 +1703,7 @@ await db.LiveTable(table, diff)
diff
- OPTIONAL
+
If set to true, live notifications will include an array of JSON Patch objects, rather than the entire record for each notification.
@@ -1712,7 +1712,7 @@ await db.LiveTable(table, diff)
cancellationToken
- OPTIONAL
+
The cancellationToken enables graceful cancellation of asynchronous operations.
@@ -1759,7 +1759,7 @@ await db.Kill(queryUuid)
cancellationToken
- OPTIONAL
+
The cancellationToken enables graceful cancellation of asynchronous operations.
@@ -1795,7 +1795,7 @@ await db.Version()
cancellationToken
- OPTIONAL
+
The cancellationToken enables graceful cancellation of asynchronous operations.
@@ -1831,7 +1831,7 @@ await db.Health()
cancellationToken
- OPTIONAL
+
The cancellationToken enables graceful cancellation of asynchronous operations.
@@ -2007,7 +2007,7 @@ In general, it is known as a best practice to:
Namespace
- OPTIONAL
+
Switches to a specific namespace.
@@ -2019,7 +2019,7 @@ In general, it is known as a best practice to:
Database
- OPTIONAL
+
Switches to a specific database.
@@ -2031,7 +2031,7 @@ In general, it is known as a best practice to:
Username
- OPTIONAL
+
Username used to have root access.
@@ -2043,7 +2043,7 @@ In general, it is known as a best practice to:
Password
- OPTIONAL
+
Password used to have root access.
@@ -2055,7 +2055,7 @@ In general, it is known as a best practice to:
Token
- OPTIONAL
+
Token (JWT) used to have user access.
@@ -2067,7 +2067,7 @@ In general, it is known as a best practice to:
NamingPolicy
- OPTIONAL
+
Naming policy used to interact with the database.
diff --git a/src/content/doc-sdk-golang/setup.mdx b/src/content/doc-sdk-golang/setup.mdx
index da3ecb918..582d5fbbd 100644
--- a/src/content/doc-sdk-golang/setup.mdx
+++ b/src/content/doc-sdk-golang/setup.mdx
@@ -249,7 +249,7 @@ surrealdb.New(url, options...)()
options
- OPTIONAL
+
Set SurrealDB clients options such as Timeout etc.
@@ -544,7 +544,7 @@ db.Query(sql, vars)
vars
- OPTIONAL
+
Assigns variables which can be used in the query.
@@ -592,7 +592,7 @@ db.Create(thing, data)
data
- OPTIONAL
+
The document / record data to insert.
@@ -725,7 +725,7 @@ db.Update(what, data)
data
- OPTIONAL
+
The document / record data to insert.
@@ -789,7 +789,7 @@ db.Change(what, data)
data
- OPTIONAL
+
The document / record data to insert.
@@ -855,7 +855,7 @@ db.Modify(what, data)
data
- OPTIONAL
+
The JSON Patch data with which to modify the records.
diff --git a/src/content/doc-sdk-javascript/core/data-querying.mdx b/src/content/doc-sdk-javascript/core/data-querying.mdx
index 4ea0303ad..3754fffb1 100644
--- a/src/content/doc-sdk-javascript/core/data-querying.mdx
+++ b/src/content/doc-sdk-javascript/core/data-querying.mdx
@@ -39,7 +39,7 @@ async db.query(query, vars)
vars
- OPTIONAL
+
Assigns variables which can be used in the query.
@@ -171,7 +171,7 @@ async db.create(thing, data)
data
- OPTIONAL
+
The document / record data to create.
@@ -253,7 +253,7 @@ async db.insert(thing, data)
data
- OPTIONAL
+
Either a single document/record or an array of documents/records to insert
@@ -360,7 +360,7 @@ async db.update(thing, data)
data
- OPTIONAL
+
The document / record data to update.
@@ -443,7 +443,7 @@ async db.merge(thing, data)
data
- OPTIONAL
+
The document / record data to merge.
@@ -528,7 +528,7 @@ async db.patch(thing, data)
data
- OPTIONAL
+
The JSON Patch data with which to patch the records.
diff --git a/src/content/doc-sdk-javascript/core/streaming.mdx b/src/content/doc-sdk-javascript/core/streaming.mdx
index 9ac550622..f34d61167 100644
--- a/src/content/doc-sdk-javascript/core/streaming.mdx
+++ b/src/content/doc-sdk-javascript/core/streaming.mdx
@@ -41,7 +41,7 @@ async db.live(table, callback, diff)
callback
- OPTIONAL
+
A callback function that processes live notifications. Consult the [Live Actions](#live-actions) for a list of all possible values being returned.
@@ -50,7 +50,7 @@ async db.live(table, callback, diff)
diff
- OPTIONAL
+
If set to true, live notifications will include an array of JSON Patch objects, rather than the entire record for each notification.
diff --git a/src/content/doc-sdk-php/methods/create.mdx b/src/content/doc-sdk-php/methods/create.mdx
index 6b0eb22ac..3e538ba77 100644
--- a/src/content/doc-sdk-php/methods/create.mdx
+++ b/src/content/doc-sdk-php/methods/create.mdx
@@ -36,7 +36,7 @@ $db->create(thing, data)
data
- OPTIONAL
+
The document / record data to create.
diff --git a/src/content/doc-sdk-php/methods/insert.mdx b/src/content/doc-sdk-php/methods/insert.mdx
index 11704e2ec..7481e9d80 100644
--- a/src/content/doc-sdk-php/methods/insert.mdx
+++ b/src/content/doc-sdk-php/methods/insert.mdx
@@ -36,7 +36,7 @@ $db->insert(thing, data)
data
- OPTIONAL
+
Either a single document/record or an array of documents/records to insert
diff --git a/src/content/doc-sdk-php/methods/merge.mdx b/src/content/doc-sdk-php/methods/merge.mdx
index e58b14d70..21d9c4d4e 100644
--- a/src/content/doc-sdk-php/methods/merge.mdx
+++ b/src/content/doc-sdk-php/methods/merge.mdx
@@ -39,7 +39,7 @@ $db->merge(thing, data)
data
- OPTIONAL
+
The document / record data to merge.
diff --git a/src/content/doc-sdk-php/methods/patch.mdx b/src/content/doc-sdk-php/methods/patch.mdx
index ea560e4e1..bc2faa747 100644
--- a/src/content/doc-sdk-php/methods/patch.mdx
+++ b/src/content/doc-sdk-php/methods/patch.mdx
@@ -40,7 +40,7 @@ $db->patch(thing, data)
data
- OPTIONAL
+
The JSON Patch data with which to patch the records.
diff --git a/src/content/doc-sdk-php/methods/query.mdx b/src/content/doc-sdk-php/methods/query.mdx
index 1d2503f87..61c0f0082 100644
--- a/src/content/doc-sdk-php/methods/query.mdx
+++ b/src/content/doc-sdk-php/methods/query.mdx
@@ -36,7 +36,7 @@ $db->query($query, $vars)
$vars
- OPTIONAL
+
Assigns variables which can be used in the query.
diff --git a/src/content/doc-sdk-php/methods/update.mdx b/src/content/doc-sdk-php/methods/update.mdx
index cde9da155..60986491b 100644
--- a/src/content/doc-sdk-php/methods/update.mdx
+++ b/src/content/doc-sdk-php/methods/update.mdx
@@ -39,7 +39,7 @@ $db->update(thing, data)
data
- OPTIONAL
+
The document / record data to update.
diff --git a/src/content/doc-sdk-python/setup.mdx b/src/content/doc-sdk-python/setup.mdx
index 81bb4811e..8a7b542e9 100644
--- a/src/content/doc-sdk-python/setup.mdx
+++ b/src/content/doc-sdk-python/setup.mdx
@@ -592,7 +592,7 @@ db.query(sql, vars)
vars
- OPTIONAL
+
Assigns variables which can be used in the query.
@@ -755,7 +755,7 @@ db.update(thing, data)
data
- OPTIONAL
+
The document / record data to insert.
@@ -819,7 +819,7 @@ db.merge(thing, data)
data
- OPTIONAL
+
The document / record data to insert.
@@ -884,7 +884,7 @@ db.patch(thing, data)
data
- OPTIONAL
+
The JSON Patch data with which to modify the records.
diff --git a/src/content/doc-sdk-rust/setup.mdx b/src/content/doc-sdk-rust/setup.mdx
index 4ba5617c2..aa907b614 100644
--- a/src/content/doc-sdk-rust/setup.mdx
+++ b/src/content/doc-sdk-rust/setup.mdx
@@ -611,7 +611,7 @@ db.query(sql).bind(vars)
vars
- OPTIONAL
+
Assigns variables which can be used in the query.
@@ -810,7 +810,7 @@ db.create(resource).content(data)
data
- OPTIONAL
+
The document / record data to insert.
@@ -876,7 +876,7 @@ db.update(resource).content(data)
data
- OPTIONAL
+
The document / record data to insert.
@@ -942,7 +942,7 @@ db.update(resource).merge(data)
data
- OPTIONAL
+
The document / record data to insert.
@@ -1011,7 +1011,7 @@ db.update(resource).patch(data)
data
- OPTIONAL
+
The JSON Patch data with which to modify the records.
diff --git a/src/content/doc-surrealdb/cli/export.mdx b/src/content/doc-surrealdb/cli/export.mdx
index 0dbd35a75..4ced52bcf 100644
--- a/src/content/doc-surrealdb/cli/export.mdx
+++ b/src/content/doc-surrealdb/cli/export.mdx
@@ -27,7 +27,7 @@ The export command exports a SurrealQL script file from a local or remote Surrea
-e / --endpoint / --conn
- OPTIONAL
+
Sets the url of the database server to connect to
@@ -54,7 +54,7 @@ The export command exports a SurrealQL script file from a local or remote Surrea
-t / --token
- OPTIONAL
+
Sets the authentication token to use when connecting to the server. Connect to SurrealDB using a JWT instead of user credentials
diff --git a/src/content/doc-surrealdb/cli/fix.mdx b/src/content/doc-surrealdb/cli/fix.mdx
index 41bdda39a..9cd5f7442 100644
--- a/src/content/doc-surrealdb/cli/fix.mdx
+++ b/src/content/doc-surrealdb/cli/fix.mdx
@@ -5,6 +5,8 @@ title: Fix command | CLI tool
description: The fix command converts SurrealDB version 1.x data into a format that can be used in SurrealDB 2.0
---
+import Label from "@components/shared/Label.astro";
+
# Fix command
The fix command converts SurrealDB version 1.x data into a format that can be used in SurrealDB 2.0
@@ -25,7 +27,7 @@ The fix command converts SurrealDB version 1.x data into a format that can be us
-e / --log
- OPTIONAL
+
Sets the logging level during the command
diff --git a/src/content/doc-surrealdb/cli/import.mdx b/src/content/doc-surrealdb/cli/import.mdx
index a4a722fbb..c67f07030 100644
--- a/src/content/doc-surrealdb/cli/import.mdx
+++ b/src/content/doc-surrealdb/cli/import.mdx
@@ -27,7 +27,7 @@ The import command imports a SurrealQL script file into a local or remote Surrea
-e / --endpoint / --conn
- OPTIONAL
+
Sets the url of the database server to connect to
@@ -54,7 +54,7 @@ The import command imports a SurrealQL script file into a local or remote Surrea
-t / --token
- OPTIONAL
+
Sets the authentication token to use when connecting to the server. Connect to SurrealDB using a JWT instead of user credentials
diff --git a/src/content/doc-surrealdb/cli/isready.mdx b/src/content/doc-surrealdb/cli/isready.mdx
index 584bf9245..afe893786 100644
--- a/src/content/doc-surrealdb/cli/isready.mdx
+++ b/src/content/doc-surrealdb/cli/isready.mdx
@@ -4,6 +4,7 @@ sidebar_label: Isready command
title: Isready command | CLI tool
description: The isready command attempts to connect to a remote SurrealDB server to detect if it has successfully started.
---
+import Label from "@components/shared/Label.astro";
# Isready command
@@ -25,7 +26,7 @@ The isready command attempts to connect to a remote SurrealDB server to detect i
-e / --endpoint / --conn
- OPTIONAL
+
Sets the url of the database server to connect to
diff --git a/src/content/doc-surrealdb/cli/ml/export.mdx b/src/content/doc-surrealdb/cli/ml/export.mdx
index 6e3b416fa..6c113df65 100644
--- a/src/content/doc-surrealdb/cli/ml/export.mdx
+++ b/src/content/doc-surrealdb/cli/ml/export.mdx
@@ -27,7 +27,7 @@ The ML export command is used to export an existing machine learning model from
-e, --endpoint / --conn
- OPTIONAL
+
Sets the url of the database server to connect to
@@ -54,7 +54,7 @@ The ML export command is used to export an existing machine learning model from
-t / --token
- OPTIONAL
+
Sets the authentication token to use when connecting to the server. Connect to SurrealDB using a JWT instead of user credentials
diff --git a/src/content/doc-surrealdb/cli/ml/import.mdx b/src/content/doc-surrealdb/cli/ml/import.mdx
index f42d8c818..10c5ed539 100644
--- a/src/content/doc-surrealdb/cli/ml/import.mdx
+++ b/src/content/doc-surrealdb/cli/ml/import.mdx
@@ -28,7 +28,7 @@ The ML import command is used to import a new machine learning model into Surrea
-e, --endpoint / --conn
- OPTIONAL
+
Sets the url of the database server to connect to
@@ -64,7 +64,7 @@ The ML import command is used to import a new machine learning model into Surrea
-t / --token
- OPTIONAL
+
Sets the authentication token to use when connecting to the server. Connect to SurrealDB using a JWT instead of user credentials
diff --git a/src/content/doc-surrealdb/cli/sql.mdx b/src/content/doc-surrealdb/cli/sql.mdx
index de338ad8d..792061a6a 100644
--- a/src/content/doc-surrealdb/cli/sql.mdx
+++ b/src/content/doc-surrealdb/cli/sql.mdx
@@ -27,7 +27,7 @@ The SQL command starts a REPL for running or piping SurrealQL queries to a local
-e / --endpoint / --conn
- OPTIONAL
+
Sets the url of the database server to connect to
@@ -54,7 +54,7 @@ The SQL command starts a REPL for running or piping SurrealQL queries to a local
--ns
- OPTIONAL
+
Sets the desired namespace in which to import data
@@ -63,7 +63,7 @@ The SQL command starts a REPL for running or piping SurrealQL queries to a local
--db
- OPTIONAL
+
Sets the desired database into which to import data
@@ -72,7 +72,7 @@ The SQL command starts a REPL for running or piping SurrealQL queries to a local
--auth-level
- OPTIONAL
+
The authentication level to use when connecting to the server.
@@ -81,7 +81,7 @@ The SQL command starts a REPL for running or piping SurrealQL queries to a local
-t / --token
- OPTIONAL
+
Sets the authentication token to use when connecting to the server. Connect to SurrealDB using a JWT instead of user credentials
@@ -90,7 +90,7 @@ The SQL command starts a REPL for running or piping SurrealQL queries to a local
--pretty
- OPTIONAL
+
Sets whether database responses should be pretty printed
@@ -99,7 +99,7 @@ The SQL command starts a REPL for running or piping SurrealQL queries to a local
--json
- OPTIONAL
+
Sets whether to emit results in JSON
@@ -108,7 +108,7 @@ The SQL command starts a REPL for running or piping SurrealQL queries to a local
--multi
- OPTIONAL
+
Sets whether omitting semicolon causes a newline
@@ -117,7 +117,7 @@ The SQL command starts a REPL for running or piping SurrealQL queries to a local
-h / --help
- OPTIONAL
+
Prints help
diff --git a/src/content/doc-surrealdb/cli/start.mdx b/src/content/doc-surrealdb/cli/start.mdx
index 8f063f4c7..e34e6e27f 100644
--- a/src/content/doc-surrealdb/cli/start.mdx
+++ b/src/content/doc-surrealdb/cli/start.mdx
@@ -5,6 +5,7 @@ title: Start command | CLI tool
description: The start command starts a SurrealDB server in memory, on disk, or in a distributed setup.
---
import Since from '@components/Since.astro'
+import Label from "@components/shared/Label.astro";
# Start command
@@ -26,7 +27,7 @@ The start command starts a SurrealDB server in memory, on disk, or in a distribu
-b / --bind
- OPTIONAL
+
Sets the hostname or IP address to listen for connections on
@@ -35,7 +36,7 @@ The start command starts a SurrealDB server in memory, on disk, or in a distribu
-l / --log
- OPTIONAL
+
Sets the logging level for the database server
@@ -44,7 +45,7 @@ The start command starts a SurrealDB server in memory, on disk, or in a distribu
-u / --user
- OPTIONAL
+
Sets master username for the database
@@ -53,7 +54,7 @@ The start command starts a SurrealDB server in memory, on disk, or in a distribu
-p / --pass
- OPTIONAL
+
Sets master password for the database
@@ -62,7 +63,7 @@ The start command starts a SurrealDB server in memory, on disk, or in a distribu
--unauthenticated
- OPTIONAL
+
Whether to allow unauthenticated access
@@ -71,7 +72,7 @@ The start command starts a SurrealDB server in memory, on disk, or in a distribu
--no-identification-headers
- OPTIONAL
+
Whether to suppress the server name and version headers
@@ -80,7 +81,7 @@ The start command starts a SurrealDB server in memory, on disk, or in a distribu
-s / --strict
- OPTIONAL
+
Sets whether strict mode is enabled on this database instance
@@ -110,7 +111,7 @@ file:// is deprecated, please use surrealkv:// or rocksdb://
path
- OPTIONAL
+
Sets the the path for storing data. If no argument is given, the default of `memory` for non-persistent storage in memory is assumed.
diff --git a/src/content/doc-surrealdb/cli/upgrade.mdx b/src/content/doc-surrealdb/cli/upgrade.mdx
index 45e7ae5a3..4e9ca9829 100644
--- a/src/content/doc-surrealdb/cli/upgrade.mdx
+++ b/src/content/doc-surrealdb/cli/upgrade.mdx
@@ -6,6 +6,7 @@ description: The upgrade command upgrades SurrealDB to the latest version, night
---
import Since from '@components/Since.astro'
+import Label from "@components/shared/Label.astro";
# Upgrade command
@@ -28,7 +29,7 @@ The upgrade command upgrades SurrealDB to the latest version, nightly or a speci
--nightly
- OPTIONAL
+
installs the latest nightly version of SurrealDB
@@ -37,7 +38,7 @@ The upgrade command upgrades SurrealDB to the latest version, nightly or a speci
--alpha
- OPTIONAL
+
installs the latest alpha version of SurrealDB
@@ -46,7 +47,7 @@ The upgrade command upgrades SurrealDB to the latest version, nightly or a speci
--beta
- OPTIONAL
+
installs the latest beta version of SurrealDB
@@ -55,7 +56,7 @@ The upgrade command upgrades SurrealDB to the latest version, nightly or a speci
--version
- OPTIONAL
+
installs a specific version of SurrealDB
@@ -64,7 +65,7 @@ The upgrade command upgrades SurrealDB to the latest version, nightly or a speci
--dry-run
- OPTIONAL
+
Does not actually replace the currently installed version of SurrealDB.
diff --git a/src/content/doc-surrealdb/cli/version.mdx b/src/content/doc-surrealdb/cli/version.mdx
index 2ab6f3318..db10bff8c 100644
--- a/src/content/doc-surrealdb/cli/version.mdx
+++ b/src/content/doc-surrealdb/cli/version.mdx
@@ -5,6 +5,7 @@ title: Version command | CLI tool
description: The version command outputs the current version of the installed command-line tool, and the machine architecture.
---
import Since from '@components/Since.astro'
+import Label from "@components/shared/Label.astro";
# Version command
@@ -26,7 +27,7 @@ The version command outputs the current version of the installed command-line to
-e / --endpoint
- OPTIONAL
+
Remote database server url to connect to [aliases: conn]
diff --git a/src/content/doc-surrealdb/embedding/rust.mdx b/src/content/doc-surrealdb/embedding/rust.mdx
index 7d94acfd5..fec339a47 100644
--- a/src/content/doc-surrealdb/embedding/rust.mdx
+++ b/src/content/doc-surrealdb/embedding/rust.mdx
@@ -612,7 +612,7 @@ db.query(sql).bind(vars)
vars
- OPTIONAL
+
Assigns variables which can be used in the query.
@@ -715,7 +715,7 @@ db.create(resource).content(data)
data
- OPTIONAL
+
The document / record data to insert.
@@ -781,7 +781,7 @@ db.update(resource).content(data)
data
- OPTIONAL
+
The document / record data to insert.
@@ -847,7 +847,7 @@ db.update(resource).merge(data)
data
- OPTIONAL
+
The document / record data to insert.
@@ -916,7 +916,7 @@ db.update(resource).patch(data)
data
- OPTIONAL
+
The JSON Patch data with which to modify the records.
diff --git a/src/content/doc-surrealdb/integration/http.mdx b/src/content/doc-surrealdb/integration/http.mdx
index 2a5d6b5d3..c9f94fa99 100644
--- a/src/content/doc-surrealdb/integration/http.mdx
+++ b/src/content/doc-surrealdb/integration/http.mdx
@@ -629,46 +629,46 @@ This HTTP RESTful endpoint is used to create an account inside the SurrealDB dat
ns
-
+
- The namespace to sign up to
+ The namespace to sign up to. This data is `REQUIRED FOR DB & RECORD`
db
-
+
- The database to sign up to
+ The database to sign up to. This data is `REQUIRED FOR RECORD`
access
-
+
- The record access method to use for signing up.
+ The record access method to use for signing up. This data is `REQUIRED FOR RECORD`
user
-
+
- The username of the database user
+ The username of the database user. This data is `REQUIRED FOR ROOT, NS & DB`
pass
-
+
- The password of the database user
+ The password of the database user. This data is `REQUIRED FOR ROOT, NS & DB`
- The namespace to sign in to
+ The namespace to sign in to. This data is `REQUIRED FOR DB & RECORD`
DB
- REQUIRED FOR RECORD
+
- The database to sign in to
+ The database to sign in to. This data is `REQUIRED FOR RECORD`
AC
+
- Specifies the access method
+ Specifies the access method. This data is `REQUIRED FOR RECORD`
user
- REQUIRED FOR ROOT, NS & DB
+
- The username of the database user
+ The username of the database user. This data is `REQUIRED FOR ROOT, NS & DB`
pass
- REQUIRED FOR ROOT, NS & DB
+
- The password of the database user
+ The password of the database user. This data is `REQUIRED FOR ROOT, NS & DB`
@@ -429,6 +430,7 @@ signin [ NS, DB, AC, ... ]
### Example with Root user
```json title="Request"
+{
"id": 1,
"method": "signin",
"params": [
@@ -447,7 +449,7 @@ signin [ NS, DB, AC, ... ]
}
```
-### Example with Scope user
+### Example with Record user
```json title="Request"
{
@@ -682,7 +684,7 @@ live[ table ]
diff
- OPTIONAL
+
If set to true, live notifications will contain an array of [JSON Patches](https://jsonpatch.com) instead of the entire record
@@ -802,7 +804,7 @@ query [ sql, vars ]
vars
- OPTIONAL
+
A set of variables used by the query
@@ -883,7 +885,7 @@ run [ func_name, version?, args? ]
version
- OPTIONAL
+
The version of the function or model to execute.
@@ -892,7 +894,7 @@ run [ func_name, version?, args? ]
args
- OPTIONAL
+
The arguments to pass to the function or model.
@@ -991,7 +993,7 @@ graphql [ query, options? ]
options
- OPTIONAL
+
An object specifying options like `pretty` output or response `format`.
@@ -1000,7 +1002,7 @@ graphql [ query, options? ]
pretty
- OPTIONAL
+
A boolean indicating whether the output should be pretty-printed.
@@ -1213,7 +1215,7 @@ create [ thing, data ]
data
- OPTIONAL
+
The content of the record
@@ -1279,7 +1281,7 @@ insert [ thing, data ]
data
- OPTIONAL
+
One or multiple record(s)
@@ -1589,7 +1591,7 @@ update [ thing, data ]
data
- OPTIONAL
+
The content of the record
@@ -1651,7 +1653,7 @@ upsert [ thing, data ]
data
- OPTIONAL
+
The content of the record
@@ -1736,7 +1738,7 @@ relate [ in, relation, out, data? ]
data
- OPTIONAL
+
The content of the record
@@ -1830,7 +1832,7 @@ merge [ thing, data ]
data
- OPTIONAL
+
The content of the record
@@ -1914,7 +1916,7 @@ patch [ thing, patches, diff ]
diff
- OPTIONAL
+
A boolean representing if just a diff should be returned.
diff --git a/src/content/doc-surrealdb/querying/graphql/http.mdx b/src/content/doc-surrealdb/querying/graphql/http.mdx
index 4f6d601d2..d8959c917 100644
--- a/src/content/doc-surrealdb/querying/graphql/http.mdx
+++ b/src/content/doc-surrealdb/querying/graphql/http.mdx
@@ -68,7 +68,7 @@ The GraphQL endpoint enables use of GraphQL queries to interact with your data.
Authorization
- OPTIONAL
+
Sets the root, namespace, database, or record authentication data
diff --git a/src/content/doc-surrealdb/querying/sdks/index.mdx b/src/content/doc-surrealdb/querying/sdks/index.mdx
index c53a92a62..f956448bf 100644
--- a/src/content/doc-surrealdb/querying/sdks/index.mdx
+++ b/src/content/doc-surrealdb/querying/sdks/index.mdx
@@ -155,7 +155,7 @@ async db.query(query, vars)
vars
- OPTIONAL
+
Assigns variables which can be used in the query.
@@ -217,7 +217,7 @@ $db->query($query, $vars)
$vars
- OPTIONAL
+
Assigns variables which can be used in the query.
@@ -268,7 +268,7 @@ db.query(sql, vars)
vars
- OPTIONAL
+
Assigns variables which can be used in the query.
@@ -317,7 +317,7 @@ await db.Query(sql)
cancellationToken
- OPTIONAL
+
The cancellationToken enables graceful cancellation of asynchronous operations.
@@ -370,7 +370,7 @@ await db.RawQuery(sql, params)
params
- OPTIONAL
+
Assigns variables which can be used in the query.
@@ -379,7 +379,7 @@ await db.RawQuery(sql, params)
cancellationToken
- OPTIONAL
+
The cancellationToken enables graceful cancellation of asynchronous operations.
@@ -429,7 +429,7 @@ db.Query(sql, vars)
vars
- OPTIONAL
+
Assigns variables which can be used in the query.
@@ -473,7 +473,7 @@ db.query(sql).bind(vars)
vars
- OPTIONAL
+
Assigns variables which can be used in the query.
diff --git a/src/content/doc-surrealdb/querying/surrealql/http.mdx b/src/content/doc-surrealdb/querying/surrealql/http.mdx
index bc51c0b57..a47dfe30a 100644
--- a/src/content/doc-surrealdb/querying/surrealql/http.mdx
+++ b/src/content/doc-surrealdb/querying/surrealql/http.mdx
@@ -42,7 +42,7 @@ The `/sql` endpoint enables use of SurrealQL queries.
Authorization
- OPTIONAL
+
Sets the root, namespace, database, or record authentication data
@@ -91,7 +91,7 @@ The `/sql` endpoint enables use of SurrealQL queries.
Authorization
- OPTIONAL
+
Sets the root, namespace, database, or record authentication data
-
-
- 
+ 
-
-
- 
+ 
is the ultimate cloud 
+ 
- 
+ 
- 
+ 
- 
+ 
- 
+ 
- 
+ 
- 
+ 
- 
+ 