Docs Menu
Docs Home
/ /
Colecciones

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

db.collection.unhideIndex()

Importante

Método mongosh

Esta página documenta un método mongosh. Esta no es la documentación para los comandos de base de datos ni para los drivers específicos de lenguajes, como Nodo.js.

Para el comando de base de datos, consulte la opción de colección index.hidden establecida mediante el collMod dominio.

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

Muestra un índice existente en el planificador de consultas. Una vez mostrado, los índices están disponibles inmediatamente para su uso.

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

Este comando es compatible con todos los clústeres de MongoDB Atlas. Para obtener información sobre el soporte de Atlas para todos los comandos, consulte Comandos no compatibles.

  • 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.

db.collection.unhideIndex(<index>)

El método db.collection.unhideIndex() toma los siguientes parámetros:

Parameter
Tipo
Descripción

index

string o documento

Especifica el índice que se mostrará en el planificador de consultas. Puede especificarlo por su nombre o por su documento de especificación.

Tip

Puedes usar el método db.collection.getIndexes() para encontrar el nombre del índice o el documento de especificación del índice.

Para mostrar un índice de texto, especifique el nombre del índice.

db.collection.unhideIndex() es un mongosh contenedor de shell para el collMod comando.

Al mostrar un índice oculto $indexStats se restablece su.

Mostrar un índice ya visible no afecta al índice. Sin embargo, la operación generará una entrada de registro de operaciones vacía.

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

El rol con funcionalidad incorporada dbAdmin proporciona los privilegios necesarios.

El siguiente ejemplo muestra 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 en db.collection.getIndexes() la restaurants colección:

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.

Para mostrar el índice, puede especificar el documento de especificación de la clave del índice o el nombre del índice en el db.collection.unhideIndex() método. A continuación se especifica el nombre del índice:

db.restaurants.unhideIndex( "borough_1_ratings_1" );

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

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 devuelve si el valor es true.

Volver

db.collection.totalSize

En esta página