Interface AlterTableOptions<Schema>

Options for altering a table.

interface AlterTableOptions<Schema> {
operation: AlterTableOperations<Schema>;
timeout?: number | Pick<Partial<TimeoutDescriptor>, "tableAdminTimeoutMs" | "requestTimeoutMs">;
}

Type Parameters

Schema extends SomeRow

Hierarchy (view full)

WithTimeout<"tableAdminTimeoutMs">
- AlterTableOptions

Index

Properties

operation timeout?

Properties

operation

operation: AlterTableOperations<Schema>

The operations to perform on the table. Must pick just one of add, drop, addVectorize, or dropVectorize.

`Optional` timeout

timeout?: number | Pick<Partial<TimeoutDescriptor>, "tableAdminTimeoutMs" | "requestTimeoutMs">

The method timeout override.

See TimeoutDescriptor for much more information.