Interface: RefreshColumnOptions¶

Options for Table.refreshColumn and Table.refreshColumnAsync. Every option is LanceDB Enterprise only; a LanceDB Embedded refresh ignores batchSize, gpuClass and gpuCount and rejects the rest.

Properties¶

batchSize?¶

optional batchSize: number;

Maximum rows per Function call; must be greater than zero.

errorPolicy?¶

optional errorPolicy: string;

"fail" (default) stops on a row error; "skip" writes null and records the error, subject to the failure limits.

gpuClass?¶

optional gpuClass: string;

GPU class for Function workers.

gpuCount?¶

optional gpuCount: number;

Positive aggregate GPU budget for Function workers.

initTimeoutSeconds?¶

optional initTimeoutSeconds: number;

Deadline for Function initialization, in seconds.

maxExecutorProcessesPerWorker?¶

optional maxExecutorProcessesPerWorker: number;

Cap on executor processes per Function worker.

maxFailedFraction?¶

optional maxFailedFraction: number;

Under a skip policy, fail the job once more than this share of rows (0 to 1) has failed.

maxFailedRows?¶

optional maxFailedRows: number;

Under a skip policy, fail the job once more than this many rows have failed.

numWorkers?¶

optional numWorkers: number;

Worker count for an expression column; Function columns reject it.

rowTimeoutSeconds?¶

optional rowTimeoutSeconds: number;

Deadline for one Function call, in seconds.

where?¶

optional where: string;

Only refresh the rows matching this SQL filter.