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

MongoDB con controladores

Esta página documenta un método mongosh. Para ver el método equivalente en un driver de MongoDB, consulte la página correspondiente a su 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 un arreglo que contiene una lista de documentos que identifican y describen los índices existentes de la colección, incluidos los índices ocultos y los índices que se están construyendo actualmente.

You must call db.collection.getIndexes() on a collection. For example:

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

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.

Comportamiento

Índices de búsqueda de Atlas

getIndexes() does not return information on Atlas Search indexes. For information on Atlas Search indexes, use $listSearchIndexes.

Desconexión del cliente

If the client that issued db.collection.getIndexes() disconnects before the operation completes, MongoDB marks db.collection.getIndexes() for termination using 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.

The server uses the index the same way, but you may notice a difference in the output of the listIndexes and db.collection.getIndexes() commands.

Acceso requerido

To run db.collection.getIndexes() when access control is enforced, users must have privileges to listIndexes on the collection.

The built-in role read provides the required privileges to run db.collection.getIndexes() for the collections in a database.

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