Definition
compactStructuredEncryptionDataCompacts documents specified in the metadata collections and deletes redundant documents.
Compatibility
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.
- MongoDB Enterprise: The subscription-based, self-managed version of MongoDB
- MongoDB Community: The source-available, free-to-use, and self-managed version of MongoDB
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 |
|---|---|---|
| string | The name of the collection. |
| 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.