mirror of
https://github.com/lancedb/lancedb.git
synced 2026-07-06 04:20:38 +00:00
d065be0474
### Summary Adds update_field_metadata to the client SDK (Rust core, Python, and TypeScript) so clients can edit per-field (column) Arrow metadata (schema.fields[].metadata) ### Testing - added unit tests - ran E2E against a local server on both local and remote tables (set → merge → delete), across Python sync/async and TypeScript ### Next steps - deprecate replace_field_metadata in the python lancedb favor of this (typescript didn't have replace_field_metadata method). This matches Lance's API direction (Lance already deprecated replace_field_metadata for update_field_metadata)
42 lines
692 B
Markdown
42 lines
692 B
Markdown
[**@lancedb/lancedb**](../README.md) • **Docs**
|
|
|
|
***
|
|
|
|
[@lancedb/lancedb](../globals.md) / FieldMetadataUpdate
|
|
|
|
# Interface: FieldMetadataUpdate
|
|
|
|
A per-field metadata update, addressed by dot-path.
|
|
|
|
## Properties
|
|
|
|
### metadata
|
|
|
|
```ts
|
|
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
|
|
|
|
```ts
|
|
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?
|
|
|
|
```ts
|
|
optional replace: boolean;
|
|
```
|
|
|
|
If true, replace the field's entire metadata map instead of merging.
|