compactStructuredEncryptionData

On this page

Definition

Syntax
Command Fields
Required Access
Example

This version of the documentation is archived and no longer supported. View the current documentation to learn how to upgrade your version of MongoDB server.

Definition

compactStructuredEncryptionData: Compacts documents specified in the metadata 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 metadata collection compaction for an example.

What is MongoDB?