Interface CreateQueryIndexOptions

Hierarchy

  • CreateQueryIndexOptions

Properties

collectionName?: string

Specifies the collection of this index.

Deprecated

Use CollectionQueryIndexManager instead.

deferred?: boolean

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

ignoreIfExists?: boolean

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

numReplicas?: number

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

scopeName?: string

Specifies the collection scope of this index.

Deprecated

Use CollectionQueryIndexManager instead.

timeout?: number

The timeout for this operation, represented in milliseconds.

Generated using TypeDoc