Interface CreatePrimaryQueryIndexOptions

interface CreatePrimaryQueryIndexOptions {
    collectionName?: string;
    deferred?: boolean;
    ignoreIfExists?: boolean;
    name?: string;
    numReplicas?: number;
    scopeName?: string;
    timeout?: number;
}

Properties

collectionName? deferred? ignoreIfExists? name? numReplicas? scopeName? timeout?

Properties

Optional collectionName

collectionName?: string

Specifies the collection of this index.

Deprecated

Use CollectionQueryIndexManager instead.

Optional deferred

deferred?: boolean

Specifies whether this index creation should be deferred until a later point in time when they can be explicitly built together.

Optional ignoreIfExists

ignoreIfExists?: 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 this primary index.

Optional numReplicas

numReplicas?: number

The number of replicas of this index that should be created.

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

collectionNamedeferredignoreIfExistsnamenumReplicasscopeNametimeout