AWS documentdb documentation change

Service: documentdb · 2026-03-31 · Documentation low

File: documentdb/latest/developerguide/replaceRoot.md

Summary

Added new documentation page for the $replaceRoot operator in Amazon DocumentDB, including syntax, parameters, MongoDB shell example, and code examples in Node.js and Python

Security assessment

This change adds routine documentation for a MongoDB aggregation operator ($replaceRoot) with standard usage examples. The code examples include TLS connection parameters (tls=true, tlsCAFile=global-bundle.pem) which are standard security practices for DocumentDB connections, but this is not new security documentation - it's standard secure connection practice already documented elsewhere. There is no evidence this addresses a specific security vulnerability or incident.

Diff

diff --git a/documentdb/latest/developerguide/replaceRoot.md b/documentdb/latest/developerguide/replaceRoot.md
index 8b1378917..a8e30d564 100644
--- a//documentdb/latest/developerguide/replaceRoot.md
+++ b//documentdb/latest/developerguide/replaceRoot.md
@@ -0,0 +1 @@
+[](/pdfs/documentdb/latest/developerguide/developerguide.pdf#replaceRoot "Open PDF")
@@ -1,0 +3,135 @@
+[Documentation](/index.html)[Amazon DocumentDB](/documentdb/index.html)[Developer Guide](what-is.html)
+
+Example (MongoDB Shell)Code examples
+
+# $replaceRoot
+
+The `$replaceRoot` operator is used to replace the root document with the specified embedded document. This is useful when you want to promote a nested document to the top level or restructure your data output.
+
+**Parameters**
+
+  * `newRoot`: The new root document that will replace the existing root document.
+
+
+
+
+## Example (MongoDB Shell)
+
+This example shows how to extract shipping address information from customer orders, which is useful for generating shipping labels or address lists.
+
+**Create sample documents**
+    
+    
+    db.orders.insertMany([
+      {
+        "_id":1, "orderId": "ORD-2024-001", "customerId": "CUST-12345", "orderDate": "2024-01-15", "shippingAddress": { "name": "María García", "street": "123 Main St", "city": "Seattle", "state": "WA", "zipCode": "98101", "country": "USA" },"totalAmount": 149.99 },
+      { "_id":2, "orderId": "ORD-2024-002", "customerId": "CUST-67890", "orderDate": "2024-01-16", "shippingAddress": { "name": "Arnav Desai", "street": "456 Oak Ave", "city": "Portland", "state": "OR", "zipCode": "97201", "country": "USA" }, "totalAmount": 89.50 } ])
+
+**Query example**
+    
+    
+    db.orders.aggregate([
+      {
+        $replaceRoot: {
+          newRoot: "$shippingAddress"
+        }
+      }
+    ])
+
+**Output**
+    
+    
+    {
+        name: 'María García',
+        street: '123 Main St',
+        city: 'Seattle',
+        state: 'WA',
+        zipCode: '98101',
+        country: 'USA'
+      },
+      {
+        name: 'Arnav Desai',
+        street: '456 Oak Ave',
+        city: 'Portland',
+        state: 'OR',
+        zipCode: '97201',
+        country: 'USA'
+      }
+    
+
+## Code examples
+
+To view a code example for using the `$replaceRoot` command, choose the tab for the language that you want to use:
+
+Node.js
+    
+    
+    
+    const { MongoClient } = require('mongodb');
+    
+    async function extractShippingAddresses() {
+      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([
+        {
+          $replaceRoot: {
+            newRoot: "$shippingAddress"
+          }
+        }
+      ]).toArray();
+    
+      console.log(result);
+    
+      await client.close();
+    }
+    
+    extractShippingAddresses();
+
+Python
+    
+    
+    
+    from pymongo import MongoClient
+    
+    def extract_shipping_addresses():
+        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([
+            {
+                "$replaceRoot": {
+                    "newRoot": "$shippingAddress"
+                }
+            }
+        ]))
+    
+        print(result)
+    
+        client.close()
+    
+    extract_shipping_addresses()
+
+![Warning](https://d1ge0kk1l5kms0.cloudfront.net/images/G/01/webservices/console/warning.png) **Javascript is disabled or is unavailable in your browser.**
+
+To use the Amazon Web Services Documentation, Javascript must be enabled. Please refer to your browser's Help pages for instructions.
+
+[Document Conventions](/general/latest/gr/docconventions.html)
+
+$replaceOne
+
+$replaceWith
+
+Did this page help you? - Yes
+
+Thanks for letting us know we're doing a good job!
+
+If you've got a moment, please tell us what we did right so we can do more of it.
+
+Did this page help you? - No
+
+Thanks for letting us know this page needs work. We're sorry we let you down.
+
+If you've got a moment, please tell us how we can make the documentation better.