QueryIndexManager | couchbase

QueryIndexManager provides an interface for managing the query indexes on the cluster.

Hierarchy

QueryIndexManager

Index

Methods

buildDeferredIndexes

buildDeferredIndexes(bucketName: string, options?: BuildQueryIndexOptions, callback?: NodeCallback<string[]>): Promise<string[]>

- Defined in lib/queryindexmanager.ts:551
Starts building any indexes which were previously created with deferred=true.

Parameters
- bucketName: string
  
  The name of the bucket to perform the build on.
- Optional options: BuildQueryIndexOptions
  
  Optional parameters for this operation.
- Optional callback: NodeCallback<string[]>
  
  A node-style callback to be invoked after execution.
Returns Promise<string[]>

createIndex

createIndex(bucketName: string, indexName: string, fields: string[], options?: CreateQueryIndexOptions, callback?: NodeCallback<void>): Promise<void>

- Defined in lib/queryindexmanager.ts:327
Creates a new query index.

Parameters
- bucketName: string
  
  The name of the bucket this index is for.
- indexName: string
  
  The name of the new index.
- fields: string[]
  
  The fields which this index should cover.
- Optional options: CreateQueryIndexOptions
  
  Optional parameters for this operation.
- Optional callback: NodeCallback<void>
  
  A node-style callback to be invoked after execution.
Returns Promise<void>

createPrimaryIndex

createPrimaryIndex(bucketName: string, options?: CreatePrimaryQueryIndexOptions, callback?: NodeCallback<void>): Promise<void>

- Defined in lib/queryindexmanager.ts:364
Creates a new primary query index.

Parameters
- bucketName: string
  
  The name of the bucket this index is for.
- Optional options: CreatePrimaryQueryIndexOptions
  
  Optional parameters for this operation.
- Optional callback: NodeCallback<void>
  
  A node-style callback to be invoked after execution.
Returns Promise<void>

dropIndex

dropIndex(bucketName: string, indexName: string, options?: DropQueryIndexOptions, callback?: NodeCallback<void>): Promise<void>

- Defined in lib/queryindexmanager.ts:434
Drops an existing query index.

Parameters
- bucketName: string
  
  The name of the bucket containing the index to drop.
- indexName: string
  
  The name of the index to drop.
- Optional options: DropQueryIndexOptions
  
  Optional parameters for this operation.
- Optional callback: NodeCallback<void>
  
  A node-style callback to be invoked after execution.
Returns Promise<void>

dropPrimaryIndex

dropPrimaryIndex(bucketName: string, options?: DropPrimaryQueryIndexOptions, callback?: NodeCallback<void>): Promise<void>

- Defined in lib/queryindexmanager.ts:467
Drops an existing primary index.

Parameters
- bucketName: string
  
  The name of the bucket containing the primary index to drop.
- Optional options: DropPrimaryQueryIndexOptions
  
  Optional parameters for this operation.
- Optional callback: NodeCallback<void>
  
  A node-style callback to be invoked after execution.
Returns Promise<void>

getAllIndexes

getAllIndexes(bucketName: string, options?: GetAllQueryIndexesOptions, callback?: NodeCallback<QueryIndex[]>): Promise<QueryIndex[]>

- Defined in lib/queryindexmanager.ts:499
Returns a list of indexes for a specific bucket.

Parameters
- bucketName: string
  
  The name of the bucket to fetch indexes for.
- Optional options: GetAllQueryIndexesOptions
  
  Optional parameters for this operation.
- Optional callback: NodeCallback<QueryIndex[]>
  
  A node-style callback to be invoked after execution.
Returns Promise<QueryIndex[]>

watchIndexes

watchIndexes(bucketName: string, indexNames: string[], timeout: number, options?: WatchQueryIndexOptions, callback?: NodeCallback<void>): Promise<void>

- Defined in lib/queryindexmanager.ts:616
Waits for a number of indexes to finish creation and be ready to use.

Parameters
- bucketName: string
  
  The name of the bucket to watch for indexes on.
- indexNames: string[]
  
  The names of the indexes to watch.
- timeout: number
  
  The maximum time to wait for the index, expressed in milliseconds.
- Optional options: WatchQueryIndexOptions
  
  Optional parameters for this operation.
- Optional callback: NodeCallback<void>
  
  A node-style callback to be invoked after execution.
Returns Promise<void>

Hierarchy

Index

Methods

Methods

buildDeferredIndexes

Parameters

bucketName: string

Optional options: BuildQueryIndexOptions

Optional callback: NodeCallback<string[]>

Returns Promise<string[]>

createIndex

Parameters

bucketName: string

indexName: string

fields: string[]

Optional options: CreateQueryIndexOptions

Optional callback: NodeCallback<void>

Returns Promise<void>

createPrimaryIndex

Parameters

bucketName: string

Optional options: CreatePrimaryQueryIndexOptions

Optional callback: NodeCallback<void>

Returns Promise<void>

dropIndex

Parameters

bucketName: string

indexName: string

Optional options: DropQueryIndexOptions

Optional callback: NodeCallback<void>

Returns Promise<void>

dropPrimaryIndex

Parameters

bucketName: string

Optional options: DropPrimaryQueryIndexOptions

Optional callback: NodeCallback<void>

Returns Promise<void>

getAllIndexes

Parameters

bucketName: string

Optional options: GetAllQueryIndexesOptions

Optional callback: NodeCallback<QueryIndex[]>

Returns Promise<QueryIndex[]>

watchIndexes

Parameters

bucketName: string

indexNames: string[]

timeout: number

Optional options: WatchQueryIndexOptions

Optional callback: NodeCallback<void>

Returns Promise<void>