Interface TableCreateTextIndexOptions

Options for creating a new index via Table.createTextIndex

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

Hierarchy (view full)

  • WithTimeout<"tableAdminTimeoutMs">
    • TableCreateTextIndexOptions

Properties

ifNotExists? maxTimeMS? options? timeout?

Properties

Optional ifNotExists

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.

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.

Optional options

options?: TableTextIndexOptions

Options available for text and ascii indexes

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

ifNotExistsmaxTimeMSoptionstimeout