Scroll to navigation

MONGOC_CURSOR_SET_BATCH_SIZE(3) Library Functions Manual MONGOC_CURSOR_SET_BATCH_SIZE(3)

NAME

mongoc_cursor_set_batch_size() - Limits the number of documents returned in one batch. Each batch requires a round trip to the server. If the batch size is zero, the cursor uses the server-defined maximum batch size.

SYNOPSIS


void mongoc_cursor_set_batch_size (mongoc_cursor_t *cursor, uint32_t batch_size);

PARAMETERS

cursor
A mongoc_cursor_t
batch_size
The requested number of documents per batch.

DESCRIPTION

Limits the number of documents returned in one batch. Each batch requires a round trip to the server. If the batch size is zero, the cursor uses the server‐defined maximum batch size.

See Cursor Batches in the MongoDB Manual.

COLOPHON

This page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.
2016‐10‐12 MongoDB C Driver