mirror of
https://github.com/lancedb/lancedb.git
synced 2026-07-03 11:00:40 +00:00
049b0c8f09
### Summary
- Add an optional `progress` callback to `Table.add(data, { progress
})`. Callback fires once per batch written and once more with `done:
true` when the write completes.
- Errors thrown from the user's callback are logged with `console.warn`
and swallowed
### Testing
- npm test
- ran smoke test script to verify functionality
85 lines
1.1 KiB
Markdown
85 lines
1.1 KiB
Markdown
[**@lancedb/lancedb**](../README.md) • **Docs**
|
|
|
|
***
|
|
|
|
[@lancedb/lancedb](../globals.md) / WriteProgress
|
|
|
|
# Interface: WriteProgress
|
|
|
|
Progress snapshot for a write operation, delivered to the `progress`
|
|
callback passed to [Table.add](../classes/Table.md#add).
|
|
|
|
## Properties
|
|
|
|
### activeTasks
|
|
|
|
```ts
|
|
activeTasks: number;
|
|
```
|
|
|
|
Number of parallel write tasks currently in flight.
|
|
|
|
***
|
|
|
|
### done
|
|
|
|
```ts
|
|
done: boolean;
|
|
```
|
|
|
|
`true` for the final callback; `false` otherwise.
|
|
|
|
***
|
|
|
|
### elapsedSeconds
|
|
|
|
```ts
|
|
elapsedSeconds: number;
|
|
```
|
|
|
|
Wall-clock seconds since the write started.
|
|
|
|
***
|
|
|
|
### outputBytes
|
|
|
|
```ts
|
|
outputBytes: number;
|
|
```
|
|
|
|
Number of bytes written so far.
|
|
|
|
***
|
|
|
|
### outputRows
|
|
|
|
```ts
|
|
outputRows: number;
|
|
```
|
|
|
|
Number of rows written so far.
|
|
|
|
***
|
|
|
|
### totalRows?
|
|
|
|
```ts
|
|
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
|
|
|
|
```ts
|
|
totalTasks: number;
|
|
```
|
|
|
|
Total number of parallel write tasks (the write parallelism).
|