Docs Menu
Docs Home
/
言語
/
PHP
/
PHP ライブラリ マニュアル
/
API ドキュメント
/
結果のクラス
/
IndexInfo クラス

MongoDB\Model\IndexInfo::getKey()

項目一覧

  • 定義
  • Return Values
  • 例
  • その他の参照

定義

MongoDB\Model\IndexInfo::getKey()

インデックス仕様（ インデックス フィールドと順序）。 これは、 MongoDB\Collection::createIndex()の$keyパラメータと相関します。

function getKey(): array

Return Values

連想配列としてのインデックス仕様。

例

<?php
$info = new IndexInfo([
    'key' => ['x' => 1],
]);
var_dump($info->getKey());

出力は次のようになります。

array(1) {
  ["x"]=>
  int(1)
}

その他の参照

  • MongoDB\Collection::createIndex()

  • MongoDB マニュアルのlistIndexesコマンド参照

戻る

IndexInfo クラス