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命令参考