db.getCollectionInfos（）

MongoDB 中文手册

参考 > 参考 > mongo Shell方法 > 数据库方法 > db.getCollectionInfos（）

在本页面

定义
所需的访问
行为
例

定义¶

db.getCollectionInfos（filter，nameOnly，authorizedCollections ）¶

返回包含当前数据库的集合或视图信息（例如名称和选项）的文档数组。结果取决于用户的权限。有关详细信息，请参见“ 必需访问权限”。

该db.getCollectionInfos()辅助包装的 listCollections命令。

该db.getCollectionInfos()方法具有以下可选参数：

参数	类型	描述
`filter`	文献	可选的。查询表达式以过滤集合列表。您可以在返回的任何字段上指定查询表达式`db.getCollectionInfos`。
`nameOnly`	布尔值	可选的。一个标志，指示命令是否应仅返回集合/视图名称并键入或返回名称和其他信息。仅返回名称和类型（`view`或`collection`）不会采取集合级锁定，而返回完整的集合信息则会锁定数据库中的每个集合。默认值为`false`。注意当`nameOnly`为时`true`，`filter`表达式只能根据集合的名称和类型进行过滤。没有其他字段可用。版本4.0中的新功能。
`authorizedCollections`	布尔值	可选的。一个标志，当设置为`true`并与一起使用时，允许具有所需特权（即对数据库的操作）的用户在实施访问控制时运行命令。`nameOnly: truelistCollections` 当`authorizedCollections`和`nameOnly`选项都设置为true时，该命令仅返回用户具有特权的那些集合。例如，如果用户`find`对特定集合有操作，则命令仅返回那些集合；否则，命令将返回这些集合。或者，如果用户`find`对数据库资源执行了任何其他操作，则该命令将列出数据库中的所有集合。默认值为`false`。也就是说，用户必须 `listCollections`对数据库执行操作才能运行命令。对于`listCollections`对数据库有操作的用户，此选项无效，因为该用户有权列出数据库中的集合。不使用时，此选项无效。也就是说，强制执行访问控制时，用户必须具有运行命令所需的特权。否则，用户无权运行该命令。`nameOnly: true` 版本4.0中的新功能。

在版本3.2中更改。

MongoDB 3.2添加了对文档验证的支持。db.getCollectionInfos() 在options 文档中包含文档验证信息。

db.getCollectionInfos()不会返回validationLevel ，validationAction除非明确设置它们。

所需的访问权限¶

由于db.getCollectionInfos()是的包装 listCollections，用户必须具有与listCollections实施访问控制时相同的特权。

要listCollections在强制执行访问控制时运行，通常，用户必须具有授予listCollections数据库操作权限的特权。例如，以下特权授予用户db.getCollectionInfos()针对test数据库运行的权限：

复制

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

内置角色read提供了listCollection针对特定数据库运行的特权。

在4.0版本开始，但是，用户没有按规定的权限可以运行的命令都 authorizedCollections和 nameOnly选项设置true。在这种情况下，该命令仅返回用户具有特权的集合的名称和类型。

例如，考虑具有仅授予以下特权的角色的用户：

复制

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

如果该命令包括用户可以通过命令都 authorizedCollections和nameOnly选项设置为true （具有或不具有filter选项）：

复制

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

该操作返回foo集合的名称和类型。

但是，以下操作（带有或不带有该filter 选项）对于没有所需访问权限的用户来说是错误的：

复制

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

`show collections`¶

从mongoShell的4.0版本开始，等效于：show collections

复制

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

对于具有所需访问权限的用户，列出数据库的非系统集合。show collections
对于没有所需访问权限的用户，仅列出用户具有特权的集合。show collections

早期的MongoDB版本¶

当4.0版mongo外壳连接到较早版本的MongoDB部署不支持 authorizedCollections和nameOnly选项，

