lancedb/docs/src/js/interfaces/FieldMetadataUpdate.md

@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.

---

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.