Skip to content

DOC-13439 added note about bucket memory #3989

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
TimLFletcher wants to merge 1 commit into
base: release/7.6
Choose a base branch
from
Open

DOC-13439 added note about bucket memory #3989

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion modules/learn/pages/buckets-memory-and-storage/storage-engines.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ For example, if a node is holding 5{nbsp}TB of data, Magma can be used with only
| 100{nbsp}MB
| [[quota-ref]]1{nbsp}GB<<quota-note, ^[1]^>>

| Minimum memory to data ratio
| Minimum memory to data ratio<<quota-note, ^[2]^>>
| 10%
| 1%

Expand All @@ -65,6 +65,12 @@ For example, if a node is holding 5{nbsp}TB of data, Magma can be used with only
[horizontal]
[[quota-note]]<<quota-ref, ^1^>>:: Magma's minimum memory requirement is higher at 1GB per node due to the more complex data structures it has to maintain.

[horizontal]
[[memory-note]]<<quota-ref, ^2^>>:: Memory refers to the memory allocated to the bucket.
Copy link
Contributor

@rao-shwe rao-shwe Nov 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
[[memory-note]]<<quota-ref, ^2^>>:: Memory refers to the memory allocated to the bucket.
[[memory-note]]<<quota-ref, ^2^>>:: Memory refers to the RAM allocated to the bucket.
+

Disk space of the bucket refers to the data size of the bucket on the disk, including all of its replicas.
Copy link
Contributor

@rao-shwe rao-shwe Nov 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Disk space of the bucket refers to the data size of the bucket on the disk, including all of its replicas.
Disk space refers to the total size of the bucket’s data on the disk, including all of its replicas.

This can be estimated by: (number of documents * average document size * number of replicas * expected compression ratio).
Copy link
Contributor

@rao-shwe rao-shwe Nov 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This can be estimated by: (number of documents * average document size * number of replicas * expected compression ratio).
This can be estimated by:
+
(number of documents x average document size x number of replicas x expected compression ratio).

On a running system, the metric `kv_logical_data_size_bytes` reflects the bucket's size on the disk.
Copy link
Contributor

@rao-shwe rao-shwe Nov 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
On a running system, the metric `kv_logical_data_size_bytes` reflects the bucket's size on the disk.
+
On a running system, the metric `kv_logical_data_size_bytes` reflects the bucket's size on the disk.


== When should you use Couchstore?

The choice of Couchstore or Magma is set at the bucket level xref:manage:manage-buckets/create-bucket.adoc[when the bucket is created].
Expand Down