setBatchSize Method @beta
Set the number of rows to fetch and cache while stepping. This is an advanced option that can be used to tune performance for large changesets. Increasing the batch size improves throughput at the cost of higher peak memory; decreasing it keeps memory consumption lower.
Default batch sizes when setBatchSize is not called:
InstanceKeyfilter: 100.BisCoreElementfilter (anyabbreviateBlobssetting): 20.Allfilter,abbreviateBlobs: false: 5.Allfilter (blobs abbreviated or unset): 10.
setBatchSize(batchSize: number): void
@throws IModelError if step has already been called successfully, or if batchSize is not a positive integer.
| Parameter | Type | Description |
|---|---|---|
| batchSize | number | Number of rows to fetch and cache while stepping. Must be a positive integer. |
Returns - void
Defined in
- backend/src/ChangesetReader.ts Line 362
Last Updated: 03 August, 2026
Found something wrong, missing, or unclear on this page? Raise an issue in our repo.