AWS documentdb documentation change

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

File: documentdb/latest/developerguide/year.md

Summary

Added documentation for the $year operator in Amazon DocumentDB, including description, MongoDB Shell example, and code examples in Node.js and Python

Security assessment

This change adds documentation for a date/time operator ($year) 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 just showing standard connection strings. No evidence of addressing a specific security vulnerability or incident.

Diff

diff --git a/documentdb/latest/developerguide/year.md b/documentdb/latest/developerguide/year.md
index 8b1378917..830d58c00 100644
--- a//documentdb/latest/developerguide/year.md
+++ b//documentdb/latest/developerguide/year.md
@@ -0,0 +1 @@
+[](/pdfs/documentdb/latest/developerguide/developerguide.pdf#year "Open PDF")
@@ -1,0 +3,110 @@
+[Documentation](/index.html)[Amazon DocumentDB](/documentdb/index.html)[Developer Guide](what-is.html)
+
+Example (MongoDB Shell)Code examples
+
+# $year
+
+The `$year` operator in Amazon DocumentDB extracts the year component from a date or timestamp.
+
+**Parameters**
+
+  * `expression`: The date or timestamp expression from which to extract the year component.
+
+
+
+
+## Example (MongoDB Shell)
+
+The following example demonstrates how to use the `$year` operator to extract the year component from a date field.
+
+**Create sample documents**
+    
+    
+    db.events.insertMany([
+      { "_id": 1, "date": ISODate("2023-04-15T00:00:00Z") },
+      { "_id": 3, "date": ISODate("2021-12-31T00:00:00Z") }
+    ]);
+
+**Query example**
+    
+    
+    db.events.aggregate([
+      { $project: { year: { $year: "$date" } } }
+    ]);
+
+**Output**
+    
+    
+    [
+      { "_id": 1, "year": 2023 },
+      { "_id": 3, "year": 2021 }
+    ]
+
+## Code examples
+
+To view a code example for using the `$year` 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('events');
+    
+      const result = await collection.aggregate([
+        { $project: { year: { $year: "$date" } } }
+      ]).toArray();
+    
+      console.log(result);
+    
+      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['events']
+    
+        result = list(collection.aggregate([
+            {'$project': {'year': {'$year': '$date'}}}
+        ]))
+    
+        print(result)
+    
+        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)
+
+$week
+
+$zip
+
+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.