Menu Docs
Página inicial do Docs
/
MongoDB Atlas
/ / /

Revise a Syntax do índice do Atlas Search

Nesta página

  • Sintaxe
  • Opções

O Atlas Search pode indexar dados de diferentes maneiras. Ao definir um índice do Atlas Search, você pode especificar um analisador específico ou vários analisadores para indexar determinados campos. Para saber mais, consulte Como processar dados com analisadores. Você também pode indexar determinados campos e omitir outros, ou você pode indexar dinamicamente todos os campos em uma collection. Para saber mais, consulte Como definir mapeamentos de campo. Você pode definir índices do Atlas Search por meio da UI do Atlas, Atlas Search API, Atlas CLI, mongosh ou Drivers.

Esta página descreve a sintaxe JSON e campos para um índice do Atlas Search.

Importante

Se você utilizar o estágio de aggregation $out para modificar uma collection com um índice do Atlas Search, deverá excluir e recriar o índice de pesquisa. Se possível, considere usar $merge em vez de $out.

Campo
Tipo
necessidade
Descrição
analyzer
string
Opcional
Especifica o analyzer para aplicar aos campos da string ao indexar. Se você definir isso apenas na parte superior e não especificar um analyzer para os campos na definição do índice, o Atlas Search aplicará esse analyzer a todos os campos. Para usar um analyzer diferente para cada campo, você deve especificar um analyzer diferente para o campo. Se omitido, o padrão será Analyzer padrão.
analyzers
Opcional
Especifica os Analyzers customizados a serem usados neste índice.
mappings
Obrigatório
Especifica como indexar campos em caminhos diferentes para este índice.
mappings.dynamic
booleano
Opcional

Habilita ou desabilita o mapeamento dinâmico de campos para este índice.

Se definido como true, o Atlas Search indexará recursivamente todos os campos indexáveis dinamicamente.

Se definido como false, você deve especificar campos individuais para indexar usando mappings.fields.

Se omitido, o padrão é false.

Importante

O Atlas Search indexa dinamicamente todos os campos em um document utilizando as configurações padrão para o tipo de dados detectado. O Atlas Search também indexa dinamicamente todos os documentos aninhados sob document, a menos que você substitua explicitamente definindo dynamic para false.

Para saber mais, consulte exemplo de configuração de índice.

mappings.fields
documento
Condicional

Necessário apenas se o mapeamento dinâmico estiver desabilitado.

Especifica os campos que você deseja indexar. Para saber mais, consulte Definir mapeamentos de campo.

Observação

Você não pode indexar campos que contêm o sinal de dólar ($) no início do nome do campo.

searchAnalyzer
string
Opcional
Especifica o analisador a ser aplicado ao texto de query antes de usá-lo para fazer uma pesquisa. Se omitido, é padronizado para o analisador que você especifica para a opção analyzer. Se você omitir as opções searchAnalyzer e analyzer, o padrão será o analisador padrão.
storedSource
Opcional

Especifica os campos nos documentos a serem armazenados para pesquisas de tempo de query usando a opção returnedStoredSource. Você pode armazenar campos de todos os tipos de dados no Atlas Search. O valor pode ser um dos seguintes:

  • true, para armazenar todos os campos

  • false, para não armazenar nenhum campo

  • Objeto que especifica os campos de include ou exclude a partir do armazenamento

Se omitido, o padrão é false. Para saber mais sobre a sintaxe e campos, consulte Definir campos de origem armazenados no seu índice do Atlas Search.

Observação

storedSource está disponível apenas em clusters Atlas que executam uma das seguintes versões:

  • MongoDB 5.0.6+

  • MongoDB 6.0+

  • MongoDB 7.0+

synonyms
Opcional

Mapeamentos de sinônimos para usar em seu índice. Para saber mais, consulte Definir mapeamentos de sinônimos em seu índice do Atlas Search.

Observação

Uma definição de índice pode ter somente um mapeamento de sinônimo.

← Defina Mapeamentos Sinônimos em seu Índice de Busca no Atlas

Nesta página