MongoDB\Model\IndexInfo::isSparse()

定義

MongoDB\Model\IndexInfo::isSparse()

インデックスが sparse indexであるかどうかを返します。 これは、 MongoDB\Collection::createIndex()のsparseオプションと相関します。

function isSparse(): boolean

Return Values

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

例

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

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

bool(true)

その他の参照

• MongoDB\Collection::createIndex()

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

• MongoDB マニュアルの「スパース インデックス」