Docs Menu

compactStructuredEncryptionData

compactStructuredEncryptionData

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

This command is available in deployments hosted in the following environments:

  • MongoDB Atlas: The fully managed service for MongoDB deployments in the cloud

Note

This command is supported in all MongoDB Atlas clusters. For information on Atlas support for all commands, see Unsupported Commands.

The command has the following syntax:

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

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().

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

See metadata collection compaction for an example.