Skip to content

Commit 0a8f910

Browse files
committed
Merge branch 'main' of https://github.com/surrealdb/docs.surrealdb.com into deployment-review
2 parents 3025670 + 9466bae commit 0a8f910

File tree

9 files changed

+20
-13
lines changed

9 files changed

+20
-13
lines changed

src/content/doc-cloud/faqs/index.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ Surreal Cloud does not currently allow outgoing network requests, scripting, or
8080

8181
### How secure is Surreal Cloud?
8282

83-
Surreal Cloud is designed with security in mind and aims to provide robust protection for your data and applications. As detailed within our [Security Addendum](/legal/security-addendum), the platform leverages industry-standard security practices, including encryption at rest and in transit, network isolation, access controls and monitoring. For authentication, Surreal Cloud supports multi-factor authentication through the available identity providers that offer it to their users. We are also working towards ISO 27001 and SOC 2 compliance, with plans to expand to other industry-specific compliance programs in the future, such as HIPAA or PCI DSS.
83+
Surreal Cloud is designed with security in mind and aims to provide robust protection for your data and applications. As detailed within our [Security Addendum](/legal/security-addendum), the platform leverages industry-standard security practices, including encryption at rest and in transit, network isolation, access controls and monitoring. For authentication, Surreal Cloud supports multi-factor authentication through the available identity providers that offer it to their users. We are compliant with ISO 27001, and are working towards achieving SOC 2 compliance, with plans to expand to other industry-specific compliance programs in the future, such as HIPAA or PCI DSS.
8484

