MongoDB\Model\IndexInfo::getName()

定義

MongoDB\Model\IndexInfo::getName()

インデックス名を返します。 これは、 MongoDB\Collection::createIndex()の戻り値と相関します。 インデックス名は、 $keyパラメータから派生することも、 nameオプションを使用して明示的に指定されることもあります。

function getName(): string

Return Values

インデックス名。

例

<?php
$info = new IndexInfo([
    'name' => 'x_1',
]);
echo $info->getName();

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

x_1

その他の参照

• MongoDB\Collection::createIndex()

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