AWS documentdb documentation change

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

File: documentdb/latest/developerguide/rename.md

Summary

Added comprehensive documentation for the $rename operator in Amazon DocumentDB, including parameters, MongoDB Shell example, and code examples in Node.js and Python with connection details

Security assessment

This change adds standard documentation for a database operator ($rename) without any mention of security vulnerabilities, patches, or security incidents. The code examples include standard TLS connection parameters (tls=true, tlsCAFile=global-bundle.pem) which are routine security best practices for DocumentDB connections, but this is not new security documentation - it's standard connection string formatting. No evidence of addressing a specific security issue.

Diff

diff --git a/documentdb/latest/developerguide/rename.md b/documentdb/latest/developerguide/rename.md
index 8b1378917..b638b0764 100644
--- a//documentdb/latest/developerguide/rename.md
+++ b//documentdb/latest/developerguide/rename.md
@@ -0,0 +1 @@
+[](/pdfs/documentdb/latest/developerguide/developerguide.pdf#rename "Open PDF")
@@ -1,0 +3,129 @@
+[Documentation](/index.html)[Amazon DocumentDB](/documentdb/index.html)[Developer Guide](what-is.html)
+
+Example (MongoDB Shell)Code examples
+
+# $rename
+
+The `$rename` operator in Amazon DocumentDB is used to rename a field in a document. This operator can be particularly useful when you need to update the structure of your documents or align them with new data models.
+
+**Parameters**
+
+  * `field`: The field to be renamed.
+
+  * `newName`: The new name for the field.
+
+
+
+
+## Example (MongoDB Shell)
+
+The following example demonstrates how to use the `$rename` operator to rename the `"Date.DoW"` field to `"Date.DayOfWeek"` in a document with the `"DocName"` field set to `"Document 1"`.
+
+**Create sample documents**
+    
+    
+    db.example.insertOne({
+        "DocName": "Document 1",
+        "Date": {
+            "Month": 4,
+            "Day": 18,
+            "Year": 1987,
+            "DoW": "Saturday"
+        },
+        "Words": 2482
+    })
+
+**Query example**
+    
+    
+    db.example.update(
+        { "DocName": "Document 1" },
+        { $rename: { "Date.DoW": "Date.DayOfWeek" } }
+    )
+
+**Output**
+    
+    
+    {
+        "DocName": "Document 1",
+        "Date": {
+            "Month": 4,
+            "Day": 18,
+            "Year": 1987,
+            "DayOfWeek": "Saturday"
+        },
+        "Words": 2482
+    }
+
+## Code examples
+
+To view a code example for using the `$rename` command, choose the tab for the language that you want to use:
+
+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('example');
+    
+        await collection.updateOne(
+            { "DocName": "Document 1" },
+            { $rename: { "Date.DoW": "Date.DayOfWeek" } }
+        );
+    
+        const updatedDoc = await collection.findOne({ "DocName": "Document 1" });
+        console.log(updatedDoc);
+    
+        await 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['example']
+    
+        collection.update_one(
+            {"DocName": "Document 1"},
+            {"$rename": {"Date.DoW": "Date.DayOfWeek"}}
+        )
+    
+        updated_doc = collection.find_one({"DocName": "Document 1"})
+        print(updated_doc)
+    
+        client.close()
+    
+    example()
+
+![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)
+
+$push
+
+$set
+
+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.