Docs Menu

Docs HomeMongoDB Manual

compactStructuredEncryptionData

On this page

  • Definition
  • Syntax
  • Command Fields
  • Required Access
  • Example
compactStructuredEncryptionData

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

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 index compaction for an example.

What is MongoDB? →
Give Feedback
© 2022 MongoDB, Inc.

About

  • Careers
  • Investor Relations
  • Legal Notices
  • Privacy Notices
  • Security Information
  • Trust Center
© 2022 MongoDB, Inc.