MongoCursor::hint

(PECL mongo >=0.9.0)

MongoCursor::hintGives the database a hint about the query

Descrição

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

Parâmetros

index

Index to use for the query. If a string is passed, it should correspond to an index name. If an array or object is passed, it should correspond to the specification used to create the index (i.e. the first argument to MongoCollection::ensureIndex()).

Valor Retornado

Returns this cursor.

Erros

Throws MongoCursorException if this cursor has started iterating.

Changelog

Versão Descrição
1.4.0

The index argument now supports index names as string values. In versions before 1.4.0, only array or object values were accepted.

add a note add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top