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: src/content/doc-cloud/faqs/index.mdx
+1-1
Original file line number
Diff line number
Diff line change
@@ -80,7 +80,7 @@ Surreal Cloud does not currently allow outgoing network requests, scripting, or
80
80
81
81
### How secure is Surreal Cloud?
82
82
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.
84
84
85
85
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.
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.
25
25
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).
27
27
28
28
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.
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.
25
25
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).
27
27
28
28
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.
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.
21
21
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).
23
23
24
24
With the database running, it's time to start setting up the Rust code.
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.
25
25
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).
27
27
28
28
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.
Copy file name to clipboardExpand all lines: src/content/doc-surrealdb/introduction/start.mdx
+6-1
Original file line number
Diff line number
Diff line change
@@ -450,7 +450,8 @@ When starting SurrealDB through the command line, you can fully customize the da
450
450
</a>
451
451
452
452
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.
454
455
455
456
<TabsgroupId="node-package-manager">
456
457
<TabItemvalue="memory"label="In-Memory">
@@ -460,7 +461,11 @@ When your start the database, you must specify which storage engine to use. This
Copy file name to clipboardExpand all lines: src/content/doc-surrealkv/index.mdx
+1-1
Original file line number
Diff line number
Diff line change
@@ -36,7 +36,7 @@ SurrealKV offers several key features that makes it a powerful and versatile dat
36
36
37
37
-**Embedded Database**: SurrealKV is available for embedded environments.
38
38
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.
40
40
41
41
-**Compaction**: Efficient storage management through compaction.
description: Learn about the performance characteristics of SurrealQL and how it optimizes query execution and resource usage in SurrealDB.
6
6
---
7
7
8
-
# Performance characteristics and trade-offs
8
+
# SurrealKV performance characteristics and trade-offs
9
9
10
10
## Strengths
11
11
@@ -21,15 +21,15 @@ Operationally, SurrealKV offers significant advantages. The compaction process r
21
21
22
22
## Limitations
23
23
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):
25
25
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.
27
27
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.
29
29
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.
31
31
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.
0 commit comments