db.colección.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 el comando de base de datos, consulta la colección index.hidden con la opción configurada utilizando el comando collMod.

Para los drivers de API de MongoDB, consulte la documentación del driver de MongoDB específica del lenguaje.

Definición

db.collection.unhideIndex(): Desoculta un índice existente del planificador de query. Una vez que se desocultan, los índices están disponibles de inmediato para su uso.

Compatibilidad

Este método está disponible en implementaciones alojadas en los siguientes entornos:

MongoDB Atlas: El servicio totalmente gestionado para implementaciones de MongoDB en la nube

Nota

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

MongoDB Enterprise: La versión basada en suscripción y autogestionada de MongoDB
MongoDB Community: La versión de MongoDB con código fuente disponible, de uso gratuito y autogestionada.

Sintaxis

db.collection.unhideIndex(<index>)

Parámetros

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

Parameter	Tipo	Descripción
`index`	string o documento	Especifica el índice para mostrar del planificador de query. Puedes especificar el índice por el nombre del índice o por el documento de especificación del índice. Para encontrar el nombre del índice o el documento de especificación de índice, puedes usar el método `db.collection.getIndexes()`. Para desocultar un índice de texto, se debe especificar el nombre del índice.

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

Comportamiento

Restablecimiento de estadísticas de modificaciones de índice

Al desocultar un índice oculto, se restablece su $indexStats.

No-op

Desocultar un índice que ya no está oculto no tiene ningún efecto sobre el índice. Sin embargo, la operación seguirá generando una entrada oplog vacía.

Acceso requerido

Si la implementación aplica autenticación/autorización, debe tener el privilegio collMod en la base de datos de la colección.

El rol con funcionalidad incorporada dbAdmin proporciona los privilegios necesarios.

Ejemplo

El siguiente ejemplo revela un índice existente.

Primero, usa db.collection.createIndex() para crear un índice oculto:

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

Para verificar, ejecute db.collection.getIndexes() en la colección restaurants:

db.restaurants.getIndexes();

La operación devuelve la siguiente información:

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

La opción de índice hidden solo se devuelve si el valor es 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, ejecute db.collection.getIndexes() en la colección restaurants:

db.restaurants.getIndexes()

La operación devuelve la siguiente información:

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

La opción de índice hidden ya no aparece como parte del índice borough_1_ratings_1, ya que el campo solo se muestra si el valor es true.

Tip

Volver

db.collection.totalSize

db.collection.update