Crie, visualize, elimine e oculte índices
Nesta página
Você pode usar a Atlas CLI ou a IU do Atlas para managed indexes em suas coleções.
Os índices permitem a execução eficiente de queries no MongoDB e devem ser considerados para campos que seu aplicativo lê com frequência. Para saber mais sobre como criar índices eficazes, consulte Estratégias de indexação.
Você pode habilitar a criação automática de índices para uma instância sem servidor. Para saber mais, consulte Criar índices automaticamente para instâncias sem servidor.
Funções obrigatórias
Para criar, descartar ou ocultar índices, você deve ter acesso fornecido por pelo menos uma das seguintes funções:
Considerações
Por padrão, você pode ter até três construções de índice simultâneas. Para saber mais, consulte Máximo de compilações simultâneas de índice.
Quando você iniciar uma construção contínua de índice, o nó ficará no estado HOST_DOWN durante a compilação. Para cancelar uma construção contínua de índice, você deve entrar em contato com o suporte do MongoDB.
Visualizar índices
Para visualizar as informações de índice de uma coleção:
No Atlas, VáGo para a Clusters página do seu projeto.
Se ainda não tiver sido exibido, selecione a organização que contém seu projeto no menu Organizations na barra de navegação.
Se ainda não estiver exibido, selecione o projeto desejado no menu Projects na barra de navegação.
Se ainda não estiver exibido, clique em Clusters na barra lateral.
A página Clusters é exibida.
Acesse a página Collections.
Clique no botão Browse Collections para o seu cluster.
O Data Explorer é exibido.
Crie um índice
Dica
Ao criar índices, tenha em mente a proporção de leituras e gravações na coleção de destino. Os índices têm um custo de desempenho, mas compensam o custo de queries frequentes em grandes conjuntos de dados. Antes de criar um índice, revise as estratégias de indexaçãodocumentadas.
Observação
Você pode criar uma pesquisa de texto completo com o Atlas Search e uma pesquisa semântica com o Atlas Vector Search. Atlas Search oferece indexação de texto refinada. Para saber mais, consulte Revisar a sintaxe do índice de pesquisa do Atlas e Como indexar campos para o Vector Search.
Para criar um índice de rolagem para seu agrupamento do Atlas utilizando o Atlas CLI, execute o seguinte comando:
atlas clusters 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 clusters do Atlas.
Para criar um índice para uma coleção usando a UI do Atlas:
Clique em Create Index.
Na janela Create Index, insira o documento de especificação da chave de índice:
{ <field1>: <index type>, ... }
Exemplo
Para criar um índice composto nos campos category (ordem crescente) e score (ordem decrescente), especifique o documento de especificação do índice:
{ category: 1, score: -1 }
Para saber mais sobre índices, consulte Índices.
(Opcional) Especifique as opções de índice.
Ao criar um índice, você pode especificar uma variedade de opções de índice.
Exemplos:
Para índices parciais, especifique a opção partialFilterExpression.
Para índices esparsos, especifique a opção esparsa.
Para índices TTL, especifique a opção expireAfterSeconds.
Para 2d Indexes, especifique as opções para 2d Indexes
{ <option1>: <value1>, ... }
Exemplo
O seguinte documento de opções especifica a opção unique e o name para o índice:
{ unique: true, name: "myUniqueIndex" }
Observação
Você não pode realizar uma construção contínua para um índice único. Se você habilitar a construção de índices de forma contínua com a opção de índice unique, o Atlas rejeitará a configuração com uma mensagem de erro.
(Opcional) Defina as opções de Agrupamento.
Use o agrupamento para determinar regras específicas do idioma para comparação de strings, como regras para letras maiúsculas e acentos. O documento de agrupamento contém um campo locale que indica o código de localidade do ICUe pode conter outros campos para definir o comportamento do agrupamento.
Exemplo
O documento de opção de agrupamento a seguir especifica um valor de localidade de fr para um agrupamento de idioma francês:
{ "locale": "fr" }
Para revisar a lista de localidades suportadas pelo agrupamento do MongoDB, consulte a lista de idiomas e localidades. Para saber mais sobre as opções de compilação, incluindo quais estão habilitadas por padrão para cada localidade, consulte Agrupamento no manual do MongoDB.
(Opcional) Habilite a criação de índices de forma contínua.
Importante
As compilações de índices contínuos são bem-sucedidas somente quando atendem a determinadas condições. Para garantir que a criação do índice seja bem-sucedida, evite os seguintes padrões de design que geralmente acionam um loop de reinicialização:
A chave de índice excede o limite da chave de índice
O nome do índice já existe
Índice em mais de um campo de array
Índice na coleção que tem o número máximo de índices de texto
Índice de texto na coleção que tem o número máximo de índices de texto
Observação
a UI do Atlas não suporta a criação de índices com uma compilação contínua para M0 clusters livres e M2/M5 clusters compartilhados. Você não pode construir índices com uma compilação móvel para instâncias sem servidor.
Para volumes de trabalho que não toleram a diminuição do desempenho devido às compilações do índice, considere a criação de índices de forma contínua.
Para manter a disponibilidade do cluster:
O Atlas remove um nó do cluster de cada vez, começando com um secundário.
Mais de um nó pode descer de cada vez, mas o Atlas sempre mantém a maioria dos nós online.
O Atlas cancela automaticamente a criação de índices contínuos que não são bem-sucedidos em todos os nós. Quando uma compilação de índice contínuo é concluída em alguns nós, mas falha em outros, o Atlas cancela a compilação e remove o índice de todos os nós nos quais foi criado com êxito.
No caso de um cancelamento contínuo da compilação do índice, o Atlas gera um evento de feed de atividades e envia um e-mail de notificação ao proprietário do projeto com as seguintes informações:
Nome do cluster no qual a criação do índice contínuo falhou
Namespace no qual a construção do índice contínuo falhou
Projeto que contém o cluster e o namespace
Organização que contém o projeto
Link para o evento do feed de atividades
Para saber mais sobre a reconstrução de índices, consulte Construir índices em conjuntos de réplicas.
Observação
Unique
opções de índice são incompatíveis com a criação de índices de forma contínua. Se você especificar unique no painel Options, o Atlas rejeitará sua configuração com uma mensagem de erro.
Descarte um índice
Para eliminar um índice de uma collection usando a UI do Atlas:
No Atlas, váGo para a Clusters página do seu projeto.
Se ainda não tiver sido exibido, selecione a organização que contém seu projeto no menu Organizations na barra de navegação.
Se ainda não estiver exibido, selecione o projeto desejado no menu Projects na barra de navegação.
Se ainda não estiver exibido, clique em Clusters na barra lateral.
A página Clusters é exibida.
Acesse a página Collections.
Clique no botão Browse Collections para o seu cluster.
O Data Explorer é exibido.
Importante
Você não pode excluir ou ocultar o índice _id . Para saber mais, consulte Índices únicos.
Considere ocultar o índice para avaliar o impacto de descartá-lo antes de realmente fazer isso. Para saber mais, consulte Índices ocultos.
Observação
Limitação do Atlas CLI
Você não pode eliminar o índice de um cluster usando a Atlas CLI.
Ocultar um Índice
Para ocultar um índice utilizando a UI do Atlas:
No Atlas, váGo para a Clusters página do seu projeto.
Se ainda não tiver sido exibido, selecione a organização que contém seu projeto no menu Organizations na barra de navegação.
Se ainda não estiver exibido, selecione o projeto desejado no menu Projects na barra de navegação.
Se ainda não estiver exibido, clique em Clusters na barra lateral.
A página Clusters é exibida.
Acesse a página Collections.
Clique no botão Browse Collections para o seu cluster.
O Data Explorer é exibido.