listCollections (comando de base de datos)

Definición

listCollections

Recupera información, incluidos los nombres y las opciones de creación, para las colecciones y vistas en una base de datos.

El listCollections comando devuelve un documento que contiene información que puede utilizar para crear un cursor en la colección.

mongosh proporciona los métodos asistente db.getCollectionInfos() y db.getCollectionNames(), así como el comando mostrar colecciones.

Compatibilidad

Este comando está disponible en implementaciones alojadas en los siguientes entornos:

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

• 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

El comando tiene la siguiente sintaxis:

db.runCommand(
   {
     listCollections: 1,
     filter: <document>,
     nameOnly: <boolean>,
     authorizedCollections: <boolean>,
     comment: <any>
   }
)

Campos de comandos

El comando puede aceptar los siguientes campos opcionales:

Comportamiento

Acceso requerido

El listCollections comando requiere la acción cuando se aplica listCollections el control de acceso. Los usuarios deben tener privilegios que otorguen la listCollections acción en la base de datos para listCollections ejecutar.

Por ejemplo, el siguiente comando otorga el privilegio de ejecutar db.getCollectionInfos() en la base de datos test:

{ resource: { db: "test", collection: "" }, actions: [ "listCollections" ] }

El rol con funcionalidad incorporada read proporciona el privilegio de ejecutar listCollections para una base de datos específica.

Los usuarios sin el privilegio read necesario pueden ejecutar listCollections cuando authorizedCollections y nameOnly están configurados en true. En este caso, el comando devuelve los nombres y tipos de las colecciones donde el usuario tiene privilegios.

Por ejemplo, considere a un usuario con un rol que concede el siguiente privilegio find:

{ resource: { db: "sales", collection: "currentQuarter" }, actions: [ "find" ] }

El usuario puede ejecutar listCollections si authorizedCollections y nameOnly están configurados en true.

db.runCommand(
   {
       listCollections: 1.0,
       authorizedCollections: true,
       nameOnly: true
   }
)

La operación devuelve el nombre y el tipo de la colección currentQuarter.

Sin embargo, las siguientes operaciones devuelven un error si el usuario no tiene la autorización de acceso requerida:

db.runCommand(
   {
       listCollections: 1.0,
       authorizedCollections: true
   }
)
db.runCommand(
   {
       listCollections: 1.0,
       nameOnly: true
   }
)

Salida

listCollections.cursor

Un documento que contiene información para crear un cursor para documentos que contienen nombres y opciones de colección. La información del cursor incluye su ID, el espacio de nombres completo del comando y el primer lote de resultados. Cada documento de la salida por lotes contiene los siguientes campos:

Campo	Tipo	Descripción
Nombre	String	Nombre de la colección.
tipo	String	Tipo de almacenamiento de datos. Devuelve collection para las colecciones, view para vistas y timeseries para la colección de series de tiempo.
opciones	Documento	Opciones de colección. Estas opciones corresponden directamente a las opciones disponibles en db.createCollection(). Para las descripciones de las opciones, consulte db.createCollection().
información	Documento	Enumere los siguientes campos relacionados con la colección: Solo lectura boolean. Si true, el almacén de datos es de solo lectura. uuid UUID. Una vez establecido, el UUID de la colección no cambia. El UUID de la colección permanece igual entre los nodos del set de réplicas y las particiones en un clúster particionado.
idIndex	Documento	Proporciona información sobre el índice _id de la colección.

listCollections.ok

El valor de retorno del comando. Un valor de 1 indica el éxito.

Ejemplo

db.runCommand(
   {
      listCollections: 1.0,
      nameOnly: true
   }
)

{
  cursor: {
    id: Long("0"),
    ns: 'music.$cmd.listCollections',
    firstBatch: [
      { name: 'motorhead', type: 'collection' },
      { name: 'taylorSwift', type: 'collection' },
      { name: 'ramones', type: 'collection' }
    ]
  },
  ok: 1
}

db.runCommand(
   {
      listCollections: 1.0
   }
)

{
  cursor: {
    id: Long("0"),
    ns: 'music.$cmd.listCollections',
    firstBatch: [
      {
        name: 'motorhead',
        type: 'collection',
        options: {},
        info: {
          readOnly: false,
          uuid: new UUID("09ef1858-2831-47d2-a3a7-9a29a9cfeb94")
        },
        idIndex: { v: 2, key: { _id: 1 }, name: '_id_' }
      },
      {
        name: 'taylorSwift',
        type: 'collection',
        options: {},
        info: {
          readOnly: false,
          uuid: new UUID("6c46c8b9-4999-4213-bcef-9a36b0cff228")
        },
        idIndex: { v: 2, key: { _id: 1 }, name: '_id_' }
      },
      {
        name: 'ramones',
        type: 'collection',
        options: {},
        info: {
          readOnly: false,
          uuid: new UUID("7e1925ba-f2f9-4e42-90e4-8cafd434a6c4")
        },
        idIndex: { v: 2, key: { _id: 1 }, name: '_id_' }
      }
    ]
  },
  ok: 1
}

Obtén más información

Para las opciones de colección:

• db.createCollection()

• create

Para obtener información sobre la colección:

• db.getCollectionInfos()

• comandos con funcionalidad incorporada de mongosh