$dateTrunc (agregação)
Nesta página
Definição
Novidades na versão 5.0.
Trunca uma data.
$dateTrunc
sintaxe:
{ $dateTrunc: { date: <Expression>, unit: <Expression>, binSize: <Expression>, timezone: <tzExpression>, startOfWeek: <Expression> } }
Campo | Obrigatório/Opcional | Descrição | ||||||
---|---|---|---|---|---|---|---|---|
Obrigatório | A data para truncar, especificada em UTC. A data pode ser qualquerexpressão atrelada a uma Data, um Carimbo de Data/Hora ou um ObjectID. | |||||||
Obrigatório | A unidade de tempo, especificada como uma expressão que deve ser resolvida para uma dessas strings:
Juntos, binSize e unit especificam o período de tempo usado no cálculo | |||||||
Opcional | O valor numérico de tempo, especificado como uma expressão que deve ser resolvida para um número positivo diferente de zero. O padrão é 1. Juntos, binSize e unit especificam o período de tempo usado no cálculo | |||||||
Opcional | O fuso horário para o cálculo Se nenhum fuso horário for fornecido, o cálculo
| |||||||
Opcional | O início da semana. Usado quando a unidade é startOfWeek é uma expressão que deve ser resolvida para uma destas strings sem distinção entre maiúsculas e minúsculas:
|
Comportamento
Retorna
null
se:qualquer um dos campos de entrada, exceto startOfWeek, está ausente ou definido como
null
, ouse a unidade for
week
e startOfWeek estiver ausente ou definido comonull
.
Usa o calendário gregoriano proléptico para datas anteriores ao ano 1583.
Contabiliza o horário de verão, mas não contabiliza os segundos bissextos.
binSize
e unit
campos
Juntos, binSize e unit especificam o período de tempo usado no cálculo $dateTrunc
.
Por exemplo:
Se binSize for
1
e unidade forhour
, o período de tempo será de uma hora. Para a data2021-03-20T11:30:05Z
,$dateTrunc
retorna2021-03-20T11:00:00Z
.Se binSize for
2
e unidade forhour
, o período de tempo será de duas horas. Para a data2021-03-20T11:30:05Z
,$dateTrunc
retorna2021-03-20T10:00:00Z
.
Divide o tempo para o cálculo do
$dateTrunc
em períodos binSize na unidade de tempo especificada.Os períodos de tempo começam em uma data de referência, que é determinada por unidade. Se a unidade for:
Uma string diferente de
week
,$dateTrunc
utiliza uma data de referência de2000-01-01T00:00:00.00Z
. Por exemplo, se binSize for10
e unidade foryear
, os períodos de tempo de exemplo serão:2000-01-01T00:00:00.00Z
2010-01-01T00:00:00.00Z
2020-01-01T00:00:00.00Z
Igual a
week
,$dateTrunc
usa uma data de referência que é definida como o primeiro dia da semana mais cedo que é maior ou igual a2000-01-01
. O primeiro dia é definido usando startOfWeek (o padrão é domingo).
Retorna o limite inferior do período de tempo em que a data está. O limite é retornado como uma ISODate. Se o campo binSize estiver
1
,$dateTrunc
define as partes menos significativas (conforme determinado por unidade) da ISODate retornada como0
e mantém o restante da ISODate igual.
Se a unidade for:
year
:$dateTrunc
retorna o ISODato para o início de janeiro de 1 para o ano em data.quarter
::$dateTrunc
retorna o ISODato para o início do primeiro dia do trimestre do calendário em data.Os trimestres são:
De janeiro a março
De abril a junho
De julho a setembro
De outubro a dezembro
month
:$dateTrunc
retorna o ISODate para o início do primeiro dia do mês em data.week
:$dateTrunc
retorna a ISODate para o início do dia startOfWeek em data. O padrão de startOfWeek é domingo.day
:$dateTrunc
retorna o ISODato para o início do dia em date (data).hour
::$dateTrunc
retorna a ISODate para o início da hora em data.minute
$dateTrunc
retorna a ISODate para o início do minuto em data.second
::$dateTrunc
retorna o ISODato para o início do segundo em data.
unit
e startOfWeek
campos
Se a unidade for:
Uma string diferente de
week
, startOfWeek é ignorada.Igual a
week
e startOfWeek é:Especificado:
$dateTrunc
usa startOfWeek como o primeiro dia da semana para o cálculo.Omitido:
$dateTrunc
utiliza Domingo como o início da semana para o cálculo.
Exemplos
Crie uma collection cakeSales
que contenha vendas de bolo nos estados da Califórnia (CA
) e de Washington (WA
):
db.cakeSales.insertMany( [ { _id: 0, type: "chocolate", orderDate: new Date("2020-05-18T14:10:30Z"), state: "CA", price: 13, quantity: 120 }, { _id: 1, type: "chocolate", orderDate: new Date("2021-03-20T11:30:05Z"), state: "WA", price: 14, quantity: 140 }, { _id: 2, type: "vanilla", orderDate: new Date("2021-01-11T06:31:15Z"), state: "CA", price: 12, quantity: 145 }, { _id: 3, type: "vanilla", orderDate: new Date("2020-02-08T13:13:23Z"), state: "WA", price: 13, quantity: 104 }, { _id: 4, type: "strawberry", orderDate: new Date("2019-05-18T16:09:01Z"), state: "CA", price: 41, quantity: 162 }, { _id: 5, type: "strawberry", orderDate: new Date("2019-01-08T06:12:03Z"), state: "WA", price: 43, quantity: 134 } ] )
A coleção cakeSales
é utilizada nos seguintes exemplos.
Truncar datas de pedido em um $project
estágio de pipeline
Este exemplo usa $dateTrunc
em um estágio $project
para truncar os valores de orderDate
de vendas de bolo para duas semanas:
db.cakeSales.aggregate( [ { $project: { _id: 1, orderDate: 1, truncatedOrderDate: { $dateTrunc: { date: "$orderDate", unit: "week", binSize: 2, timezone: "America/Los_Angeles", startOfWeek: "Monday" } } } } ] )
No exemplo:
$project
inclui os campos_id
,orderDate
etruncatedOrderDate
na saída.$dateTrunc
trunca o campoorderDate
para um2
week
unidade períodoAmerica/Los_Angeles
de binSize fuso horário com startOfWeek definido comoMonday
.
Neste exemplo de saída, o orderDate
truncado é mostrado no campo truncatedOrderDate
:
[ { _id: 0, orderDate: ISODate("2020-05-18T14:10:30.000Z"), truncatedOrderDate: ISODate("2020-05-11T07:00:00.000Z") }, { _id: 1, orderDate: ISODate("2021-03-20T11:30:05.000Z"), truncatedOrderDate: ISODate("2021-03-15T07:00:00.000Z") }, { _id: 2, orderDate: ISODate("2021-01-11T06:31:15.000Z"), truncatedOrderDate: ISODate("2021-01-04T08:00:00.000Z") }, { _id: 3, orderDate: ISODate("2020-02-08T13:13:23.000Z"), truncatedOrderDate: ISODate("2020-02-03T08:00:00.000Z") }, { _id: 4, orderDate: ISODate("2019-05-18T16:09:01.000Z"), truncatedOrderDate: ISODate("2019-05-13T07:00:00.000Z") }, { _id: 5, orderDate: ISODate("2019-01-08T06:12:03.000Z"), truncatedOrderDate: ISODate("2019-01-07T08:00:00.000Z") } ]
Truncar datas de pedidos e obter soma de quantidade em um $group
estágio de pipeline
Este exemplo usa $dateTrunc
em um estágio $group
para truncar os valores orderDate
de vendas do bolo para seis meses e retornar a soma dos valores quantity
:
db.cakeSales.aggregate( [ { $group: { _id: { truncatedOrderDate: { $dateTrunc: { date: "$orderDate", unit: "month", binSize: 6 } } }, sumQuantity: { $sum: "$quantity" } } } ] )
No exemplo:
$group
tem o campo_id
configurado para o campotruncatedOrderDate
para agrupar os documentoscakeSales
e retorna a soma dos valoresquantity
para cada grupo utilizando$sum
.$dateTrunc
trunca o campoorderDate
em um período de6
binSizemonth
unit.
Neste exemplo de saída, o orderDate
truncado é mostrado no campo truncatedOrderDate
e a soma quantity
é mostrada no campo sumQuantity
:
[ { _id: { truncatedOrderDate: ISODate("2020-01-01T00:00:00.000Z") }, sumQuantity: 224 }, { _id: { truncatedOrderDate: ISODate("2021-01-01T00:00:00.000Z") }, sumQuantity: 285 }, { _id: { truncatedOrderDate: ISODate("2019-01-01T00:00:00.000Z") }, sumQuantity: 296 } ]