API Documentation
Tutorials

Class

QueryIndexManager

QueryIndexManager

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

View Source queryindexmanager.js, line 42

Methods

# async buildDeferredIndexes(bucketName, optionsopt, callbackopt) → {Promise.<Array.<string>>}

Parameters:
Name Type Attributes Description
bucketName string
options * <optional>
timeout integer <optional>
callback BuildDeferredIndexesCallback <optional>

View Source queryindexmanager.js, line 341

CouchbaseError
Promise.<Array.<string>>

# async createIndex(bucketName, indexName, fields, optionsopt, callbackopt) → {Promise.<boolean>}

Parameters:
Name Type Attributes Description
bucketName string
indexName string
fields Array.<string>
options * <optional>
ignoreIfExists boolean <optional>
deferred boolean <optional>
timeout integer <optional>
callback CreateQueryIndexCallback <optional>

View Source queryindexmanager.js, line 126

IndexExistsError
CouchbaseError
Promise.<boolean>

# async createPrimaryIndex(bucketName, optionsopt, callbackopt) → {Promise.<boolean>}

Parameters:
Name Type Attributes Description
bucketName string
options * <optional>
ignoreIfExists boolean <optional>
deferred boolean <optional>
timeout integer <optional>
callback CreatePrimaryIndexCallback <optional>

View Source queryindexmanager.js, line 162

IndexExistsError
CouchbaseError
Promise.<boolean>

# async dropIndex(bucketName, indexName, optionsopt, callbackopt) → {Promise.<boolean>}

Parameters:
Name Type Attributes Description
bucketName string
indexName string
options * <optional>
ignoreIfNotExists boolean <optional>
timeout integer <optional>
callback DropQueryIndexCallback <optional>

View Source queryindexmanager.js, line 226

QueryIndexNotFoundError
CouchbaseError
Promise.<boolean>

# async dropPrimaryIndex(bucketName, optionsopt, callbackopt) → {Promise.<boolean>}

Parameters:
Name Type Attributes Description
bucketName string
options * <optional>
ignoreIfNotExists boolean <optional>
timeout integer <optional>
callback DropPrimaryIndexCallback <optional>

View Source queryindexmanager.js, line 259

QueryIndexNotFoundError
CouchbaseError
Promise.<boolean>

# async getAllIndexes(bucketName, optionsopt, callbackopt) → {Promise.<Array.<QueryIndex>>}

Parameters:
Name Type Attributes Description
bucketName string
options * <optional>
timeout integer <optional>
callback GetAllIndexesCallback <optional>

View Source queryindexmanager.js, line 300

CouchbaseError
Promise.<Array.<QueryIndex>>

# async watchIndexes(bucketName, indexNames, duration, optionsopt, callbackopt) → {Promise.<boolean>}

Parameters:
Name Type Attributes Description
bucketName string
indexNames Array.<string>
duration number
options * <optional>
watchPrimary integer <optional>
callback WatchIndexesCallback <optional>

View Source queryindexmanager.js, line 407

CouchbaseError
Promise.<boolean>