でのカーソルの反復 `mongosh`

項目一覧

カーソルの手動反復処理

イテレータインデックス
カーソルの動作
カーソル情報

db.collection.find()メソッドはカーソルを返します。ドキュメントにアクセスするには、カーソルを反復する必要があります。ただし、 mongoshでは、返されたカーソルがvarキーワードを使用して変数に割り当てられていない場合、カーソルは自動的に最大20回まで反復されます[ 1 ]が最初のまで出力します。結果の20ドキュメント:

次の例で、カーソルを手動で反復処理してドキュメントにアクセスする方法や、イテレータインデックスを使用する方法を説明します。

カーソルの手動反復処理

mongosh では、 find() メソッドから返されたカーソルを var キーワードを使用して変数に割り当てると、カーソルは自動的に反復されません。

以下の例のように、shell で cursor 変数を呼び出して、最大 20 回繰り返し [1]、一致するドキュメントを出力できます。

var myCursor = db.users.find( { type: 2 } );
myCursor

また、次の例のように、カーソルメソッド next() を使用してドキュメントにアクセスできます。

var myCursor = db.users.find( { type: 2 } );
while (myCursor.hasNext()) {
   print(tojson(myCursor.next()));
}

代わりの出力操作として、printjson() ヘルパーメソッドを使用して print(tojson()) を置き換えることを検討してください。

var myCursor = db.users.find( { type: 2 } );
while (myCursor.hasNext()) {
   printjson(myCursor.next());
}

次の例のように、カーソルメソッド forEach() を使用してカーソルを反復処理し、ドキュメントにアクセスできます。

var myCursor =  db.users.find( { type: 2 } );
myCursor.forEach(printjson);

カーソルメソッドの詳細については、「 JavaScript カーソルメソッド」およびドライバーのドキュメントを参照してください。

[1]	（1、2）`DBQuery.shellBatchSize` 属性を設定して、ドキュメント数のデフォルト値 `20` を変更できます。

イテレータインデックス

mongosh では、次のように toArray() メソッドを使用してカーソルを反復処理し、ドキュメントを配列で返すことができます。

var myCursor = db.inventory.find( { type: 2 } );
var documentArray = myCursor.toArray();
var myDocument = documentArray[3];

toArray() メソッドは、カーソルによって返されたすべてのドキュメントを RAM にロードします。そのため、toArray() メソッドはカーソルを使い果たします。

さらに、一部のドライバーでは、カーソルのインデックス（つまり、cursor[index]）を使用してドキュメントにアクセスできます。これは、最初に toArray() メソッドを呼び出し、次に結果の配列のインデックスを使用するショートカットです。

次の例で考えてみます。

var myCursor = db.users.find( { type: 2 } );
var myDocument = myCursor[1];

myCursor[1] は次の例と同等です。

myCursor.toArray() [1];

カーソルの動作

セッション内で開かれたカーソル

MongoDB 5.0 以降では、対応するクライアントセッション内で作成されたカーソルは、セッションがタイムアウトした場合、またはクライアントがカーソルを使い果たした場合に、対応するサーバーセッションが killSessions コマンドで終了すると閉じます。

デフォルトでは、サーバーセッションの有効期限は 30 分です。この値を変更するには、mongod の起動時に localLogicalSessionTimeoutMinutes パラメータを設定します

セッション外で開かれたカーソル

セッション中に開かれていないカーソルは、 10分間操作がない場合、またはクライアントがカーソルを使い切ると自動的に閉じます。 mongoshでこの動作をオーバーライドするには、 cursor.noCursorTimeout()メソッドを使用します。

var myCursor = db.users.find().noCursorTimeout();

noCursorTimeout オプションの設定後は、cursor.close() を使用してカーソルを手動で閉じるか、カーソルの結果を使い切って閉じる必要があります。

noCursorTimeoutオプションの設定について詳しくは、ドライバーのドキュメントを参照してください。

カーソル使用中の同時更新

カーソルによってドキュメントが返されると、読み取り保証 (read concern)のレベルによっては、バックグラウンドで他の操作が実行され、結果に影響が出る可能性があります。詳細については、「読み取り分離、整合性、最新性について」を参照してください。

カーソルバッチ

MongoDB サーバーはクエリ結果をバッチで返します。バッチ内のデータ量は、BSON ドキュメントの最大サイズ以下です。バッチのデフォルトサイズをオーバーライドするには、batchSize() および limit() を参照してください。

find()、aggregate()、listIndexes、listCollections の各タイプの操作により、バッチするごとに最大 16 MB のデータが返されます。batchSize() を使用してその上限を下げられますが、上げることはできません。

find() 操作と aggregate() 操作の初期バッチサイズは、デフォルトでドキュメント数が 101 です。結果のカーソルに対して発行される後続の getMore 操作には、デフォルトのバッチサイズがないため、16 MB のメッセージサイズによってのみ制限されます。

インデックスなしでソート操作を行うクエリでは、サーバーは結果を返す前にすべてのドキュメントをメモリにロードしてソートを実行する必要があります。

ユーザーがカーソルを反復処理して返されたバッチの末尾に到達した際にさらに結果があるとcursor.next() は getMore operation を実行して次のバッチを取得します。カーソルを反復処理する間にバッチに残っているドキュメント数を確認するには、次の例のように objsLeftInBatch() メソッドを使用できます。

var myCursor = db.inventory.find();
var myFirstDocument = myCursor.hasNext() ? myCursor.next() : null;
myCursor.objsLeftInBatch();

存在しない `mongos` データベースのカーソル結果

MongoDB 7.2 以降、 mongos配置で存在しないデータベースを使用しようとする集計パイプラインクエリでは、検証エラーが返されます。

以前のバージョンでは、これらの集計クエリは空のカーソルを返していました。

カーソル情報

db.serverStatus() メソッドは、以下の metrics フィールドを含むドキュメントを返します。metrics フィールドには、次の情報を含む metrics.cursor フィールドが含まれています。

前回のサーバー再起動以降にタイムアウトしたカーソルの数
非アクティブな期間が一定期間続いてもタイムアウトしないよう DBQuery.Option.noTimeout オプションで設定されたオープンカーソルの数
「ピン留めされた」オープンカーソルの数
オープンカーソルの合計数

db.serverStatus() メソッドを呼び出して、結果から metrics フィールドにアクセスし、その metrics フィールドから cursor フィールドにアクセスする次の例を検討してみましょう。

db.serverStatus().metrics.cursor

次のドキュメントは、その結果です。

{
   "timedOut" : <number>
   "open" : {
      "noTimeout" : <number>,
      "pinned" : <number>,
      "total" : <number>
   }
}

Tip

以下も参照してください。

db.serverStatus()

戻る

長時間実行スナップショット

Update