rust/lancedb
1
0
Fork 0
mirror of https://github.com/lancedb/lancedb.git synced 2025-12-27 07:09:57 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
ea1f96dab03f4d69b93e9faa6352678167b5756f
lancedb/docs/src/javascript/interfaces/ColumnAlteration.md
Will Jones 48f46d4751 docs(node): update indexStats signature and regenerate docs (#1742) 
`indexStats` still referenced UUID even though in
https://github.com/lancedb/lancedb/pull/1702 we changed it to take name
instead.
2024-10-18 10:53:28 -07:00

1.3 KiB
Raw Blame History

vectordb / Exports / ColumnAlteration

Interface: ColumnAlteration

A definition of a column alteration. The alteration changes the column at path to have the new name name, to be nullable if nullable is true, and to have the data type data_type. At least one of rename or nullable must be provided.

Table of contents

Properties

Properties

nullable

• Optional nullable: boolean

Set the new nullability. Note that a nullable column cannot be made non-nullable.

Defined in

index.ts:638

path

• path: string

The path to the column to alter. This is a dot-separated path to the column. If it is a top-level column then it is just the name of the column. If it is a nested column then it is the path to the column, e.g. "a.b.c" for a column c nested inside a column b nested inside a column a.

Defined in

index.ts:633

rename

• Optional rename: string

Defined in

index.ts:634