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:

  • InstanceKey filter: 100.
  • BisCoreElement filter (any abbreviateBlobs setting): 20.
  • All filter, abbreviateBlobs: false: 5.
  • All filter (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

Last Updated: 03 August, 2026