MongoDB\Model\IndexInfo::getName()

Definición

MongoDB\Model\IndexInfo::getName()

Devuelve el nombre del índice. Esto se correlaciona con el valor de retorno de MongoDB\Collection::createIndex(). Un nombre de índice puede derivarse del $key parámetro o especificarse explícitamente mediante la name opción.

function getName(): string

Return Values

El nombre del índice.

Ejemplos

<?php
$info = new IndexInfo([
    'name' => 'x_1',
]);
echo $info->getName();

El resultado sería entonces similar a lo siguiente:

x_1

Ver también

• MongoDB\Collection::createIndex()

• Referencia del comandolistIndexes en el manual de MongoDB