In MongoDB, the $dayOfMonth
aggregation pipeline operator returns the day of the month for a date as a number between 1
and 31
.
You can optionally specify a timezone to use for the result.
The $dayOfMonth
operator accepts either a date (as either a Date, a Timestamp, or an ObjectId), or a document that specifies the date and timezone to use.
Example
Suppose we have a collection called pets
with the following document:
{ "_id" : ObjectId("600631c7c8eb4369cf6ad9c8"), "name" : "Fetch", "born" : ISODate("2020-12-31T23:30:15.123Z") }
We can run the following code to extract the day of the month from the born
field in that document.
db.pets.aggregate(
[
{
$project:
{
_id: 0,
birthDayOfMonth: { $dayOfMonth: "$born" }
}
}
]
)
Result:
{ "birthDayOfMonth" : 31 }
Here, I used birthDayOfMonth
as the field name to return, but this could have been anything (such as dayOfMonth
, day
, etc).
The _id
field is returned by default when using projections in MongoDB, but in this example I explicitly hid the _id
field using _id: 0
.
Specify a Timezone
You can specify a timezone to use for the output of the $dayOfMonth
operator.
When you do this, the argument passed to $dayOfMonth
must be of the following form:
{ date: <dateExpression>, timezone: <tzExpression> }
Where <dateExpression>
is the date to use, and <tzExpression>
is the timezone to use.
The timezone can be specified using either the Olson timezone identifier (e.g. "Europe/London"
, "GMT"
) or the UTC offset (e.g. "+02:30"
, "-1030"
).
Olson Timezone Identifier
Here’s an example that outputs the day in two different timezones, each using the Olson timezone IDs:
db.pets.aggregate(
[
{
$project: {
_id: 0,
honolulu: {
$dayOfMonth: { date: "$born", timezone: "Pacific/Honolulu" }
},
auckland: {
$dayOfMonth: { date: "$born", timezone: "Pacific/Auckland" }
}
}
}
]
)
Result:
{ "honolulu" : 31, "auckland" : 1 }
UTC Offset
Here’s the same example, except this time we use the UTC offset.
db.pets.aggregate(
[
{
$project: {
_id: 0,
"utcOffset-1000": {
$dayOfMonth: { date: "$born", timezone: "-1000" }
},
"utcOffset+1200": {
$dayOfMonth: { date: "$born", timezone: "+1200" }
}
}
}
]
)
Result:
{ "utcOffset-1000" : 31, "utcOffset+1200" : 1 }
Return the Day of the Month from an ObjectId
You can use $dayOfMonth
to return the day portion from an ObjectId.
ObjectId values are 12 byte hexadecimal values that consist of:
- A 4 byte timestamp value, representing the ObjectId’s creation, measured in seconds since the Unix epoch.
- A 5 byte is a random value
- A 3 byte incrementing counter, initialised to a random value.
To recap, our document looks like this:
{ "_id" : ObjectId("600631c7c8eb4369cf6ad9c8"), "name" : "Fetch", "born" : ISODate("2020-12-31T23:30:15.123Z") }
This document contains an ObjectId. We can therefore use $dayOfMonth
to return the day of the month that our document was created (or more specifically, when the _id
field’s ObjectId value was created).
Example:
db.pets.aggregate(
[
{
$project:
{
"timeStamp": { $toDate: "$_id"},
"dayOfMonth": { $dayOfMonth: "$_id" }
}
}
]
).pretty()
Result:
{ "_id" : ObjectId("600631c7c8eb4369cf6ad9c8"), "timeStamp" : ISODate("2021-01-19T01:11:35Z"), "dayOfMonth" : 19 }
We can see that the document was created on the 19th day of the month.
In this case, I also used the $toDate
aggregation pipeline operator to return the timestamp portion of the ObjectId.