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

定義

cursor.batchSize(size)

重要

mongosh メソッド

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

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

クエリ結果の各バッチで返されることができるドキュメントの最大数。デフォルトでは、初期バッチサイズは 101 件のドキュメントまたは 16 メビバイト（MiB）相当のドキュメントのうち、少ない方となります。以降のバッチの最大サイズは 16 メビバイト（MiB）です。このオプションは、16 メビバイト（MiB）より小さい制限を強制することはできますが、それを超える制限を設定することはできません。設定されている場合、batchSize は batchSize 件のドキュメントまたは 16 メビバイト（MiB）相当のドキュメントのうち、少ない方になります。

batchSize が 0 の場合、カーソルが確立されているものの最初のバッチで返されるドキュメントはないことを表します。

注意

バッチ サイズが大きすぎると、カーソルが必要以上に多くのリソースを割り当てるため、クエリのパフォーマンスに悪影響を及ぼす可能性があります。バッチ サイズが小さすぎると、カーソルがクエリ結果を取得するためのネットワーク ラウンド トリップが増え、クエリのパフォーマンスに悪影響を及ぼす可能性があります。

batchSize をデータベース、ロード、およびアプリケーションのニーズに適した値に調整します。

batchSize() メソッドは次のフィールドを受け取ります。

フィールド	タイプ	説明
size	integer	クエリ結果の各バッチするで返されるドキュメントの最大数。デフォルトの初期バッチするサイズは、101ドキュメントまたはドキュメントの 16メビバイト（MiB）の値が小さい方です。それ以降のバッチの最大サイズは 16 MiB です。このオプションを使用すると、16 MiB より小さい制限が適用できますが、超えることはありません。デフォルトはドライバーと mongo シェルに適用されます。 詳細については、カーソルバッチを参照してください。

互換性

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

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

• MongoDB Enterprise: サブスクリプションベースの自己管理型 MongoDB バージョン

• MongoDB Community: ソースが利用可能で、無料で使用できる自己管理型の MongoDB のバージョン

例

次の例では、クエリの結果（具体的には、find()）の batchSize を 10 に設定します。

db.inventory.find().batchSize(10)

詳細

• カーソル バッチ

• cursor.next()

• getMore