Php/docs/mongocursor.hint

提供:Dev Guides
< Php
移動先:案内検索

MongoCursor::hint

(PECL mongo >=0.9.0)

MongoCursor::hintクエリについてのヒントをデータベースに与える


説明

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

パラメータ

index
クエリで使用するインデックス。 文字列を渡した場合は、インデックス名として扱います。 配列あるいはオブジェクトを渡した場合は、それに基づいてインデックスを組み立てます (MongoCollection::ensureIndex() の最初の引数のようになります)。


返り値

このカーソルを返します。


エラー / 例外

このカーソルの反復処理が始まっている場合に MongoCursorException をスローします。


変更履歴

バージョン 説明
PECL mongo 1.4.0 index 引数に、文字列でインデックス名を指定できるよういなりました。

これより前のバージョンでは、配列またはオブジェクトしか渡せませんでした。