Página inicial do Docs → Iniciar e gerenciar o MongoDB → MongoDB Atlas
criar um índice do atlas search
Nesta página
- Pré-requisitos
- Acesso obrigatório
- Crie um Atlas Search usando a interface do usuário do Atlas
- Criar um Índice de Pesquisa Atlas utilizando a API de Pesquisa Atlas
- Crie um índice de pesquisa do Atlas usando o Atlas CLI
- Criar um índice de pesquisa do Atlas com o MongoDB Compass
- Crie um Atlas Search programaticamente
- Status do nó
O índice do Atlas Search é uma estrutura de dados que categoriza os dados em um formato facilmente pesquisável. É um mapeamento entre os termos e os documentos que contêm esses termos. Os índices do Atlas Search permitem a recuperação mais rápida de documentos usando determinados identificadores. Você deve configurar um índice do Atlas Search para fazer query em dados em seu cluster Atlas usando o Atlas Search.
Você pode criar um índice de Pesquisa do Atlas em um único campo ou em múltiplos campos. Recomendamos que você indexe os campos que usa regularmente para classificar ou filtrar seus dados para recuperar rapidamente os documentos que contêm os dados relevantes em tempo de query.
Você pode criar um índice Atlas Search para todas as collections exceto coleções de sériestemporais em seu Atlas cluster por meio da UI do Atlas, da API, do Atlas CLI e do Terraform.
Importante
Pré-requisitos
Para criar um índice de Atlas Search, você deve ter um agrupamento do Atlas com:
MongoDB versão
4.2ou superiorColeção para criar o índice de Pesquisa Atlas para
Acesso obrigatório
A tabela a seguir mostra os modos de acesso que cada papel suporta.
Função | em ação | UI do Atlas | API do Atlas | API de pesquisa do Atlas | Atlas CLI |
|---|---|---|---|---|---|
Project Data Access Read Only ou role superior | Para visualizar analisadores e índices do Atlas Search. | ✓ | ✓ | ||
Project Data Access Admin ou role superior | Para criar e gerenciar analisadores e índices do Atlas Search e atribuir a função à sua chave de API. | ✓ | ✓ | ✓ | ✓ |
Project Owner papel | ✓ | ✓ | |||
Organization Owner papel | Para criar entradas de lista de acesso para sua Chave de API e enviar a solicitação de um cliente que aparece na lista de acesso para sua Chave de API. | ✓ | ✓ | ||
Para criar, visualizar, editar e excluir índices do Atlas Search usando a UI ou API do Atlas. | ✓ | ✓ | ✓ |
Observação
Não é possível criar mais de:
3 índices em clusters
M0.5 índices em
M2clusters.10 índices em
M5clusters.
Não há limites para o número de índices que você pode criar em M10+ clusters.
Crie um Atlas Search usando a interface do usuário do Atlas
Ao criar um novo índice do Atlas Search, escolha um método de configuração.
Você pode especificar o tipo de índice que deseja criar. Para queries do $search, se você não especificar explicitamente o type, o padrão do type será search.
Você pode usar a definição de índice padrão ou especificar uma definição personalizada para o índice. A definição de índice padrão é o mapeamento dinâmico de campos nos documentos e funcionará com qualquer coleção. Se desejar criar uma definição de índice personalizada para mapeamento estático, você poderá especificar quais campos indexar com qual analisador e como qual tipo de dados.
O nome padrão do índice é default. Você pode deixar o nome padrão no lugar ou escolher um deles.
Observação
Se você nomear seu índice como default, não precisará especificar um parâmetro index ao usar o estágio do pipeline $search. Caso contrário, você deve especificar o nome do índice utilizando o parâmetro index.
Os nomes dos índices devem ser exclusivos em seu namespace.
Você prefere aprender assistindo?
Acompanhe este tutorial em vídeo que demonstra como criar índices de Atlas Search de várias complexidades.
Duração: 15 Minutos
Procedimento
Para criar um índice do Atlas Search a partir da interface do usuário do Atlas:
Navegue até a página Visão Geral do Cluster do Atlas.
Clique em Database no canto superior esquerdo do Atlas para navegar até a página Database Deployments do seu projeto.
Clique no nome do cluster para visualizar os detalhes do cluster.
Clique na aba Atlas Search.
Crie um índice.
Clique em Create Search Index.
Selecione um Atlas Search Configuration Method e clique Next em .
Para uma experiência abada, selecione a Pesquisa Atlas Visual Editor.
Para editar a definição de índice bruto, selecione a Pesquisa Atlas JSON Editor.
Insira o Index Name e defina o Database and Collection.
No campo Index Name, insira um nome para o índice.
Observação
Se você nomear seu índice como
default, não precisará especificar um parâmetroindexao usar o estágio do pipeline $search. Caso contrário, você deve especificar o nome do índice utilizando o parâmetroindex.Na seção Database and Collection, localize o banco de dados ou coleção e selecione o nome da coleção.
Se você utilizar o Visual Editor, clique em Next.
Revise as definições padrão de configuração do índice do Atlas Search na seção Index Configurations.
Se você estiver satisfeito com a configuração padrão, pule para a etapa 10. Se você deseja refinar o índice do Atlas Search, vá para a próxima etapa.
Refine seu índice do Atlas Search para definir as configurações adicionais.
Opcional: Se você usar o Visual Editor, poderá salvar ou excluir seu rascunho de definição de índice.
Observação
Se você utilizar o Visual Editor e sua definição de índice contiver mapeamentos estáticos, você poderá salvar uma definição de índice como um rascunho. Não é possível salvar a definição de índice padrão como rascunho. Você pode salvar apenas uma definição de índice personalizada como rascunho.
Clique em Cancel.
Clique em Save Draft ou Delete Draft.
Importante
Você não pode criar um novo índice quando tiver um rascunho de índice pendente.
Para saber mais sobre como criar um índice utilizando um rascunho de índice, consulte Retomar ou Excluir um Rascunho de Índice de Atlas Search.
Clique em Create Search Index.
Feche a janela modal You're All Set!.
Uma janela modal é exibida para que você saiba que seu índice está construindo. Clique no botão Close.
Verifique o status.
O índice recém-criado aparece na aba Atlas Search. Enquanto o índice está construindo, o campo Status lê Build in Progress. Quando o índice terminar de construir, o campo Status lê Active.
Observação
Collections maiores demoram mais tempo para indexar. Você receberá uma notificação por e-mail quando seu índice terminar a criação.
Criar um Índice de Pesquisa Atlas utilizando a API de Pesquisa Atlas
Para criar um índice do Atlas Search, envie uma solicitação POST para o endpoint fts/indexes . Para saber mais sobre a sintaxe e os parâmetros deste endpoint, consulte Criar um.
Observação
O Atlas não cria o índice se a collection não existir, mas ainda assim retorna um status 200.
Crie um índice de pesquisa do Atlas usando o Atlas CLI
Você também pode utilizar o Atlas Search com sistemas locais do Atlas que você cria com o Atlas CLI. Para saber mais, consulte Criar uma implantação de Atlas local.
Crie um Atlas Search para um sistema em nuvem
Para criar um índice de pesquisa para um agrupamento utilizando o Atlas CLI, execute o seguinte comando:
atlas clusters search indexes create [indexName] [options]
Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do Atlas CLI para criação de índices de pesquisa dos clusters do Atlas.
Dica
Veja: links relacionados
Criar um Índice de Pesquisa Atlas para um sistema local
Para criar um índice de pesquisa para o sistema especificado utilizando o Atlas CLI, execute o seguinte comando:
atlas deployments search indexes create [indexName] [options]
Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação da CLI do Atlas para implantações do Atlas que os índices de pesquisa criam.
Dica
Veja: links relacionados
Criar um índice de pesquisa do Atlas com o MongoDB Compass
Você pode criar um índice do Atlas Search em um Atlas cluster M10 ou superior executando o MongoDB 7.0 ou superior do Compass.
Conecte-se ao seu Atlas cluster no MongoDB Compass.
Abra o Compass e conecte-se ao Atlas cluster. Para obter instruções detalhadas sobre a conexão, consulte Conectar via Compass.
Use o nome da coleção no nome do banco de dados.
Na tela Database , clique no nome do banco de dados e, em seguida, clique no nome da coleção.
Crie o índice.
Clique na aba Indexes e selecione Search Indexes.
Clique em Create Index para abrir a caixa de diálogo de criação de índice.
Especifique um nome para o índice e, em seguida, a definição do índice de pesquisa.
Nome do ÍndicedefaultDefinição de Índice{ mappings: { dynamic: true } } Clique em Create Search Index.
Crie um Atlas Search programaticamente
Você pode criar um Atlas Search index programaticamente usando mongosh ou um MongoDB Driver compatível em seu idioma preferido.
Observação
Você deve ter pelo menos o papel do readWriteAnyDatabase ou acesso do readWrite ao banco de dados que contém os índices. Para saber mais, consulte Funções embutidas ou Privilégios específicos.
➤ Use o menu suspenso Selecione a linguagem para definir a linguagem do exemplo nesta seção.
Status do nó
Quando você cria o índice do Atlas Search, a aba Índices do Atlas Search no painel direito da interface do usuário do Atlas exibe informações sobre os índices do Atlas Search para o namespace selecionado. A coluna Status mostra o estado atual do índice no nó primário do cluster. Clique no link View status details abaixo do status para visualizar o estado do índice em todos os nós do cluster.
Quando a coluna Status lê Active, o índice está pronto para utilizar. Em outros estados, queries em relação ao índice podem retornar resultados incompletos.
Status | Descrição |
|---|---|
Não iniciado | Atlas ainda não começou a construir o índice. |
Sincronização inicial | O Atlas está construindo o índice ou reconstruindo o índice após uma edição. Quando o índice está neste estado:
|
Ativo | O índice está pronto para uso. |
Recuperando | A denúncia encontrou um erro. Esse estado geralmente ocorre quando o ponto de replicação atual não está mais disponível no oplog mongod . Você ainda pode fazer query no índice existente até que ele atualize e seu status mude para Active. Use o erro na janela modal View status details para solucionar o problema. Para saber mais, consulte Corrigir problemas do Atlas Search. |
Falhou | O Atlas não conseguiu criar o índice. Use o erro na janela modal View status details para solucionar o problema. Para saber mais, consulte Corrigir problemas do Atlas Search. |
Exclusão em Andamento | O Atlas está excluindo o índice dos nós de cluster. |
Enquanto o Atlas constrói o índice e após a conclusão da construção, a coluna Documents mostra a porcentagem e o número de documentos indexados. A coluna também mostra o número total de documentos na coleção.
Aviso
Se você fragmentar uma collection que já tenha um índice do Atlas Search, poderá passar por um breve período de inatividade de query quando a coleção começar a aparecer em um fragmento. Além disso, se você adicionar um fragmento a uma coleção já fragmentada que contenha um índice do Atlas Search, suas pesquisas nessa coleção falharão até que o processo de initial sync seja concluído nos fragmentos adicionados. Para saber mais, consulte processo de sincronização inicial.