8585
Additionally, Surreal Cloud is built on top of SurrealDB, which provides powerful and flexible [security features](/docs/surrealdb/security/summary#product) that are available to all Surreal Cloud customers. SurrealDB is developed and maintained following modern [security practices](/docs/surrealdb/security/summary#process) to ensure early detection of security vulnerabilities and other security issues.
8686

src/content/doc-sdk-javascript/engines/node.mdx

+2
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,8 @@ const db = new Surreal({
7979
await db.connect("mem://");
8080
// Or we can start a persisted SurrealKV database
8181
await db.connect("surrealkv://demo");
82+
// Or a persisted SurrealKV database with versioning (temoral queries)
83+
await db.connect("surrealkv+versioned://demo");
8284

8385
// Now use the JavaScript SDK as normal.
8486

src/content/doc-sdk-rust/frameworks/actix.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ surreal start --user root --pass root
2323

2424
You can also use the [Start serving](/docs/surrealist/concepts/local-database-serving) button on [Surrealist](/docs/surrealist) to do the same if you have it installed locally.
2525

26-
The database initiated by the [surreal start](/docs/surrealdb/cli/start) command stores data in memory by default, which then disappears every time the database is shut down. As such, you can simply use Ctrl+C every time you want to start the database anew with no existing definitions or data. To save data to disk which will persist after shutting down, add a [positional argument](/docs/surrealdb/cli/start#positional-argument) for one of the storage backends such as `rocksdb://mydatabase` or `surrealkv://mydatabase`.
26+
The database initiated by the [surreal start](/docs/surrealdb/cli/start) command stores data in memory by default, which then disappears every time the database is shut down. As such, you can simply use Ctrl+C every time you want to start the database anew with no existing definitions or data. To save data to disk which will persist after shutting down, add a [positional argument](/docs/surrealdb/cli/start#positional-argument) for one of the storage backends such as `rocksdb://mydatabase` or `surrealkv://mydatabase` (or `surrealkv+versioned//mydatabase` to include SurrealKV versioning).
2727

2828
With the database running, we will now connect to the database "test" located in the namespace "test". You can connect to it by [creating a connection](/docs/surrealist/getting-started#creating-a-connection) inside Surrealist, or by using the following command to start an interactive shell.
2929

src/content/doc-sdk-rust/frameworks/axum.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ surreal start --user root --pass root
2323

2424
You can also use the [Start serving](/docs/surrealist/concepts/local-database-serving) button on [Surrealist](/docs/surrealist) to do the same if you have it installed locally.
2525

26-
The database initiated by the [surreal start](/docs/surrealdb/cli/start) command stores data in memory by default, which then disappears every time the database is shut down. As such, you can simply use Ctrl+C every time you want to start the database anew with no existing definitions or data. To save data to disk which will persist after shutting down, add a [positional argument](/docs/surrealdb/cli/start#positional-argument) for one of the storage backends such as `rocksdb://mydatabase` or `surrealkv://mydatabase`.
26+
The database initiated by the [surreal start](/docs/surrealdb/cli/start) command stores data in memory by default, which then disappears every time the database is shut down. As such, you can simply use Ctrl+C every time you want to start the database anew with no existing definitions or data. To save data to disk which will persist after shutting down, add a [positional argument](/docs/surrealdb/cli/start#positional-argument) for one of the storage backends such as `rocksdb://mydatabase` or `surrealkv://mydatabase` (or `surrealkv+versioned//mydatabase` to include SurrealKV versioning).
2727

2828
With the database running, we will now connect to the database "test" located in the namespace "test". You can connect to it by [creating a connection](/docs/surrealist/getting-started#creating-a-connection) inside Surrealist, or by using the following command to start an interactive shell.
2929

src/content/doc-sdk-rust/frameworks/egui.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ surreal start --user root --pass root
1919

2020
You can also use the [Start serving](/docs/surrealist/concepts/local-database-serving) button on [Surrealist](/docs/surrealist) to do the same if you have it installed locally.
2121

22-
The database initiated by the [surreal start](/docs/surrealdb/cli/start) command stores data in memory by default, which then disappears every time the database is shut down. As such, you can simply use Ctrl+C every time you want to start the database anew with no existing definitions or data. To save data to disk which will persist after shutting down, add a [positional argument](/docs/surrealdb/cli/start#positional-argument) for one of the storage backends such as `rocksdb://mydatabase` or `surrealkv://mydatabase`.
22+
The database initiated by the [surreal start](/docs/surrealdb/cli/start) command stores data in memory by default, which then disappears every time the database is shut down. As such, you can simply use Ctrl+C every time you want to start the database anew with no existing definitions or data. To save data to disk which will persist after shutting down, add a [positional argument](/docs/surrealdb/cli/start#positional-argument) for one of the storage backends such as `rocksdb://mydatabase` or `surrealkv://mydatabase` (or `surrealkv+versioned//mydatabase` to include SurrealKV versioning).
2323

2424
With the database running, it's time to start setting up the Rust code.
2525

src/content/doc-sdk-rust/frameworks/rocket.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ surreal start --user root --pass root
2323

2424
You can also use the [Start serving](/docs/surrealist/concepts/local-database-serving) button on [Surrealist](/docs/surrealist) to do the same if you have it installed locally.
2525

26-
The database initiated by the [surreal start](/docs/surrealdb/cli/start) command stores data in memory by default, which then disappears every time the database is shut down. As such, you can simply use Ctrl+C every time you want to start the database anew with no existing definitions or data. To save data to disk which will persist after shutting down, add a [positional argument](/docs/surrealdb/cli/start#positional-argument) for one of the storage backends such as `rocksdb://mydatabase` or `surrealkv://mydatabase`.
26+
The database initiated by the [surreal start](/docs/surrealdb/cli/start) command stores data in memory by default, which then disappears every time the database is shut down. As such, you can simply use Ctrl+C every time you want to start the database anew with no existing definitions or data. To save data to disk which will persist after shutting down, add a [positional argument](/docs/surrealdb/cli/start#positional-argument) for one of the storage backends such as `rocksdb://mydatabase` or `surrealkv://mydatabase` (or `surrealkv+versioned//mydatabase` to include SurrealKV versioning).
2727

2828
With the database running, we will now connect to the database "test" located in the namespace "test". You can connect to it by [creating a connection](/docs/surrealist/getting-started#creating-a-connection) inside Surrealist, or by using the following command to start an interactive shell.
2929

src/content/doc-surrealdb/introduction/start.mdx

+6-1
Original file line numberDiff line numberDiff line change
@@ -450,7 +450,8 @@ When starting SurrealDB through the command line, you can fully customize the da
450450
</a>
451451

452452
After you have installed SurrealDB, you can start the database using the [`surreal start`](/docs/surrealdb/cli/start) command provided by the [SurrealDB CLI](/docs/surrealdb/cli).
453-
When your start the database, you must specify which storage engine to use. This can be done by providing the engine as as the connection URL protocol. The following examples demonstrate how to start SurrealDB using different storage engines.
453+
454+
When you start the database, you must specify which storage engine to use. This can be done by providing the engine as as the connection URL protocol. The following examples demonstrate how to start SurrealDB using different storage engines.
454455

455456
<Tabs groupId="node-package-manager">
456457
<TabItem value="memory" label="In-Memory">
@@ -460,7 +461,11 @@ When your start the database, you must specify which storage engine to use. This
460461
</TabItem>
461462
<TabItem value="surrealkv" label="Single Node On-Disk SurrealKV" default>
462463
```bash
464+
# Without versioning (temporal queries)
463465
surreal start -u root -p root surrealkv://mydb
466+
467+
# With versioning
468+
surreal start -u root -p root surrealkv+versioned://mydb
464469
```
465470
</TabItem>
466471
<TabItem value="rocksdb" label="Single Node On-Disk rocksDB">

src/content/doc-surrealkv/index.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ SurrealKV offers several key features that makes it a powerful and versatile dat
3636

3737
- **Embedded Database**: SurrealKV is available for embedded environments.
3838

39-
- **Built-in Versioning**: Track and access historical versions of your data.
39+
- **Built-in Versioning**: Start SurrealKV [in versioned mode](/docs/surrealdb/cli/start#surrealkv-beta) to track and access historical versions of your data.
4040

4141
- **Compaction**: Efficient storage management through compaction.
4242

src/content/doc-surrealkv/performance.mdx

+6-6
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: Performance characteristics | SurrealQL
55
description: Learn about the performance characteristics of SurrealQL and how it optimizes query execution and resource usage in SurrealDB.
66
---
77

8-
# Performance characteristics and trade-offs
8+
# SurrealKV performance characteristics and trade-offs
99

1010
## Strengths
1111

@@ -21,15 +21,15 @@ Operationally, SurrealKV offers significant advantages. The compaction process r
2121

2222
## Limitations
2323

24-
SurrealKV does have some important limitations to consider:
24+
SurrealKV does have some important limitations to consider, many of which pertain to SurrealKV [when versioning is enabled](/docs/surrealdb/cli/start#surrealkv-beta):
2525

26-
Memory management is a key consideration, as the index must reside in memory. Memory usage scales with the number of unique keys, key size distribution, and the number of versions per key.
26+
* Memory management is a key consideration, as the index must reside in memory. Memory usage scales with the number of unique keys, key size distribution, and the number of versions per key.
2727

28-
Write amplification is another factor to consider. Each update creates a new version, requiring periodic compaction. During compaction, space usage temporarily increases.
28+
* Write amplification is another factor to consider. Each update creates a new version, requiring periodic compaction. During compaction, space usage temporarily increases.
2929

30-
Range query performance varies depending on several factors: key distribution, version history depth, and range size. Large ranges may require multiple disk reads to complete.
30+
* Range query performance varies depending on several factors: key distribution, version history depth, and range size. Large ranges may require multiple disk reads to complete.
3131

32-
From an operational standpoint, regular compaction is necessary for space reclamation. System restart time increases with log size, and high-cardinality keyspaces can create memory pressure.
32+
* From an operational standpoint, regular compaction is necessary for space reclamation. System restart time increases with log size, and high-cardinality keyspaces can create memory pressure.
3333

3434
## Performance implications
3535

0 commit comments

Comments
 (0)