Docs Menu
Docs Home
/
MongoDB マニュアル
/
参照
/
mongosh メソッド
/
Cursors

cursor.addOption()

項目一覧

  • 定義
  • Flags
  • 例

定義

cursor.addOption(flag)

重要

mongosh メソッド

このページでは、 mongosh メソッドが文書化されます。これは Node.js などの言語固有のドライバーのドキュメントではありません。

MongoDB API ドライバーについては、各言語の MongoDB ドライバー ドキュメントを参照してください。

注意

v 3.2 で廃止予定

v 3.2以降、 cursor.addOption()演算子は mongoでは非推奨です。 代わりに、利用可能なカーソル メソッドを使用してください。

以下に掲げるフラグを設定してクエリの動作を変更するために使用されます。

cursor.addOption()メソッドには次のパラメーターがあります。

Parameter
タイプ
説明
flag
flag
mongoshでは、以下に掲げるカーソル フラグを使用できます。 ドライバー固有のリストについては、ドライバー のドキュメントを参照してください。

Flags

mongosh は、カーソルの動作を変更するための追加のカーソル フラグをいくつか提供します。

Flag
説明
DBQuery.Option.tailable
最後のデータを受信してもカーソルを閉じないように設定し、初期結果が使い果たされた後に追加されたデータをクエリが引き続き返すことができるようにします。
DBQuery.Option.slaveOk
レプリカ セカンダリのクエリを許可します。
DBQuery.Option.noTimeout
サーバーがアイドル カーソルをタイムアウトしないようにします。
DBQuery.Option.awaitData
DBQuery.Option.tailableと併用します。 使用可能なデータがない場合にクエリ スレッドをブロックし、すぐにデータを返さずに設定された時間データを待機するようにカーソルを設定します。 カーソルは、タイムアウトが経過した場合にのみデータを返しません。
DBQuery.Option.exhaust
結果をバッチで分割するのではなく、クエリによって返されたすべてのデータを一度に返すようにカーソルを設定します。
DBQuery.Option.partial
エラーをスローするのではなく、一部のシャードが応答しないシャーディングされたクラスターに対するクエリから部分的なデータを返すようにカーソルを設定します。

例

次の例では、クエリが追尾可能 (tailable) カーソルを返すようにするために、 DBQuery.Option.tailableフラグとDBQuery.Option.awaitDataフラグを追加します。 シーケンスはカーソルを作成します。 完全な結果セットが返された後、クエリ中に追加された追加データをキャプチャして返すことができるように、デフォルトの間隔である 1000 ミリ秒待機します。

var t = db.myCappedCollection;
var cursor = t.find().addOption(DBQuery.Option.tailable).
                      addOption(DBQuery.Option.awaitData)

警告

誤ったワイヤプロトコル フラグを追加すると、問題が発生したりサーバーに余計な負荷がかかる可能性があります。

戻る

Cursors

項目一覧