• Reference >
• Enumeration Classes >
• MongoDB\Model\IndexInfo::isUnique()

MongoDB\Model\IndexInfo::isUnique()

Definition

MongoDB\Model\IndexInfo::isUnique

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

copy

function isUnique(): boolean

Return Values

A boolean indicating whether the index is a unique index.

Examples

copy

<?php

$info = new IndexInfo([
    'unique' => true,
]);

var_dump($info->isUnique());

The output would then resemble:

copy

bool(true)

See Also

• MongoDB\Collection::createIndex()
• listIndexes command reference in the MongoDB manual
• Unique Indexes in the MongoDB manual

←   MongoDB\Model\IndexInfo::isTtl() Functions  →

© MongoDB, Inc 2008-present. MongoDB, Mongo, and the leaf logo are registered trademarks of MongoDB, Inc.