listIndexes

定義

listIndexes

指定されたコレクションのインデックスに関する情報を返します。返されるインデックス情報には、インデックスの作成に使用されたキーとオプション、および 非表示のインデックスが含まれます。オプションで、結果の最初のバッチのバッチ サイズを設定できます。

Tip

mongoshでは、このコマンドはdb.collection.getIndexes()ヘルパー メソッドを通じて実行することもできます。

ヘルパー メソッドはmongoshユーザーには便利ですが、データベースコマンドと同じレベルの情報は返されない可能性があります。 便宜上必要ない場合、または追加の戻りフィールドが必要な場合は、 データベースコマンドを使用します。

互換性

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

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

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

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

構文

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

db.runCommand (
   {
      listIndexes: "<collection-name>",
      cursor: { batchSize: <int> },
      comment: <any>
   }
)

コマンドフィールド

このコマンドは、次のフィールドを使用します。

必要なアクセス権

アクセス制御が適用されている場合、組み込みの read ロールは、データベース内のコレクションに対して listIndexes を実行するために必要な特権を提供します。

動作

出力

listIndexes.cursor

カーソルによって指定されたバッチ サイズで返される結果セット。バッチ出力内の各ドキュメントには以下のフィールドが含まれます。

フィールド	タイプ	説明
id	integer	64 ビット整数。ゼロの場合、それ以上の情報のバッチはありません。ゼロ以外の場合、カーソル ID は、getMore コマンドで使用して次のインデックス情報のバッチを取得できます。
ns	string	データベースとコレクションの名前は次の形式です。 <database-name>.<collection-name>
firstBatch	ドキュメント	インデックス情報には、インデックスの作成に使用されるキーとオプションが含まれます。インデックス オプション hidden は、値が true の場合にのみ存在します。 必要に応じて追加の結果を検索するには、getMore を使用します。

listIndexes.ok

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

例

1
db.runCommand (
2
  {
3
     listIndexes: "contacts"
4
  }
5
)

1
{
2
   cursor: {
3
      id: Long("0"),
4
      ns: 'test.contacts',
5
      firstBatch: [
6
         { v: 2, key: { _id: 1 }, name: '_id_', ns: 'test.contacts' },
7
         { v: 2, key: { a: 1 }, name: 'a_1', ns: 'test.contacts' }
8
      ]
9
   },
10
   ok: 1
11
}

1
db.runCommand (
2
   {
3
      listIndexes: "contacts", cursor: { batchSize: 1 }
4
   }
5
)

1
{
2
   cursor: {
3
     id: Long("4809221676960028307"),
4
     ns: 'test.contacts',
5
    firstBatch: [ { v: 2, key: { _id: 1 }, name: '_id_', ns: 'test.contacts' } ]
6
  },
7
  ok: 1
8
}

1
db.runCommand(
2
   {
3
      getMore: Long("4809221676960028307"), collection: "contacts"
4
   }
5
)

1
{
2
   cursor: {
3
    nextBatch: [ { v: 2, key: { a: 1 }, name: 'a_1', ns: 'test.contacts' } ],
4
    id: Long("0"),
5
    ns: 'test.contacts'
6
  },
7
  ok: 1
8
}