In MongoDB, the $minute
aggregation pipeline operator returns the minute portion of a date as a number between 0
and 59
.
You can optionally specify a timezone to use for the result.
The $minute
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 minute portion from the born
field in that document.
db.pets.aggregate(
[
{
$project:
{
_id: 0,
birthMinute: { $minute: "$born" }
}
}
]
)
Result:
{ "birthMinute" : 30 }
Here, I used birthMinute
as the field name to return, but this could have been anything (such as minutesAtBirth
, minutes
, 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 $minute
operator.
When you do this, the argument passed to $minute
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 minute in two different timezones, each using the Olson timezone IDs:
db.pets.aggregate(
[
{
$project: {
_id: 0,
kabul: {
$minute: { date: "$born", timezone: "Asia/Kabul" }
},
katmandu: {
$minute: { date: "$born", timezone: "Asia/Katmandu" }
}
}
}
]
)
Result:
{ "kabul" : 0, "katmandu" : 15 }
UTC Offset
In this example we use the UTC offset.
db.pets.aggregate(
[
{
$project: {
_id: 0,
"utcOffset+04:30": {
$minute: { date: "$born", timezone: "+04:30" }
},
"utcOffset+05:45": {
$minute: { date: "$born", timezone: "+05:45" }
}
}
}
]
)
Result:
{ "utcOffset+04:30" : 0, "utcOffset+05:45" : 15 }
Return the Minutes from an ObjectId
You can use $minute
to return the minute 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 $minute
to return the minute 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"},
"minute": { $minute: "$_id" }
}
}
]
).pretty()
Result:
{ "_id" : ObjectId("600631c7c8eb4369cf6ad9c8"), "timeStamp" : ISODate("2021-01-19T01:11:35Z"), "minute" : 11 }
We can see that the document was created on the 11th minute of the 1st hour of the day.
In this case, I also used the $toDate
aggregation pipeline operator to return the timestamp portion of the ObjectId.