Skip to content

Commit 02bb691

Browse files
Docsp 30653 index compaction reword (#4867) (#5122)
* Cleaned up use of metadata compaction * Rebuild * Fixed metadata collection terminology in reference page
1 parent 9c5de2a commit 02bb691

File tree

3 files changed

+16
-17
lines changed

3 files changed

+16
-17
lines changed

source/core/queryable-encryption/fundamentals/manage-collections.txt

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -129,21 +129,21 @@ Delete Operations
129129

130130
When deleting a document, indexed fields do not require any additional writes.
131131

132-
.. _qe-index-compaction:
132+
.. _qe-metadata-compaction:
133133

134-
Index Compaction
135-
----------------
134+
Metadata Collection Compaction
135+
------------------------------
136136

137137
As you insert or update documents, the metadata collections
138-
change and grow. Index compaction prunes the metadata collections and
139-
reduces their size.
138+
change and grow. Metadata collection compaction prunes the metadata
139+
collections and reduces their size.
140140

141141
.. important::
142142

143-
You must manually run index compaction. Compaction only works on
144-
clients configured for {+qe+}.
143+
You must manually run metadata collection compaction. Compaction only
144+
works on clients configured for {+qe+}.
145145

146-
Run index compaction when the size of ``ECOC`` exceeds 1 GB.
146+
Run compaction when the size of ``ECOC`` exceeds 1 GB.
147147

148148
You can check the size of your collections using :binary:`~bin.mongosh`
149149
and issuing the :method:`db.collection.totalSize()` command.
@@ -164,9 +164,9 @@ and issuing the :method:`db.collection.totalSize()` command.
164164

165165
1407960328
166166

167-
To run index compaction, use :binary:`~bin.mongosh` and run the
168-
``db.collection.compactStructuredEncryptionData()`` command to reduce
169-
the size of the metadata collections.
167+
To run metadata collection compaction, use :binary:`~bin.mongosh` and
168+
run the ``db.collection.compactStructuredEncryptionData()`` command to
169+
reduce the size of the metadata collections.
170170

171171
.. example::
172172

source/core/queryable-encryption/reference/limitations.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,10 @@ You can set the contention factor only when specifying a field for encryption.
3939
Once you specify a field for encryption, the contention factor is immutable. If
4040
you don't specify the contention factor, it uses the default value of ``4``.
4141

42-
Manual Compaction
43-
-----------------
42+
Manual Metadata Collection Compaction
43+
-------------------------------------
4444

45-
Manually run :ref:`index compaction <qe-index-compaction>`
45+
Manually run :ref:`metadata collection compaction <qe-metadata-compaction>`
4646
when your metadata collections exceed 1 GB. Compaction decreases the
4747
size of the metadata collections associated with encrypted fields, and
4848
improves performance.

source/reference/command/compactStructuredEncryptionData.txt

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Definition
1717

1818
.. dbcommand:: compactStructuredEncryptionData
1919

20-
Compacts documents specified in the state collections and deletes
20+
Compacts documents specified in the metadata collections and deletes
2121
redundant documents.
2222

2323
Syntax
@@ -78,5 +78,4 @@ The built-in roles :authrole:`readWriteAnyDatabase` and
7878
Example
7979
-------
8080

81-
See :ref:`index compaction <qe-index-compaction>` for an example.
82-
81+
See :ref:`metadata collection compaction <qe-metadata-compaction>` for an example.

0 commit comments

Comments
 (0)