Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions,
see Getting Started with Amazon Web Services in China
(PDF).
$year
The $year operator in Amazon DocumentDB extracts the year component from a date or timestamp.
Parameters
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()