api.walkDatabaseData() - RevoEngine

`api.walkDatabaseData()`

Processes a large database, view, or materialized-view result in sequential, awaited batches without collecting all rows in the isolate. Specify query.take or options.fullScan:true. Every non-final batch has exactly batchSize rows when available (default 10,000). The callback may await writes; do not accumulate batches in an array.

Signature

static walkDatabaseData<T = any>(
      name: string,
      query: Omit<SelectInput, 'debug'>,
      callback: (batch: T[], context: { batch: number; processed: number }) => void | Promise<void>,
      options?: DatabaseWalkOptions,
    ): Promise<DatabaseWalkResult>;

Example

await api.walkDatabaseData('customers', { take: 100000, sort: ['customerId'] },
  async (batch) => {
    await api.upsertDatabaseData('customer_export', batch, { return: false });
  }, { batchSize: 10000 });

See all api methods or runtime basics.

Last modified on November 8, 2026