compactStructuredEncryptionData¶

On this page

Definition
Syntax
Command Fields
Required Access
Example

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:

Field	Type	Description
`compactStructuredEncryptionData`	string	The name of the collection.
`compactionTokens`	document	A 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.