Definição
$dateFromStringConverte uma string de data/hora em um objeto de data.
A expressão
$dateFromStringtem a seguinte sintaxe:{ $dateFromString: { dateString: <dateStringExpression>, format: <formatStringExpression>, timezone: <tzExpression>, onError: <onErrorExpression>, onNull: <onNullExpression> } } O
$dateFromStringpega um documento com os seguintes campos:CampoDescriçãodateStringA string de data/hora para converter para um objeto de data. Consulte
Date()para obter mais informações sobre formatos de data/hora.Se especificar a opção
timezonepara o operador, não inclua informações de fuso horário nodateString.formatOpcional. A especificação do formato de data do
dateString. Oformatpode ser qualquer expressão que avalia para uma string literal, contendo especificadores de formato 0 ou mais. Para obter uma lista dos especificadores disponíveis, consulte Especificadores de formato.Se não for especificado,
$dateFromStringusa"%Y-%m-%dT%H:%M:%S.%LZ"como o formato padrão, mas aceita uma variedade de formatos e tenta analisar odateStringse possível.timezoneOpcional. O fuso horário a ser usado para formatar a data.
Se o argumento
dateStringestiver formatado como "2017-02-08T12:10:40,787Z", no qual o "Z" no final indica a hora de Zulu (fuso horário UTC), você não poderá especificar o argumentotimezone.<timezone>permite as seguintes opções e expressões que avaliam para eles:um Identificador de fuso horário Olson, como
"Europe/London"ou"America/New_York", ouum deslocamento UTC no formato:
+/-[hh]:[mm], e.g."+04:45"ou+/-[hh][mm], e.g."-0530"ou+/-[hh], e.g."+03"ou
As strings
"Z","UTC"ou"GMT"
Para mais informações sobre expressões, consulte Expressões.
onErrorOpcional. Se encontrar um erro ao analisar
$dateFromStringodateStringfornecido, ele produzirá o valor de resultado daonErrorexpressão fornecida. Esse valor de resultado pode ser de qualquer tipo.Se você não
onErrorespecificar, gerará um erro se não$dateFromStringconseguirdateStringanalisar.onNullOpcional. Se o
dateStringfornecido a$dateFromStringestivernullou ausente, ele produzirá o valor de resultado daonNullexpressão fornecida. Esse valor de resultado pode ser de qualquer tipo.Se você não especificar
onNulledateStringnullestiver ou$dateFromStringausente,nullsaídas.
Comportamento
Exemplo | Resultados | ||||
|---|---|---|---|---|---|
|
| ||||
|
| ||||
|
| ||||
|
| ||||
|
| ||||
|
| ||||
|
|
Especificadores de formato
Os seguintes especificadores de formato estão disponíveis para uso no <formatString>:
Especificadores | Descrição | Valores possíveis |
|---|---|---|
| Mês abreviado (3 letras) |
|
| Nome do mês inteiro |
|
| Dia do mês (2 dígitos, zero acolchoado) |
|
| Ano no formato ISO 8601 |
|
| Hora (2 dígitos, zero acolchoado, relógio de 24 horas) |
|
| Dia do ano (3 dígitos, zero preenchido) |
|
| Milissegundo (3 dígitos, zero preenchido) |
|
| Mês (2 dígitos, zero preenchido) |
|
| Minuto (2 dígitos, zero preenchido) |
|
| Segundo (2 dígitos, zero preenchido) |
|
| Número do dia da semana no formato ISO 8601 (1-segunda, 7-domingo) |
|
| Semana do ano (2 dígitos, zero preenchido) |
|
| Semana do ano no formato ISO 8601 |
|
| Dia da semana como número inteiro (0-domingo, 6-sábado) |
|
| Ano (4 dígitos, zero preenchido) |
|
| Deslocamento do fuso horário de UTC. |
|
| Os minutos são compensados do UTC como um número. Por exemplo, se o deslocamento de fuso horário ( |
|
| Caractere percentual como literal |
|
Exemplos
Convertendo datas
Considere uma coleção logmessages que contenha os seguintes documentos com datas.
{ _id: 1, date: "2017-02-08T12:10:40.787", timezone: "America/New_York", message: "Step 1: Started" }, { _id: 2, date: "2017-02-08", timezone: "-05:00", message: "Step 1: Ended" }, { _id: 3, message: " Step 1: Ended " }, { _id: 4, date: "2017-02-09", timezone: "Europe/London", message: "Step 2: Started"}, { _id: 5, date: "2017-02-09T03:35:02.055", timezone: "+0530", message: "Step 2: In Progress"}
A seguinte agregação utiliza $dateFromString para converter o valor date para um objeto de data:
db.logmessages.aggregate( [ { $project: { date: { $dateFromString: { dateString: '$date', timezone: 'America/New_York' } } } } ] )
A agregação acima retorna os seguintes documentos e converte cada campo date para o fuso horário Fuso Horário Oriental (Eastern Time Zone):
{ "_id" : 1, "date" : ISODate("2017-02-08T17:10:40.787Z") } { "_id" : 2, "date" : ISODate("2017-02-08T05:00:00Z") } { "_id" : 3, "date" : null } { "_id" : 4, "date" : ISODate("2017-02-09T05:00:00Z") } { "_id" : 5, "date" : ISODate("2017-02-09T08:35:02.055Z") }
O argumento timezone também pode ser fornecido através de um campo de documento em vez de um argumento codificado. Por exemplo:
db.logmessages.aggregate( [ { $project: { date: { $dateFromString: { dateString: '$date', timezone: '$timezone' } } } } ] )
A agregação acima retorna os seguintes documentos e converte cada campo date em suas respectivas representações UTC.
{ "_id" : 1, "date" : ISODate("2017-02-08T17:10:40.787Z") } { "_id" : 2, "date" : ISODate("2017-02-08T05:00:00Z") } { "_id" : 3, "date" : null } { "_id" : 4, "date" : ISODate("2017-02-09T00:00:00Z") } { "_id" : 5, "date" : ISODate("2017-02-08T22:05:02.055Z") }
onError
Se a sua coleção contiver documentos com strings de data não analisáveis, $dateFromString lançará um erro, a menos que você forneça uma expressão de agregação ao parâmetro onError opcional.
Por exemplo, dada uma coleção dates com os seguintes documentos:
{ "_id" : 1, "date" : "2017-02-08T12:10:40.787", timezone: "America/New_York" }, { "_id" : 2, "date" : "20177-02-09T03:35:02.055", timezone: "America/New_York" }
Você pode usar o parâmetro onError para retornar a data inválida em seu formato de string original:
db.dates.aggregate( [ { $project: { date: { $dateFromString: { dateString: '$date', timezone: '$timezone', onError: '$date' } } } } ] )
Isso retorna os seguintes documentos:
{ "_id" : 1, "date" : ISODate("2017-02-08T17:10:40.787Z") } { "_id" : 2, "date" : "20177-02-09T03:35:02.055" }
onNull
Se sua coleção contiver documentos com strings de data null, $dateFromString retornará null, a menos que você forneça uma expressão de agregação ao parâmetro opcional onNull.
Por exemplo, dada uma coleção dates com os seguintes documentos:
{ "_id" : 1, "date" : "2017-02-08T12:10:40.787", timezone: "America/New_York" }, { "_id" : 2, "date" : null, timezone: "America/New_York" }
Você pode utilizar o parâmetro onNull para que $dateFromString retorne uma data que representa a Era UNIX em vez de null:
db.dates.aggregate( [ { $project: { date: { $dateFromString: { dateString: '$date', timezone: '$timezone', onNull: new Date(0) } } } } ] )
Isso retorna os seguintes documentos:
{ "_id" : 1, "date" : ISODate("2017-02-08T17:10:40.787Z") } { "_id" : 2, "date" : ISODate("1970-01-01T00:00:00Z") }