Partilhar via

$redact

O $redact estágio no pipeline de agregação é usado para filtrar campos dos documentos em uma coleção dinamicamente com base em direitos de acesso ou outras condições. Ele processa cada documento no pipeline e remove ou retém campos com base na lógica especificada.

Sintaxe

{
  $redact: <expression>
}

Parâmetros

Parâmetro Description
<expression> Uma expressão válida do MongoDB que é avaliada como uma das seguintes: $$DESCEND, $$PRUNE, ou $$KEEP. Essas variáveis determinam se devem manter, remover ou explorar mais profundamente no documento.

Examples

Considere este documento de exemplo da coleção de lojas.

{
    "_id": "0fcc0bf0-ed18-4ab8-b558-9848e18058f4",
    "name": "First Up Consultants | Beverage Shop - Satterfieldmouth",
    "location": {
        "lat": -89.2384,
        "lon": -46.4012
    },
    "staff": {
        "totalStaff": {
            "fullTime": 8,
            "partTime": 20
        }
    },
    "sales": {
        "totalSales": 75670,
        "salesByCategory": [
            {
                "categoryName": "Wine Accessories",
                "totalSales": 34440
            },
            {
                "categoryName": "Bitters",
                "totalSales": 39496
            },
            {
                "categoryName": "Rum",
                "totalSales": 1734
            }
        ]
    },
    "promotionEvents": [
        {
            "eventName": "Unbeatable Bargain Bash",
            "promotionalDates": {
                "startDate": {
                    "Year": 2024,
                    "Month": 6,
                    "Day": 23
                },
                "endDate": {
                    "Year": 2024,
                    "Month": 7,
                    "Day": 2
                }
            },
            "discounts": [
                {
                    "categoryName": "Whiskey",
                    "discountPercentage": 7
                },
                {
                    "categoryName": "Bitters",
                    "discountPercentage": 15
                },
                {
                    "categoryName": "Brandy",
                    "discountPercentage": 8
                },
                {
                    "categoryName": "Sports Drinks",
                    "discountPercentage": 22
                },
                {
                    "categoryName": "Vodka",
                    "discountPercentage": 19
                }
            ]
        },
        {
            "eventName": "Steal of a Deal Days",
            "promotionalDates": {
                "startDate": {
                    "Year": 2024,
                    "Month": 9,
                    "Day": 21
                },
                "endDate": {
                    "Year": 2024,
                    "Month": 9,
                    "Day": 29
                }
            },
            "discounts": [
                {
                    "categoryName": "Organic Wine",
                    "discountPercentage": 19
                },
                {
                    "categoryName": "White Wine",
                    "discountPercentage": 20
                },
                {
                    "categoryName": "Sparkling Wine",
                    "discountPercentage": 19
                },
                {
                    "categoryName": "Whiskey",
                    "discountPercentage": 17
                },
                {
                    "categoryName": "Vodka",
                    "discountPercentage": 23
                }
            ]
        }
    ]
}

Exemplo 1: Redação de informações confidenciais

Esta consulta filtra o promotionEvents campo para documentos em que o discountPercentage em uma promoção excede 15%.

db.stores.aggregate([
  {
    $redact: {
      $cond: {
        if: {
          $gt: ["$promotionEvents.discounts.discountPercentage", 15]
        },
        then: "$$PRUNE",
        else: "$$DESCEND"
      }
    }
  }
])

Os dois primeiros resultados retornados por esta consulta são:

[
    {
        "_id": "new-store-001",
        "name": "Adatum Corporation - Downtown Branch",
        "sales": {
            "totalSales": 5000
        },
        "createdDate": "2025-06-11T11:11:32.262Z",
        "status": "new",
        "staff": {
            "totalStaff": {
                "fullTime": 0,
                "partTime": 0
            }
        },
        "version": 1,
        "storeOpeningDate": "2025-06-11T11:11:32.262Z",
        "storeFeatures": 213
    },
    {
        "_id": "gaming-store-mall-001",
        "name": "Trey Research | Gaming Paradise - Mall Location",
        "location": {
            "lat": 35.6762,
            "lon": 139.6503
        },
        "createdDate": "2025-06-11T11:13:27.180Z",
        "status": "active",
        "staff": {
            "totalStaff": {
                "fullTime": 8,
                "partTime": 12
            },
            "manager": "Alex Johnson",
            "departments": [
                "gaming",
                "accessories",
                "repairs"
            ]
        },
        "sales": {
            "totalSales": 0,
            "salesByCategory": []
        },
        "operatingHours": {
            "weekdays": "10:00-22:00",
            "weekends": "09:00-23:00"
        },
        "metadata": {
            "version": 1,
            "source": "store-management-system"
        },
        "storeOpeningDate": "2025-06-11T11:11:32.262Z",
        "storeFeatures": 189
    }
]

Exemplo 2: Restringir o acesso com base em etiquetas

Esta consulta remove todos os documentos que contêm a etiqueta #MembershipDeals.

db.stores.aggregate([
  {
    $redact: {
      $cond: {
        if: {
          $in: ["#MembershipDeals", "$tag"]
        },
        then: "$$PRUNE",
        else: "$$DESCEND"
      }
    }
  }
])

Conteúdo relacionado

  • Last updated on