db.colección.getIndexes() (método mongosh)

Esta versión de la documentación está archivada y ya no recibe soporte. Para actualizar su implementación 6.0, consulte Procedimientos de actualización de MongoDB.7.0

MongoDB con controladores

Esta página documenta una mongosh . Para ver el método equivalente en un driver de MongoDB, se debe consultar la página correspondiente al lenguaje de programación:

C#Java Sync Node.js PyMongo C C++Go Java RS Kotlin Coroutine Kotlin Sync PHP Mongoid Rust Scala

Definición

db.collection.getIndexes()

Devuelve una matriz que contiene una lista de documentos que identifican y describen los índices existentes en la colección, incluidos índices ocultos e índices que se están construyendo actualmente.

Debes llamar db.collection.getIndexes() en una colección. Por ejemplo:

db.collection.getIndexes()

Cambiar collection por el nombre de la colección para la cual se desea devolver información del índice.

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

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.

Comportamiento

Índices de búsqueda de Atlas

getIndexes() No devuelve información sobre los índices de Atlas Search. Para obtener información sobre los índices de Atlas Search,$listSearchIndexes utilice.

Desconexión del cliente

Si el cliente que emitió db.collection.getIndexes() se desconecta antes de que la operación se complete, MongoDB marca db.collection.getIndexes() para su terminación usando killOp.

Restricción del estado del set de réplicas

Para que se ejecuten en un set de réplicas, las operaciones de listIndexes requieren que el nodo esté en estado PRIMARY o SECONDARY. Si el nodo se encuentra en otro estado, como STARTUP2, se produce un error en la operación.

Índices comodín

A partir de MongoDB 6.3, 6.0.5 y 5.0.16, el campo wildcardProjection almacena la proyección del índice en su forma presentada. Las versiones anteriores del servidor podrían haber almacenado la proyección en una forma normalizada.

El servidor utiliza el índice de la misma manera, pero se puede notar una diferencia en la salida de los comandos listIndexes y db.collection.getIndexes().

Acceso requerido

Para ejecutar cuando db.collection.getIndexes() listIndexes se aplica el control de acceso, los usuarios deben tener privilegios de en la colección.

El rol incorporado read proporciona los privilegios necesarios para ejecutar db.collection.getIndexes() en las colecciones de una base de datos.

Salida

db.collection.getIndexes() devuelve un arreglo de documentos que contienen información de índice para la colección. Por ejemplo:

[
   {
      "v" : 2,
      "key" : {
         "_id" : 1
      },
      "name" : "_id_"
   },
   {
      "v" : 2,
      "key" : {
         "status" : 1
      },
      "name" : "status_1"
   },
   {
      "v" : 2,
      "key" : {
         "points" : 1
      },
      "name" : "points_1"
   }
]

La información del índice incluye las claves y opciones utilizadas para crear el índice. La opción de índice hidden solo está disponible si el valor es true.

Para obtener información sobre las claves y las opciones de índice, consultar db.collection.createIndex().

Volver

db.collection.findOneAndUpdate

db.collection.getShardDistribution