- Reference >
- Operators >
- Aggregation Pipeline Operators >
- $dayOfWeek (aggregation)
$dayOfWeek (aggregation)¶
On this page
Definition¶
-
$dayOfWeek¶ Returns the day of the week for a date as a number between 1 (Sunday) and 7 (Saturday).
The
$dayOfWeekexpression 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 dateThe date to which the operator is applied. <dateExpression>must be a valid expression that resolves to a Date, a Timestamp, or an ObjectID.timezoneOptional.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 notimezoneis provided, the result is displayed inUTC.FormatExamplesOlson 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 |
|---|---|
| 6 | |
| 3 | |
| 1 | |
| 7 | |
| 6 | |
error |
|
error |
|
error |
Note
$dayOfWeek cannot take a string as an argument.
Example¶
Consider a sales collection with the following document:
The following aggregation uses the $dayOfWeek and other
date operators to break down the date field:
The operation returns the following result: