本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# \$1redact
<a name="redact"></a>

Amazon DocumentDB `$redact` 中的彙總階段用於根據指定欄位的值，選擇性地包含或排除輸出文件中的內容。這在您需要根據存取層級或使用者許可控制敏感資料的可見性的情況下特別有用。

**參數**
+ `$cond`：評估文件中`$$DESCEND`每個欄位 `$$KEEP`、 `$$PRUNE`或 的表達式。
+ `$$KEEP`：保留輸出文件中的目前欄位。
+ `$$PRUNE`：從輸出文件移除目前欄位。
+ `$$DESCEND`：遞迴地將`$redact`階段套用至目前欄位，也就是物件或陣列。

## 範例 (MongoDB Shell)
<a name="redact-examples"></a>

在此範例中，我們將使用 `$redact`階段根據訂單狀態篩選訂單，只顯示具有特定狀態值的訂單。

**建立範例文件**

```
db.orders.insert([
  { "_id": 1, "status": "shipped", "customer": "Carlos Salazar", "total": 150.00, "date": "2025-01-15" },
  { "_id": 2, "status": "processing", "customer": "Saanvi Sarkar", "total": 89.99, "date": "2025-01-20" },
  { "_id": 3, "status": "cancelled", "customer": "Zhang Wei", "total": 220.50, "date": "2025-01-18" }
])
```

**查詢範例**

```
db.orders.aggregate([
  {
    $redact: {
      $cond: {
        if: { $in: ["$status", ["shipped", "processing"]] },
        then: "$$KEEP",
        else: "$$PRUNE"
      }
    }
  }
])
```

**輸出**

```
[
  { _id: 1, status: 'shipped', customer: 'Carlos Salazar', total: 150, date: '2025-01-15' },
  { _id: 2, status: 'processing', customer: 'Saanvi Sarkar', total: 89.99, date: '2025-01-20' }
]
```

在此範例中，`$redact`階段會檢查每個文件中 `status` 欄位的值。如果`status`「已運送」或「正在處理」，文件會保留 (`$$KEEP`)。否則，文件會遭到刪除 (`$$PRUNE`)。

## 程式碼範例
<a name="redact-code"></a>

若要檢視使用 `$redact`命令的程式碼範例，請選擇您要使用的語言標籤：

------
#### [ Node.js ]

```
const { MongoClient } = require('mongodb');

async function example() {
  const client = await MongoClient.connect('mongodb://<username>:<password>@<cluster-endpoint>:27017/?tls=true&tlsCAFile=global-bundle.pem&replicaSet=rs0&readPreference=secondaryPreferred&retryWrites=false');
  const db = client.db('test');
  const collection = db.collection('orders');

  const result = await collection.aggregate([
    {
      $redact: {
        $cond: {
          if: { $in: ['$status', ['shipped', 'processing']] },
          then: '$$KEEP',
          else: '$$PRUNE'
        }
      }
    }
  ]).toArray();

  console.log(result);
  client.close();
}

example();
```

------
#### [ Python ]

```
from pymongo import MongoClient

def example():
    client = MongoClient('mongodb://<username>:<password>@<cluster-endpoint>:27017/?tls=true&tlsCAFile=global-bundle.pem&replicaSet=rs0&readPreference=secondaryPreferred&retryWrites=false')
    db = client['test']
    collection = db['orders']

    result = list(collection.aggregate([
        {
            '$redact': {
                '$cond': {
                    'if': { '$in': ['$status', ['shipped', 'processing']] },
                    'then': '$$KEEP',
                    'else': '$$PRUNE'
                }
            }
        }
    ]))

    print(result)
    client.close()

example()
```

------