Interface DropPrimaryQueryIndexOptions

interface DropPrimaryQueryIndexOptions {
    collectionName?: string;
    ignoreIfNotExists?: boolean;
    name?: string;
    scopeName?: string;
    timeout?: number;
}

Properties

collectionName? ignoreIfNotExists? name? scopeName? timeout?

Properties

Optional collectionName

collectionName?: string

Specifies the collection of this index.

Deprecated

Use CollectionQueryIndexManager instead.

Optional ignoreIfNotExists

ignoreIfNotExists?: boolean

Whether or not the call should ignore the index already existing when determining whether the call was successful.

Optional name

name?: string

The name of the primary index to drop.

Optional scopeName

scopeName?: string

Specifies the collection scope of this index.

Deprecated

Use CollectionQueryIndexManager instead.

Optional timeout

timeout?: number

The timeout for this operation, represented in milliseconds.

Settings

Member Visibility

Theme

On This Page

collectionNameignoreIfNotExistsnamescopeNametimeout