cursor.maxAwaitTimeMS()
定義
cursor.maxAwaitTimeMS(<time limit>)
重要
mongosh メソッド
このページでは、
mongosh
メソッドが文書化されます。これは Node.js などの言語固有のドライバーのドキュメントではありません。MongoDB API ドライバーについては、各言語の MongoDB ドライバー ドキュメントを参照してください。
Capped コレクション の 追尾可能 (tailable) カーソル クエリに一致する新しいドキュメントをサーバーが待機する最大時間を指定します。クエリによって返されたカーソルを反復処理する方法の詳細については、「
mongosh
でのカーソルの反復処理 」を参照してください。maxAwaitTimeMS()
メソッドのプロトタイプ形式は次のとおりです。db.collection.find( { <query> }, { <projection> } ).tailable( { awaitData: true } ).maxAwaitTimeMS( <milliseconds> ) maxAwaitTimeMS()
メソッドには次のパラメーターがあります。Parameterタイプ説明milliseconds
integer
新しいドキュメントの最大待機時間を指定します。
重要
このメソッドmaxAwaitTimeMS()
は、追尾可能 (tailable) カーソルが次の応答を待機する時間の制限を設定します。 maxTimeMS()
は合計処理時間の制限を設定します。
互換性
このメソッドは、次の環境でホストされている配置で使用できます。
MongoDB Atlas はクラウドでの MongoDB 配置のためのフルマネージド サービスです
注意
このコマンドは、すべての MongoDB Atlas クラスターでサポートされています。すべてのコマンドに対する Atlas のサポートについては、「サポートされていないコマンド」を参照してください。
MongoDB Enterprise: サブスクリプションベースの自己管理型 MongoDB バージョン
MongoDB Community: ソースが利用可能で、無料で使用できる自己管理型の MongoDB のバージョン
例
Capped sales
コレクションをクエリして、エージェント メトリクスの月間売上合計を見つけます。
db.sales.find( { agent: "Mary Kay" }, { _id: 0, agent: 1, weeklyTotal: 1 } ).tailable( { awaitData: true } ).maxAwaitTimeMS( 1000 )
強調表示された行は、 sales
コレクションに追尾可能 (tailable) カーソルを作成します。 maxAwaitTimeMS()
は、次のカーソル更新の最大待機時間を 1 秒に設定します。