Skip to content

Commit

Permalink
DOC-8560: plasma requires hole punching for compaction (#2026)
Browse files Browse the repository at this point in the history
* Add note on hole punching

* Clarify terminology
  • Loading branch information
simon-dew committed Jun 29, 2021
1 parent a120788 commit 3ed6f7e
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 0 deletions.
Expand Up @@ -51,6 +51,8 @@ The performance of standard index storage depends on overall I/O performance.
In Couchbase Server Enterprise Edition, standard index-storage is supported by the _Plasma_ storage engine.
In this case, compaction is handled automatically.
However, for installations of Couchbase Server Enterprise Edition running on Linux, note that hole punching is required to enable auto-compaction of Global Secondary Indexes using standard index-storage.
****

****
Expand Down
Expand Up @@ -16,6 +16,14 @@ Auto-compaction settings affect _on-disk_ data, and therefore do not apply to Ep

Full and Cluster administrators can configure compaction settings with xref:manage:manage-settings/configure-compact-settings.adoc#configure-auto-compaction-with-the-ui[Couchbase Web Console], the Couchbase xref:manage:manage-settings/configure-compact-settings.adoc#configure-auto-compaction-with-the-cli[CLI], or the xref:manage:manage-settings/configure-compact-settings.adoc#configure-auto-compaction-with-the-rest-api[REST] API.

****
[.edition]#{enterprise}#
In Couchbase Server Enterprise Edition, auto-compaction does not apply to memory-optimized index storage, and there are no settings necessary for configuring the auto-compaction of Global Secondary Indexes using standard index storage.
However, for installations of Couchbase Server Enterprise Edition running on Linux, note that hole punching is required to enable auto-compaction of Global Secondary Indexes using standard index storage.
****

[#configure-auto-compaction-with-the-ui]
== Configure Auto-Compaction with the UI

Expand Down

0 comments on commit 3ed6f7e

Please sign in to comment.