docs: add comments about metadata conventions

This commit is contained in:
Dan Tasse
2026-08-25 15:56:54 -04:00
parent a614400755
commit ac2956c1e2
6 changed files with 57 additions and 4 deletions
+12
View File
@@ -2120,12 +2120,24 @@ class Table(ABC):
----------
updates : dict
One or more dicts, each with:
- "path": str — dot-path to the field (e.g. "embedding" or "a.b.c").
- "metadata": dict[str, str | None] — keys to set; a value of ``None``
deletes that key.
- "replace": bool, optional — replace the field's whole metadata map
instead of merging (default False).
The following keys are treated specially, by convention, and should
be used when appropriate:
- "lancedb:description": for a human-readable description of a field.
- "lancedb:tag:(tag_name)" for a user-defined key-value tag.
- "lancedb:logical_column" for a column grouping; e.g. "feature_v1"
and "feature_v2" might be in the same logical_column.
- "lancedb:status" for status options ("production", "candidate",
"deprecated", "archived") to designate the current life cycle
state of this column.
Returns
-------
UpdateFieldMetadataResult