$redact

Reference type:Cheat sheetFormat:Syntax + example + use case

Reference group: Pipeline stages

What it does

Controls document traversal using $$KEEP, $$PRUNE, and $$DESCEND.

Syntax

{$redact: expression}

Use case

Specialized embedded-metadata filtering.

Important notes

Not a replacement for application authorization.

$redact: practical example
{ $redact: { $cond: [{ $eq: ["$visibility", "public"] }, "$$DESCEND", "$$PRUNE"] } }
💡 Explanation Controls document traversal using $$KEEP, $$PRUNE, and $$DESCEND. When to use it Specialized embedded-metadata filtering. Caution Not a replacement for application authorization.
Key Takeaways
  • Controls document traversal using $$KEEP, $$PRUNE, and $$DESCEND.
  • Typical use: Specialized embedded-metadata filtering.