用户必须具有运行所需的访问权限 listCollection。
如果用户没有所需的访问权限并可以运行，则MongoDB将使用返回的字段为该用户返回一个近似的集合列表。show collectionsauthenticatedUserPrivilegesconnectionStatus

行为¶

客户端断开¶

从MongoDB 4.2开始，如果发出db.getCollectionInfos() 断开连接的客户端在操作完成之前断开连接，则MongoDB将标记db.getCollectionInfos()为终止（即killOp在操作上）。

例子¶

以下返回example数据库中所有集合的信息：

复制

use example
db.getCollectionInfos()

该方法返回包含集合信息的文档数组：

复制

[
   {
      "name" : "employees",
      "type" : "collection",
      "options" : {
         "flags" : 1,
         "validator" : {
            "$or" : [
               {
                  "phone" : {
                     "$exists" : true
                  }
               },
               {
                  "email" : {
                     "$exists" : true
                  }
               }
            ]
         }
      },
      "info" : {
         "readOnly" : false,
         "uuid" : UUID("222e18ca-4a10-4a42-a8fe-c39255cc4c55")
      },
      "idIndex" : {
         "v" : 2,
         "key" : {
            "_id" : 1
         },
         "name" : "_id_",
         "ns" : "example.employees"
      }
   },
   {
      "name" : "products",
      "type" : "collection",
      "options" : {
         "flags" : 1
      },
      "info" : {
         "readOnly" : false,
         "uuid" : UUID("1bc898b2-3b91-45e4-9d8b-0be462d5a157")
      },
      "idIndex" : {
         "v" : 2,
         "key" : {
            "_id" : 1
         },
         "name" : "_id_",
         "ns" : "example.products"
      }
   },
   {
      "name" : "mylogs",
      "type" : "collection",
      "options" : {
         "capped" : true,
         "size" : 256
      },
      "info" : {
         "readOnly" : true,
         "uuid" : UUID("8e62116d-b6a0-490a-808c-258ccb7ea947")
      },
      "idIndex" : {
         "v" : 2,
         "key" : {
            "_id" : 1
         },
         "name" : "_id_",
         "ns" : "example.mylogs"
      }
   }
]

要请求特定集合的集合信息，请在调用方法时指定集合名称，如下所示：

复制

use example
db.getCollectionInfos( { name: "employees" } )

该方法返回一个包含单个文档的数组，该文档详细说明数据库中employees集合的集合信息example。

复制

[
   {
      "name" : "employees",
      "type" : "collection",
      "options" : {
         "flags" : 1,
         "validator" : {
            "$or" : [
               {
                  "phone" : {
                     "$exists" : true
                  }
               },
               {
                  "email" : {
                     "$exists" : true
                  }
               }
            ]
         }
      },
      "info" : {
         "readOnly" : false,
         "uuid" : UUID("222e18ca-4a10-4a42-a8fe-c39255cc4c55")
      },
      "idIndex" : {
         "v" : 2,
         "key" : {
            "_id" : 1
         },
         "name" : "_id_",
         "ns" : "example.employees"
      }
   }
]

您可以在所返回的任何字段上指定过滤器 getCollectionInfos。

例如，下面的命令返回的所有集合的信息，example其中数据库info.readOnly是 true：

复制

use example
db.getCollectionInfos( { "info.readOnly" : true } )

该命令返回以下内容：

复制

[
   {
      "name" : "mylogs",
      "type" : "collection",
      "options" : {
         "capped" : true,
         "size" : 256
      },
      "info" : {
         "readOnly" : true,
         "uuid" : UUID("8e62116d-b6a0-490a-808c-258ccb7ea947")
      },
      "idIndex" : {
         "v" : 2,
         "key" : {
            "_id" : 1
         },
         "name" : "_id_",
         "ns" : "example.mylogs"
      }
   }
]

MongoDB 中文手册

db.getCollectionInfos（）

定义¶

所需的访问权限¶

show collections¶

早期的MongoDB版本¶

行为¶

客户端断开¶

例子¶

`show collections`¶