mirror of
https://github.com/lancedb/lancedb.git
synced 2026-01-05 11:22:58 +00:00
48f46d4751
`indexStats` still referenced UUID even though in https://github.com/lancedb/lancedb/pull/1702 we changed it to take name instead.
54 lines
1.3 KiB
Markdown
54 lines
1.3 KiB
Markdown
[vectordb](../README.md) / [Exports](../modules.md) / 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
|
|
|
|
- [nullable](ColumnAlteration.md#nullable)
|
|
- [path](ColumnAlteration.md#path)
|
|
- [rename](ColumnAlteration.md#rename)
|
|
|
|
## Properties
|
|
|
|
### nullable
|
|
|
|
• `Optional` **nullable**: `boolean`
|
|
|
|
Set the new nullability. Note that a nullable column cannot be made non-nullable.
|
|
|
|
#### Defined in
|
|
|
|
[index.ts:638](https://github.com/lancedb/lancedb/blob/92179835/node/src/index.ts#L638)
|
|
|
|
___
|
|
|
|
### 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](https://github.com/lancedb/lancedb/blob/92179835/node/src/index.ts#L633)
|
|
|
|
___
|
|
|
|
### rename
|
|
|
|
• `Optional` **rename**: `string`
|
|
|
|
#### Defined in
|
|
|
|
[index.ts:634](https://github.com/lancedb/lancedb/blob/92179835/node/src/index.ts#L634)
|