Retourne une explication de la requête, souvent utile pour le déboguage et l'optimisation

# MongoCursor::explain

(PECL mongo >=0.9.2)

MongoCursor::explain — Retourne une explication de la requête, souvent utile pour le déboguage et l'optimisation

### Description

public MongoCursor::explain ( void ) : array

### Liste de paramètres

Cette fonction ne contient aucun paramètre.

### Valeurs de retour

Retourne une explication de la requête

### Exemples

Exemple #1 Exemple avec MongoCursor::explain()

`<?php
$cursor = $collection->find(array("x"=>1), array("y"));
$cursor->sort(array("z" => 1))->limit(4)->skip(5);
var_dump($cursor->explain());
?>`

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

    array(8) {
      ["cursor"]=>
      string(15) "BtreeCursor x_1"
      ["startKey"]=>
      array(1) {
        ["x"]=>
        int(1)
      }
      ["endKey"]=>
      array(1) {
        ["x"]=>
        int(1)
      }
      ["nscanned"]=>
      float(4)
      ["n"]=>
      int(4)
      ["scanAndOrder"]=>
      int(1)
      ["millis"]=>
      int(3)
      ["allPlans"]=>
      array(2) {
        [0]=>
        array(3) {
          ["cursor"]=>
          string(15) "BtreeCursor x_1"
          ["startKey"]=>
          array(1) {
            ["x"]=>
            int(1)
          }
          ["endKey"]=>
          array(1) {
            ["x"]=>
            int(1)
          }
        }
        [1]=>
        array(3) {
          ["cursor"]=>
          string(11) "BasicCursor"
          ["startKey"]=>
          array(0) {
          }
          ["endKey"]=>
          array(0) {
          }
        }
      }
    }

### Erreurs / Exceptions

Lance une exception MongoConnectionException si la base de données ne peut être atteinte.

### Voir aussi

Documentation de MongoDB » concernant explain.