MongoCollection::getDBRef
MongoCollection::getName
MongoCollection
PHP Manual

# MongoCollection::getIndexInfo

(PECL mongo >=0.9.0)

MongoCollection::getIndexInfo — このコレクションのインデックスについての情報を返す

### 説明

public array MongoCollection::getIndexInfo ( void )

### パラメータ

この関数にはパラメータはありません。

### 返り値

この関数は、配列を返します。配列の各要素が、それぞれインデックスを表します。 その要素には、インデックス名を表す name や名前空間 (データベース名とコレクション名の組み合わせ) を表す ns、すべてのキーとそのソート順 (インデックスを作るもの) を表す key があります。 また、それ以外の値も特別なインデックスに含まれるかもしれません。 unique や sparse などです。

### 例

例1 MongoCollection::getIndexInfo() の例

`<?php
$m = new MongoClient();
$c = $m->selectCollection('test', 'venues');
var_dump($c->getIndexInfo());
?>`

上の例の出力は、 たとえば以下のようになります。

    array(
      0 => array(
        "v" => 1,
        "key" => array(
          "_id" => 1,
        ),
        "ns" => "test.venues",
        "name" => "_id_",
      ),
      1 => array(
        "v" => 1,
        "key" => array(
          "name" => 1,
        ),
        "unique" : true,
        "ns" => "test.venues",
        "name" => "name_1",
      ),
      2 => array(
        "v" => 1,
        "key" => array(
          "type" => 1,
          "createdAt" => -1,
        ),
        "ns" => "test.venues",
        "name" => "type_1_createdAt_-1",
      ),
      3 => array(
        "v" => 1,
        "key" => array(
          "location" => "2d",
        ),
        "ns" => "test.venues",
        "name" => "location_2d",
      ),
    )

### 参考

MongoDB コアドキュメントの » vanilla indexes や » geospatial indexes も参照ください。

MongoCollection::getDBRef
MongoCollection::getName
MongoCollection
PHP Manual