mirror of
https://github.com/lancedb/lancedb.git
synced 2026-10-31 07:46:51 +00:00
Will JonesandClaude Opus 5.5
4d7a64712f
## Summary Adopts the product terminology guide across the docs site pages, SDK docstrings and error messages. "LanceDB OSS" and local mode become **LanceDB Embedded**. "Remote" as the execution model becomes **LanceDB Distributed**, which LanceDB Enterprise provides. Where free vs paid is the point, pages contrast "LanceDB Embedded (open source)" with "LanceDB Enterprise". This is a first trial of the Embedded name, so reviewers can judge it in context. - **Embedded vs Distributed** for where execution runs (`optimize()`, consistency, branching, maintenance). Main pages define it once: "LanceDB Enterprise runs LanceDB Distributed: …" - **LanceDB Cloud** is kept only for legacy-Cloud specifics (`db://` region, the brute-force KNN limit) and marked legacy. "Cloud and Enterprise" becomes Enterprise or Distributed. - **Plan executor** becomes "executor" or the fleet name. - **Error messages** change, e.g. `optimize is not supported for remote tables.` → `... in LanceDB Distributed.` Tests that match on them are updated. - **Vale rules** (`EmbeddedName`, `OSSProduct`, `RemoteExecution`, `DistributedEnterprise`, `LegacyCloud`, `InternalNames`) enforce the terms in prose. Unchanged: identifiers (`availability.oss`, the `remote` module and feature, `RemoteTable`, `db://`), heading anchors, internal code comments, and Geneva. ## Evidence - Rust lib tests for the changed messages and the Python tests in `test_remote_db.py`, `test_materialized_views.py` and `test_table.py` pass locally. - Not run locally: - The Node tests: `remote.test.ts` and `table.test.ts` have updated assertions. - Vale. - The `experimental_functions`-marked materialized-view tests. - `docs/src` API reference was hand-edited to match the docstrings rather than regenerated. ## Merge Risk **Door:** two-way; prose and message text only. **Blast Radius:** `docs`, `error-messages`: callers matching on old error strings would break. Companion PRs: lancedb/docs (assembler labels, STYLE.md) and sophon (Enterprise pages). 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
74 lines
1.6 KiB
Markdown
74 lines
1.6 KiB
Markdown
[**@lancedb/lancedb**](../README.md) • **Docs**
|
|
|
|
***
|
|
|
|
[@lancedb/lancedb](../globals.md) / AddDataOptions
|
|
|
|
# Interface: AddDataOptions
|
|
|
|
Options for adding data to a table.
|
|
|
|
## Properties
|
|
|
|
### allowExternalBlobOutsideBases?
|
|
|
|
```ts
|
|
optional allowExternalBlobOutsideBases: boolean;
|
|
```
|
|
|
|
Whether blob URIs outside registered external bases may be written.
|
|
|
|
Defaults to `false`. This option is supported only in LanceDB Embedded;
|
|
LanceDB Distributed returns an error when it is enabled. An enabled write
|
|
stores the absolute URI reference without registering a base or copying
|
|
the external object into the database. The object must remain accessible
|
|
when the blob is read later.
|
|
|
|
***
|
|
|
|
### mode
|
|
|
|
```ts
|
|
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()
|
|
|
|
```ts
|
|
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`](WriteProgress.md)
|
|
|
|
#### Returns
|
|
|
|
`void`
|
|
|
|
#### Example
|
|
|
|
```ts
|
|
await table.add(data, {
|
|
progress: (p) => {
|
|
console.log(`${p.outputRows}/${p.totalRows ?? "?"} rows`);
|
|
},
|
|
});
|
|
```
|