Skip to content

Commit 1467645

Browse files
committed
Add two links to surreal start, specify that many points pertain to versioned SurrealKV
1 parent 2c50a66 commit 1467645

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

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)