mirror of
https://github.com/lancedb/lancedb.git
synced 2026-08-31 02:18:27 +00:00
Dan Tasse
8b7e13b0c6
In LanceDB Enterprise, we've adopted these conventions to give some "canonical" metadata paths. This lets us display them in a certain way in the UI or let agents standardize on them, to assume they'll find info in a certain place. This PR (only comments/docs) just documents those choices.
804 B
804 B
@lancedb/lancedb • Docs
@lancedb/lancedb / FieldMetadataUpdate
Interface: FieldMetadataUpdate
A per-field metadata update, addressed by dot-path.
Properties
metadata
metadata: Record<string, null | string>;
Metadata key/value pairs. Merged into the field's existing metadata by
default; a value of null deletes that key. See
Table.updateFieldMetadata for the conventional lancedb:* keys.
path
path: string;
Dot-separated path to the field. For a top-level column this is just its name; for a nested field it's the path, e.g. "a.b.c".
replace?
optional replace: boolean;
If true, replace the field's entire metadata map instead of merging.