Edit Report a Bug

MongoCursor::hint

(PECL mongo >=0.9.0)

MongoCursor::hint — Da a la base de datos un indicio sobre la consulta

Descripción

public MongoCursor::hint ( mixed $index ) : MongoCursor

Parámetros

index: El índice a usar para la consulta. Si se proporciona un string, debería corresponderse con un nombre de índice. Si se proporciona un array u objeto, debería corresponderse con la especificación usada para crear el índice (esto es, el primer argumento de MongoCollection::ensureIndex()).

Valores devueltos

Devuelve este cursor.

Errores/Excepciones

Lanza una MongoCursorException si este cursor ha empezado a iterar.

Historial de cambios

Versión	Descripción
1.4.0	El argumento `index` ahora admite nombres de índices como valores de tipo string. En versiones anteriores a la 1.4.0, solamente eran aceptados valores de array u objeto.

add a note

User Contributed Notes 1 note

down

mr dot bipinks at gmail dot com ¶

8 years ago


For the series we’ll assume we have a collection named posts populated with 500 documents having the following structure:

{
    "_id": ObjectId("5146bb52d852470060001f4"),
    "comments": {
        "0": "This is the first comment",
        "1": "This is the second comment"
    },
    "post_likes": 40,
    "post_tags": {
        "0": "MongoDB",
        "1": "Tutorial",
        "2": "Indexing"
    },
    "post_text": "Hello Readers!! This is my post text",
    "post_type": "private",
    "user_name": "Mark Anthony"
}

The hint() method can be used to force MongoDB to use an index we specify and override the default selection and query optimization process. You can specify the field names used in the index as a argument as shown below:

<?php
// query to find posts with type public and 100 likes
// use hint() to force MongoDB to use the index we created
$cursor = $collection
    ->find(
        array(
            "post_type" => "public",
            "post_likes" => 100
        )
    )
    ->hint(
        array(
            "post_type" => 1,
            "post_likes" => 1
        )
    );
?>

This ensures the query uses the compound index defined on the post_type and post_likes fields.

add a note