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`では、以下に掲げるカーソルフラグを使用できます。ドライバー固有のリストについては、ドライバーのドキュメントを参照してください。

互換性

このメソッドは、次の環境でホストされている配置で使用できます。

MongoDB Atlas はクラウドでの MongoDB 配置のためのフルマネージドサービスです

重要

このコマンドは、M 0 、M 2 、M 5 、および M 10 + クラスターでサポートが限定されています。詳細については、「サポートされていないコマンド」を参照してください。

MongoDB Enterprise: サブスクリプションベースの自己管理型 MongoDB バージョン
MongoDB Community: ソースが利用可能で、無料で使用できる自己管理型の MongoDB のバージョン

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

cursor.allowDiskUse