Página inicial do Docs → Desenvolver aplicações → Manual do MongoDB
db.collection.getIndexes()
Nesta página
Definição
db.collection.getIndexes()
Importante
Método mongosh
Esta página documenta um método
mongosh
. Esta não é a documentação para comandos de banco de dados ou drivers específicos de idioma, como Node.js.Para o comando do banco de dados, consulte o comando
listIndexes
.Para drivers de API do MongoDB, consulte a documentação do driver MongoDB específica do idioma.
Para a documentação de shell legada do
mongo
, consulte a documentação para a versão correspondente do MongoDB Server:Retorna uma array que contém uma lista de documentos que identificam e descrevem os índices existentes na collection, inclusive os índices ocultos.
Você deve chamar
db.collection.getIndexes()
em uma coleção. Por exemplo:db.collection.getIndexes() Altere
collection
para o nome da coleção para a qual as informações do índice devem ser retornadas.
Comportamento
Índices de pesquisa do Atlas
getIndexes()
não retorna informações sobre os índices do Atlas Search. Para obter informações sobre os índices do Atlas Search, use $listSearchIndexes
.
Desconexão do cliente
A partir do MongoDB 4.2, se o cliente que emitiu db.collection.getIndexes()
se desconectar antes da conclusão da operação, o MongoDB marcará db.collection.getIndexes()
para encerramento usando killOp
.
Restrição de estado do membro do conjunto de réplica
Para executar em um membro do conjunto de réplica, as operações do listIndexes
exigem que o membro esteja no estado PRIMARY
ou SECONDARY
. Se o membro estiver em outro estado, como STARTUP2
, os erros de operação.
Índices curinga
A partir do MongoDB 6.3, 6.0.5 e 5.0.16, o campo wildcardProjection
armazena a projeção do índice na forma enviada. Versões anteriores do servidor podem ter armazenado a projeção de forma normalizada.
O servidor utiliza o índice da mesma maneira, mas você pode notar uma diferença na saída dos comandos listIndexes
e db.collection.getIndexes()
.
Acesso obrigatório
Para executar db.collection.getIndexes()
quando o controle de acesso é aplicado, os usuários devem ter privilégios para listIndexes
na collection.
O papel embutido read
fornece os privilégios exigidos para executar o db.collection.getIndexes()
para as coleções em um banco de dados.
Saída
db.collection.getIndexes()
retorna uma série de documentos que contêm informações de índice para a coleta. Por exemplo:
[ { "v" : 2, "key" : { "_id" : 1 }, "name" : "_id_" }, { "v" : 2, "key" : { "status" : 1 }, "name" : "status_1" }, { "v" : 2, "key" : { "points" : 1 }, "name" : "points_1" } ]
As informações do índice incluem as chaves e as opções usadas para criar o índice. A opção de índice hidden
só estará disponível se o valor for true
.
Para informações sobre as chaves e opções de índice, consulte db.collection.createIndex()
.