Sign in

v52

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-0393116227.2 KB
metadata-columns

Declare a metadata column

(reserved for future use) Declares a metadata column to be materialized as a typed LanceDB column with a scalar index at the next ingestion. The key must be a column-safe identifier and the type must be "string" or "integer".

Required roles: All

post/metadata_columns

Request body

keystring required
type'string' | 'integer' required
filter_onlyboolean
index_type'btree' | 'bitmap'

Scalar index type. Omit to use the type default (integer -> btree, string -> bitmap).

Response

Column declared

keystring required

Metadata key name (also the LanceDB column source name).

type'string' | 'integer' required

Column type. Only string / integer (scalar-indexable) are allowed.

filter_onlyboolean

When true, the value is kept only as a LanceDB column for filtering and is not included in chunk bodies or API responses.

index_type'btree' | 'bitmap'

Scalar index type actually applied to the column. Defaults to BTREE for integer and BITMAP for string when not specified at creation; override for cardinality (e.g. high-cardinality string -> btree).

created_atstring nullable