O MongoDB permite nomes de campo que contenham cifrões ($) ou pontos (.). No entanto, o uso desses caracteres nos nomes dos campo é desaconselhado, porque o MongoDB não suporta algumas funcionalidades com estes campos.
Na maioria dos casos, os dados que foram armazenados utilizando nomes de campo como estes não são diretamente acessíveis. Você precisa utilizar métodos de assistente como $getField, $setField e $literal em consultas que acessam estes campos.
As regras de validação de nome de campo não são as mesmas para todos os tipos de operações de armazenamento.
Restrições gerais
Há algumas restrições gerais sobre o uso de nomes de campo prefixados em dólar ($) ou nomes de campo que contenham um ponto (.). Esses campos não podem:
Ser indexado
Ser usado como parte de uma chave de fragmento
Ser validados usando
$jsonSchemaSer modificado com uma sequência de escape
Ser usado com criptografia de nível de campo
Ser usado como subcampo em um documento
_id
Aviso
Perda de dados possível com assinaturas em dólares ($) e períodos (.)
Há uma pequena chance de perda de dados ao usar nomes de campo com prefixo de cifrão ($) ou nomes de campo que contenham pontos (.) se esses nomes de campo forem usados em conjunto com gravações não reconhecidas de (write concern w=0) em servidores mais antigos que o MongoDB 5.0.
Ao executar os comandos insert, update e findAndModify, os drivers compatíveis com a versão 5.0 removem as restrições de uso de documentos com nomes de campo com prefixo de cifrão ($) ou que contenham pontos (.). Esses nomes de campo geraram um erro do lado do cliente nas versões anteriores do driver.
As restrições são removidas independentemente da versão do servidor à qual o driver está conectado. Se um driver do 5.0 enviar um documento para um servidor mais antigo, o documento será rejeitado sem enviar um erro.
Aviso
Preocupações de importação e exportação com assinaturas de dólar ($) e períodos (.)
A partir do MongoDB 5.0, os nomes dos campos do documento podem ter prefixo de cifrão ($) e podem conter pontos (.). No entanto, mongoimport e mongoexport podem não funcionar como esperado em algumas situações com nomes de campo que fazem uso destes caracteres.
O JSON estendido v2 MongoDB não consegue diferenciar entre os wrappers de tipo e os campos que têm o mesmo nome dos wrappers de tipo. Não use formatos JSON estendidos em contextos onde as representações BSON correspondentes possam incluir chaves prefixadas com cifrões ($). O mecanismo DBRef é uma exceção a esta regra geral.
Também há restrições quanto ao uso de mongoimport e mongoexport com pontos (.) em nomes de campos. Como os arquivos CSV usam o ponto (.) para representar hierarquias de dados, um ponto (.) em um nome de campo será interpretado incorretamente como um nível de aninhamento.
Saiba mais
Para obter exemplos de como lidar com nomes de campos que contêm pontos e cifrões, consulte estas páginas: