Interface CreateTableIndexOptions

Options for creating a new index via Table.createIndex

interface CreateTableIndexOptions {
    ifNotExists?: boolean;
    options?: TableIndexOptions;
    timeout?: number | Pick<Partial<TimeoutDescriptor>, "tableAdminTimeoutMs" | "requestTimeoutMs">;
}

Properties

ifNotExists?: boolean

If true, no error will be thrown if the index already exists.

Note that this does not check if the existing index is the same as the one attempting to be created; it simply checks if the name is already in use.

Options available for text and ascii indexes

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

The method timeout override.

See TimeoutDescriptor for much more information.