listCollections（データベースコマンド）

定義

listCollections

データベース内のコレクションとビューの名前や作成オプションなどの情報を取得します。

listCollectionsコマンドは、コレクションにカーソルを作成する際に使用できる情報を含むドキュメントを返します。

mongosh は、db.getCollectionInfos() および db.getCollectionNames()ヘルパーメソッド、および show collections コマンドを提供します。

互換性

このコマンドは、次の環境でホストされている配置で使用できます。

• MongoDB Atlas はクラウドでの MongoDB 配置のためのフルマネージド サービスです

• MongoDB Enterprise: サブスクリプションベースの自己管理型 MongoDB バージョン

• MongoDB Community: ソースが利用可能で、無料で使用できる自己管理型の MongoDB のバージョン

構文

このコマンドの構文は、次のとおりです。

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

コマンドフィールド

コマンドは以下の任意フィールドを取ることができます。

動作

必要なアクセス権

アクセス制御が強制されている場合、 listCollectionsコマンドにはlistCollectionsアクションが必要です。 listCollectionsを実行するには、ユーザーにはデータベースに対するlistCollectionsアクションを許可する特権が必要です。

たとえば、次のコマンドは、 testデータベースに対してdb.getCollectionInfos()を実行する特権を付与します。

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

組み込みロール read には、特定のデータベースに対してlistCollections を実行する特権が付与されます。

必要な read 特権を持たないユーザーは、authorizedCollections と nameOnly の両方が trueに設定されている場合に、listCollections を実行できます。この場合、コマンドではユーザーが特権を持つコレクションの名前と型が返されます。

以下のように find 特権のあるロールのユーザーを例に取ります。

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

authorizedCollections と nameOnly の両方が true に設定されている場合に、このユーザーは listCollections を実行できます。

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

この操作は、 currentQuarter コレクションの名前と種類を返します。

ただし、ユーザーに必要なアクセス権の承認がない場合、次の操作ではエラーが返されます。

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

出力

listCollections.cursor

コレクション名とオプションを含むドキュメントへのカーソルを作成するための情報を含むドキュメント。カーソル情報には、カーソルID、コマンドの名前空間全体、および結果の最初のバッチが含まれます。バッチ出力内の各ドキュメントには以下のフィールドが含まれます。

フィールド	タイプ	説明
name	文字列	コレクション名。
タイプ	文字列	データ ストアのタイプ。コレクションの場合はcollection 、ビューの場合はview 、時系列コレクションの場合はtimeseriesを返します。
options	ドキュメント	コレクションオプション これらのオプションは、 db.createCollection()で使用可能なオプションに直接対応します。オプションの説明については、 db.createCollection()を参照してください。
info	ドキュメント	コレクションに関連する次のフィールドを一覧表示します。 readOnly booleantrueの場合、データストアは読み取り専用となります。 uuid UUID一度確立されると、コレクションUUIDは変更されません。コレクションUUIDは、シャーディングされたクラスター内のレプリカセットノードでもシャードでも同一のままになります。
idIndex	ドキュメント	コレクションの_idインデックスに関する情報を提供します。

listCollections.ok

コマンドの戻り値です。値が1の場合は成功を示します。

例

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
}

詳細

コレクションオプションの場合

• db.createCollection()

• create

コレクション情報の場合

• db.getCollectionInfos()

• mongosh 組み込みコマンド