Menu Docs
Página inicial do Docs
/
Atlas
/
Atlas Search
/
Queries e índices

Referência do índice

Nesta página

Um índice do Atlas Search é uma estrutura de dados que mapeia documentos do seu Atlas cluster para os termos extraídos desses documentos. Os índices do Atlas Search permitem pesquisas eficientes de texto completo do seu banco de dados.

Ao definir um índice do Atlas Search, você pode utilizar mapeamentos estáticos ou dinâmicos para especificar quais campos deseja indexar em sua collection. Você também pode usar analisadores para definir como o Atlas Search extrai tokens pesquisáveis de string campos ou strings de query. Por fim, você pode aplicar opções de configuração adicionais em sua definição de índice para melhorar o desempenho e a precisão de sua query do Atlas Search, incluindo opções para armazenar campos de origem em seu índice ou definir mapeamentos de sinônimos.

Para saber como definir um índice do Atlas Search de acordo com seus requisitos de query, consulte Criar um índice do Atlas Search. Depois de definir seu índice do Atlas Search, você pode adicionar o índice ao seu cluster do Atlas com o tutorial Criar um índice do Atlas Search. Para aprender como visualizar, editar, atualizar ou excluir seu índice de Atlas Search, consulte Gerenciar Índices de Atlas Search.

Esta página descreve a sintaxe e as opções de definiçãoJSON para um índice do Atlas Search .

Sintaxe

1{ 
2  "mappings": { 
3    "dynamic": <boolean>, 
4    "fields": { <field-definition> } 
5  }
6}
7  
1{
2  "analyzer": "<analyzer-for-index>", 
3  "searchAnalyzer": "<analyzer-for-query>", 
4  "mappings": { 
5    "dynamic": <boolean>, 
6    "fields": { <field-definition> } 
7  },
8  "numPartitions": <integer>,
9  "analyzers": [ <custom-analyzer> ],
10  "storedSource": <boolean> | {
11    <stored-source-definition>
12  },
13  "synonyms": [
14    {
15      <synonym-mapping-definition>
16    }
17  ] 
18}
19

Opções

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á Analisador padrão.

analyzers

array de analisadores customizados

Opcional

Especifica os Analyzers customizados a serem usados neste índice.

mappings

Definição do campo do documento

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 usando 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 conferir exemplos de configurações de índice, consulte Exemplo de mapeamento estático ou Exemplo de mapeamento combinado

mappings.fields

documento

Condicional

Especifica os campos que você deseja indexar. Necessário apenas se o mapeamento dinâmico estiver desabilitado.

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

Para saber mais, consulte Definir mapeamentos de 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.

numPartitions

int

Opcional

Especifica o número de subíndices a serem criados se a contagem de documento exceder dois bilhões. Os seguintes valores são válidos: 1, 2, 4. Se omitido, o padrão é 1.

Para usar partições de índice, você deve ter nós de pesquisa distribuídos em seu cluster.

storedSource

boolean ou definição de origem armazenada

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

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+

Se omitido, o padrão é false.

Para saber mais, consulte Definir campos de origem armazenados em seu índice do Atlas Search.

synonyms

array de Definição de mapeamento de sinônimos

Opcional

Mapeamentos de sinônimos para usar em seu índice.

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

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

Índices de solução de problemas

mongot Processo não instalado ou em execução

O seguinte erro é retornado se você executar query do $search quando o processo do Atlas Search mongot não estiver instalado ou executando:

MongoError: Remote error from mongot :: caused by :: Error connecting to localhost:28000.

O processo mongot é instalado somente quando o primeiro índice de pesquisa do Atlas Search é definido. Se você não tiver nenhum índice do Atlas Search em seu cluster do Atlas, crie pelo menos um índice do Atlas Search para resolver esse erro.

Saiba mais

Para saber como definir um índice do Atlas Search para atender suas necessidades de query do Atlas Search, consulte Criar um índice do Atlas Search.

Para aprender como adicionar um índice ao seu agrupamento do Atlas, consulte Criar um Índice do Atlas Search.

Para saber mais sobre as opções de configuração de índice disponíveis, consulte as seguintes páginas de referência:

Voltar

Gerenciar índices

Próximo

Analisadores