$hour (agregação)

Definição

$hour

Retorna a parte de hora de uma data como um número entre 0 e 23.

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

{ $hour: <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	Optional. 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 UTC Offset. Se nenhum timezone for fornecido, o resultado será exibido em UTC. Formatar Exemplos 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

{ $hour: new Date("2016-01-01T12:00:00Z") }

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

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

{ $hour: ISODate("2017-10-19T00:00:00Z") }

{ $hour: {
    date: ISODate("2017-10-19T00:00:00Z"),
    timezone: "+0530"
} }

{ $hour: "March 28, 1976" }

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

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

Exemplo

Considere uma coleção sales com o seguinte documento:

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

A agregação a seguir utiliza o $hour e outras expressões 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" }
         }
     }
   ]
)

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
}