$year (aggregation)
On this page
Definition
-
$year
-
Returns the year portion of a date.
The
$year
expression has the following operator expression syntax:Changed in version 3.6.
The argument must be a valid expression that resolves to one of the following:
A document of the following form:
New in version 3.6.
Field Description date
The date to which the operator is applied. <dateExpression>
must be a valid expression that resolves to a Date, a Timestamp, or an ObjectID.timezone
Optional.
The timezone of the operation result.<tzExpression>
must be a valid expression that resolves to a string formatted as either an Olson Timezone Identifier or a UTC Offset . If notimezone
is provided, the result is displayed inUTC
.Format
Examples
Olson Timezone Identifier "America/New_York" "Europe/London" "GMT"
UTC Offset +/-[hh]:[mm], e.g. "+04:45" +/-[hh][mm], e.g. "-0530" +/-[hh], e.g. "+03"
Behavior
Example | Result |
---|---|
2016 | |
2003 | |
2011 | |
1998 | |
1998 | |
error |
|
error |
|
error |
Note
$year
cannot take a string as an argument.
Example
Consider a sales
collection with the following documents:
The following aggregation uses the $year
and other date operators to break down the date
field:
The operation returns the following result: