Skip to content

@lancedb/lancedbDocs


@lancedb/lancedb / WriteProgress

Interface: WriteProgress

Progress snapshot for a write operation, delivered to the progress callback passed to Table.add.

Properties

activeTasks

activeTasks: number;

Number of parallel write tasks currently in flight.


done

done: boolean;

true for the final callback; false otherwise.


elapsedSeconds

elapsedSeconds: number;

Wall-clock seconds since the write started.


outputBytes

outputBytes: number;

Number of bytes written so far.


outputRows

outputRows: number;

Number of rows written so far.


totalRows?

optional totalRows: number;

Total rows expected, when the input source reports it.

Always set on the final callback (the one with done: true), falling back to the actual number of rows written when the source could not report a row count up front.


totalTasks

totalTasks: number;

Total number of parallel write tasks (the write parallelism).