Navigation
This version of the documentation is archived and no longer supported. To learn how to upgrade your version of PHP Library Manual, refer to the upgrade documentation.

MongoDB\Model\IndexInfo::getName()

Definition

MongoDB\Model\IndexInfo::getName

Return the index name. This correlates with the return value of MongoDB\Collection::createIndex(). An index name may be derived from the $key parameter or or explicitly specified via the name option.

function getName(): string

Return Values

The index name.

Examples

<?php

$info = new IndexInfo([
    'name' => 'x_1',
]);

echo $info->getName();

The output would then resemble:

x_1

See Also