Interface AlterTableOptions<Schema>

Options for altering a table.

interface AlterTableOptions<Schema> {
    maxTimeMS?: "ERROR: The `maxTimeMS` option is no longer available; the timeouts system has been overhauled, and timeouts should now be set using `timeout`";
    operation: AlterTableOperations<Schema>;
    timeout?: number | Pick<Partial<TimeoutDescriptor>, "requestTimeoutMs" | "tableAdminTimeoutMs">;
}

Type Parameters

Hierarchy (view full)

Properties

maxTimeMS? operation timeout?

Properties

Optional maxTimeMS

maxTimeMS?: "ERROR: The `maxTimeMS` option is no longer available; the timeouts system has been overhauled, and timeouts should now be set using `timeout`"

This temporary error-ing property exists for migration convenience, and will be removed in a future version.

Deprecated

  • The maxTimeMS option is no longer available; the timeouts system has been overhauled, and timeouts should now be set using timeout, and defaults in timeoutDefaults. You may generally Ctrl+R replace maxTimeMS with timeout to retain the same behavior.

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>, "requestTimeoutMs" | "tableAdminTimeoutMs">

The method timeout override.

See TimeoutDescriptor for much more information.

Settings

Member Visibility

Theme

On This Page

maxTimeMSoperationtimeout