Docs Home → MongoDB Manual

compactStructuredEncryptionData

On this page

Definition

compactStructuredEncryptionData

Compacts documents specified in the state collections and deletes redundant documents.

Syntax

The command has the following syntax:

db.runCommand(
  {
    compactStructuredEncryptionData: <collection>,
    compactionTokens: {
       encryptedFieldPath: bindata,
       ...
    },
  }
)

Command Fields

The command takes the following fields:

FieldTypeDescription
compactStructuredEncryptionDatastringThe name of the collection.
compactionTokensdocumentA document that maps index fields to compaction tokens.

The mongosh provides a wrapper method db.collection.compactStructuredEncryptionData().

Required Access

The built-in roles readWriteAnyDatabase and dbOwner provide compactStructuredEncryptionData actions on resources.

Example

See index compaction for an example.