MongoDB\Model\IndexInfo::isUnique()

定義

MongoDB\Model\IndexInfo::isUnique()

Return whether the index is a unique index. This correlates with the unique option for MongoDB\Collection::createIndex().

function isUnique(): boolean

Return Values

インデックスが一意なインデックスであるかどうかを示すブール値。

例

<?php
$info = new IndexInfo([
    'unique' => true,
]);
var_dump($info->isUnique());

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

bool(true)

その他の参照

• MongoDB\Collection::createIndex()

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

• 「一意のインデックス」（MongoDB マニュアル）