• API Documentation >
• Enumeration Classes >
• MongoDB\Model\IndexInfo::getNamespace()

MongoDB\Model\IndexInfo::getNamespace()

Definition

MongoDB\Model\IndexInfo::getNamespace

Return the index namespace, which is the namespace of the collection containing the index.

copy

function getNamespace(): string

Return Values

The index namespace.

Examples

copy

<?php

$info = new IndexInfo([
    'ns' => 'foo.bar',
]);

echo $info->getNamespace();

The output would then resemble:

copy

foo.bar

See Also

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

←   MongoDB\Model\IndexInfo::getName() MongoDB\Model\IndexInfo::getVersion()  →

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