db.collection.unhideIndex() (método mongosh)

Importante

Método mongosh

This page documents a mongosh method. This is not the documentation for database commands or language-specific drivers, such as Node.js.

Para o comando de banco de dados, consulte a opção de coleção index.hidden definida utilizando o comando collMod.

Para drivers de API do MongoDB, consulte a documentação do driver do MongoDB específica da linguagem.

Definição

db.collection.unhideIndex(): Exibe um índice existente do planejador de query. Uma vez exibidos, os índices ficam imediatamente disponíveis para uso.

Compatibilidade

Esse método está disponível em implantações hospedadas nos seguintes ambientes:

MongoDB Atlas: The fully managed service for MongoDB deployments in the cloud

Observação

This command is supported in all MongoDB Atlas clusters. For information on Atlas support for all commands, see Unsupported Commands.

MongoDB Enterprise: a versão autogerenciada e baseada em assinatura do MongoDB
MongoDB Community: uma versão com código disponível, de uso gratuito e autogerenciada do MongoDB

Sintaxe

db.collection.unhideIndex(<index>)

Parâmetros

The db.collection.unhideIndex() method takes the following parameter:

Parâmetro	Tipo	Descrição
`index`	string ou documento	Especifica o índice a ser exibido do planejador de query. Você pode especificar o índice pelo nome do índice ou pelo documento de especificação do índice. Para localizar o nome do índice ou documento de especificação do índice, você pode usar o método `db.collection.getIndexes()` . Para exibir um índice de texto , especifique o nome do índice.

The db.collection.unhideIndex() is a mongosh shell wrapper for the collMod command.

Comportamento

Estatística de redefinição de modificações do índice

Exibir um índice oculto redefine seu $indexStats.

Sem operação

Exibir um índice já exibido não afeta o índice. No entanto, a operação ainda gerará uma entrada de oplog vazia.

Acesso necessário

Se a implantação forçar a autenticação/autorização, você deve ter o privilégio collMod no banco de dados da coleção.

A função embutida dbAdmin fornece os privilégios exigidos.

Exemplo

O exemplo a seguir exibe um índice existente.

Primeiro, utilize db.collection.createIndex() para criar um índice oculto:

db.restaurants.createIndex( { borough: 1, ratings: 1 }, { hidden: true } );

Para verificar, execute db.collection.getIndexes() na collection restaurants:

db.restaurants.getIndexes();

A operação retorna as seguintes informações:

[
   {
      "v" : 2,
      "key" : {
         "_id" : 1
      },
      "name" : "_id_"
   },
   {
      "v" : 2,
      "key" : {
         "borough" : 1,
         "ratings" : 1
      },
      "name" : "borough_1_ratings_1",
      "hidden" : true
   }
]

A opção de índice hidden só é retornada se o valor for true.

To unhide the index, you can specify either the index key specification document or the index name to the db.collection.unhideIndex() method. The following specifies the index name:

db.restaurants.unhideIndex( "borough_1_ratings_1" );

Para verificar, execute db.collection.getIndexes() na collection restaurants:

db.restaurants.getIndexes()

A operação retorna as seguintes informações:

[
   {
      "v" : 2,
      "key" : {
         "_id" : 1
      },
      "name" : "_id_"
   },
   {
      "v" : 2,
      "key" : {
         "borough" : 1,
         "ratings" : 1
      },
      "name" : "borough_1_ratings_1"
   }
]

A opção de índice hidden não aparece mais como parte do índice borough_1_ratings_1, pois o campo só é retornado se o valor for true.

Dica

Voltar

db.collection.totalSize

db.collection.update