MongoCursor::hint

(PECL mongo >=0.9.0)

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

public MongoCursor MongoCursor::hint ( mixed $index )

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

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

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

バージョン	説明
1.4.0	`index` 引数に、文字列でインデックス名を指定できるよういなりました。これより前のバージョンでは、配列またはオブジェクトしか渡せませんでした。