Interface: AddDataOptions¶

Options for adding data to a table.

Properties¶

mode¶

mode: "append" | "overwrite";

If "append" (the default) then the new data will be added to the table

If "overwrite" then the new data will replace the existing data in the table.

progress()¶

progress: (progress) => void;

Optional callback invoked periodically with write progress.

The callback is fired once per batch written and once more with done: true when the write completes. Calls are dispatched asynchronously to the JS event loop and never block the write — a slow callback will queue events rather than back-pressure the writer.

Errors thrown from the callback are logged with console.warn and swallowed — they do not abort the write.

Parameters¶

progress: WriteProgress

Returns¶

void

Example¶

await table.add(data, {
  progress: (p) => {
    console.log(`${p.outputRows}/${p.totalRows ?? "?"} rows`);
  },
});