No MongoDB, o
$year
operador de pipeline de agregação retorna a parte do ano de uma determinada data. Ao usar o
$year
operador, você pode especificar opcionalmente um fuso horário para usar para o resultado. O
$year
O operador aceita uma data (como Date, Timestamp ou ObjectId) ou um documento que especifica a data e o fuso horário a serem usados. Exemplo
Suponha que tenhamos uma coleção chamada
pets
com o seguinte documento:{ "_id" : ObjectId("600631c7c8eb4369cf6ad9c8"), "name" : "Fetch", "born" : ISODate("2020-12-31T23:30:15.123Z") }
Podemos executar o seguinte código para retornar o ano do
born
campo nesse documento. db.pets.aggregate(
[
{
$project:
{
_id: 0,
birthYear: { $year: "$born" }
}
}
]
)
Resultado:
{ "birthYear" : 2020 }
Podemos ver que o ano
2020
é devolvido. Aqui, usei
birthYear
como o nome do campo a ser retornado, mas pode ser qualquer coisa (como yearBorn
, year
, etc). O
_id
campo é retornado por padrão ao usar projeções no MongoDB, mas neste exemplo eu escondi explicitamente o _id
campo usando _id: 0
. Especificar um fuso horário
Você pode especificar um fuso horário a ser usado para a saída do
$year
operador. Quando você faz isso, o argumento é passado para
$year
deve ter a seguinte forma:{ date: <dateExpression>, timezone: <tzExpression> }
Onde
<dateExpression>
é a data a ser usada e <tzExpression>
é o fuso horário a ser usado. O fuso horário pode ser especificado usando o identificador de fuso horário Olson (por exemplo,
"Europe/London"
, "GMT"
) ou o deslocamento UTC (por exemplo, "+02:30"
, "-1030"
). Identificador de fuso horário Olson
Aqui está um exemplo que gera o ano em dois fusos horários diferentes, cada um usando os IDs de fuso horário Olson:
db.pets.aggregate(
[
{
$project: {
_id: 0,
honolulu: {
$year: { date: "$born", timezone: "Pacific/Honolulu" }
},
auckland: {
$year: { date: "$born", timezone: "Pacific/Auckland" }
}
}
}
]
)
Resultado:
{ "honolulu" : 2020, "auckland" : 2021 }
Nesse caso, a data avança para o próximo ano ao usar o
Pacific/Auckland
fuso horário. Deslocamento UTC
Aqui está o mesmo exemplo, exceto que desta vez usamos o deslocamento UTC.
db.pets.aggregate(
[
{
$project: {
_id: 0,
"utcOffset-1000": {
$year: { date: "$born", timezone: "-1000" }
},
"utcOffset+1200": {
$year: { date: "$born", timezone: "+1200" }
}
}
}
]
)
Resultado:
{ "utcOffset-1000" : 2020, "utcOffset+1200" : 2021 }
Retorne o ano de um ObjectId
Você pode usar
$year
para retornar a parte do ano de um ObjectId. Os valores ObjectId são valores hexadecimais de 12 bytes que consistem em:
- Um valor de carimbo de data/hora de 4 bytes, representando a criação do ObjectId, medido em segundos desde a época do Unix.
- Um valor de 5 bytes é aleatório
- Um contador de incremento de 3 bytes, inicializado com um valor aleatório.
Para recapitular, nosso documento se parece com isso:
{ "_id" : ObjectId("600631c7c8eb4369cf6ad9c8"), "name" : "Fetch", "born" : ISODate("2020-12-31T23:30:15.123Z") }
Este documento contém um ObjectId. Podemos, portanto, usar
$year
para retornar o ano em que nosso documento foi criado (ou mais especificamente, quando o _id
valor ObjectId do campo foi criado). Exemplo:
db.pets.aggregate(
[
{
$project:
{
"timeStamp": { $toDate: "$_id"},
"year": { $year: "$_id" }
}
}
]
).pretty()
Resultado:
{ "_id" : ObjectId("600631c7c8eb4369cf6ad9c8"), "timeStamp" : ISODate("2021-01-19T01:11:35Z"), "year" : 2021 }
Podemos ver que o documento foi criado em 2021.
Nesse caso, também usei o
$toDate
operador de pipeline de agregação para retornar a parte de carimbo de data/hora do ObjectId. Ano ISO
Você também pode usar o
$isoWeekYear
operador para retornar o ano de numeração de semana ISO (ou seja, o número do ano usando o formato ISO 8601).