Menu Docs
Página inicial do Docs
/
Idiomas
/
PHP
/
Manual da Biblioteca PHP
/
Documentação da API
/
Classes de resultados
/
Classe IndexInfo

MongoDB\Model\IndexInfo::getName()

Nesta página

  • Definição
  • Return Values
  • Exemplos
  • Veja também

Definição

MongoDB\Model\IndexInfo::getName()

Retorne o nome do índice. Isso está correlacionado com o valor de retorno de MongoDB\Collection::createIndex(). Um nome de índice pode ser derivado do parâmetro $key ou especificado explicitamente por meio da opção name .

function getName(): string

Return Values

O nome do índice.

Exemplos

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

A saída seria então semelhante a:

x_1

Veja também

  • MongoDB\Collection::createIndex()

  • Referência do comando listIndexes no manual MongoDB

Voltar

getKey()

Próximo

getNamespace()