cursor.addOption()（mongoshメソッド）

定義

cursor.addOption(flag)

重要

mongosh メソッド

This page documents a mongosh method. This is not the documentation for a language-specific driver, such as Node.js.

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

注意

v 3.2 で廃止予定

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

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

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

Parameter	タイプ	説明
`flag`	flag	For `mongosh`, you can use the cursor flags listed below. For the driver-specific list, see your driver documentation.

互換性

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

MongoDB Atlas はクラウドでの MongoDB 配置のための完全管理サービスです

重要

このコマンドは、すべてのMongoDB Atlasクラスターでのサポートが制限されています。詳細については、サポートされていないコマンドを参照してください。

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

Flags

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

Flag	説明
`DBQuery.Option.tailable`	最後のデータを受信してもカーソルを閉じないように設定し、初期結果が使い果たされた後に追加されたデータをクエリが引き続き返すことができるようにします。
`DBQuery.Option.slaveOk`	レプリカセカンダリのクエリを許可します。
`DBQuery.Option.noTimeout`	サーバーがアイドルカーソルをタイムアウトしないようにします。
`DBQuery.Option.awaitData`	For use with `DBQuery.Option.tailable`. Sets the cursor to block the query thread when no data is available and await data for a set time instead of immediately returning no data. The cursor returns no data only if the timeout expires.
`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)

警告

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

戻る

db.collection.watch

cursor.allowDiskUse