$year ( operador de expressão )

Definição

$year

Retorna a parte do ano de uma data.

A expressão $year tem a seguinte sintaxe de expressão do operador:

{ $year: <dateExpression> }

O argumento pode ser:

• Uma expressão que produza uma Data, um Timestamp ou um ObjectID.

• Um documento com este formato:

  { date: <dateExpression>, timezone: <tzExpression> }

  Campo	Descrição
  date	A data em que o operador é aplicado. <dateExpression> deve ser uma expressão válida que produza uma Data, um Timestamp ou um ObjectID.
  timezone	Opcional. O fuso horário do resultado da operação. <tzExpression> deve ser uma expressão válida que resolva para uma string formatada como um Identificador de fuso horário Olson ou um Deslocamento UTC. Se nenhum timezone for fornecido, o resultado estará em UTC. 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"

Comportamento

{ $year: new Date("2016-01-01") }

{ $year: { date: new Date("Jan 7, 2003") } }

{ $year: {    date: new Date("August 14, 2011"),    timezone: "America/Chicago"} }

{ $year: ISODate("1998-11-07T00:00:00Z") }

{ $year: {    date: ISODate("1998-11-07T00:00:00Z"),    timezone: "-0400"} }

{ $year: "March 28, 1976" }

{ $year: Date("2016-01-01") }

{ $year: "2009-04-09" }

Exemplo

Considere uma collection sales com os seguintes documentos:

 db.sales.insertOne(  {   "_id" : 1,   "item" : "abc",   "price" : 10,   "quantity" : 2,   "date" : ISODate("2014-01-01T08:15:39.736Z")  })

A agregação a seguir utiliza o $year e outros operadores de data para decompor o campo date:

db.sales.aggregate(   [     {       $project:         {           year: { $year: "$date" },           month: { $month: "$date" },           day: { $dayOfMonth: "$date" },           hour: { $hour: "$date" },           minutes: { $minute: "$date" },           seconds: { $second: "$date" },           milliseconds: { $millisecond: "$date" },           dayOfYear: { $dayOfYear: "$date" },           dayOfWeek: { $dayOfWeek: "$date" },           week: { $week: "$date" }         }     }   ])

A operação retorna o seguinte resultado:

{  "_id" : 1,  "year" : 2014,  "month" : 1,  "day" : 1,  "hour" : 8,  "minutes" : 15,  "seconds" : 39,  "milliseconds" : 736,  "dayOfYear" : 1,  "dayOfWeek" : 4,  "week" : 0}