MongoCollection::getIndexInfo

(PECL mongo >=0.9.0)

MongoCollection::getIndexInfo — Retourne des informations sur les indexes de cette collection

Description

public array MongoCollection::getIndexInfo ( void )

Liste de paramètres

Cette fonction ne contient aucun paramètre.

Valeurs de retour

Cette fonction retourne un tableau dont chaque élément décrit un index. Les éléments contiennent les valeurs name pour le nom de l'index, ns pour l'espace de noms (une combinaison du nom la base de données et du nom de la collection), et key contenant une liste de tous les champs de l'index ainsi que leur ordre de tri. D'autres valeurs peuvent être présentes pour les indexes spéciaux, comme unique ou sparse.

Exemples

Exemple #1 Exemple avec MongoCollection::find()


<?php

$m = new MongoClient();
$c = $m->selectCollection('test', 'venues');
var_dump($c->getIndexInfo());

?>

L'exemple ci-dessus va afficher quelque chose de similaire à :

array(
  0 => array(
    "v" => 1,
    "key" => array(
      "_id" => 1,
    ),
    "ns" => "test.venues",
    "name" => "_id_",
  ),
  1 => array(
    "v" => 1,
    "key" => array(
      "name" => 1,
    ),
    "unique" : true,
    "ns" => "test.venues",
    "name" => "name_1",
  ),
  2 => array(
    "v" => 1,
    "key" => array(
      "type" => 1,
      "createdAt" => -1,
    ),
    "ns" => "test.venues",
    "name" => "type_1_createdAt_-1",
  ),
  3 => array(
    "v" => 1,
    "key" => array(
      "location" => "2d",
    ),
    "ns" => "test.venues",
    "name" => "location_2d",
  ),
)

Voir aussi

Documentation coeur MongoDB sur les » indexes vanilla et les » indexes géospatiaux.