API Documentation

Class

AnalyticsIndexManager

AnalyticsIndexManager

AnalyticsIndexManager provides an interface for performing management operations against the analytics indexes for the cluster.

View Source analyticsindexmanager.js, line 13

Methods

Parameters:
Name Type Attributes Description
linkName string
options Object <optional>
timeout number <optional>
callback ConnectLinkCallback <optional>

View Source analyticsindexmanager.js, line 507

CouchbaseError
Promise.<boolean>

# async createDataset(datasetName, optionsopt, callbackopt) → {Promise.<boolean>}

Parameters:
Name Type Attributes Description
datasetName string
options Object <optional>
ignoreIfExists boolean <optional>
dataverseName string <optional>
condition string <optional>
timeout number <optional>
callback CreateDatasetCallback <optional>

View Source analyticsindexmanager.js, line 153

DatasetExistsError
CouchbaseError
Promise.<boolean>

# async createDataverse(dataverseName, optionsopt, callbackopt) → {Promise.<boolean>}

Parameters:
Name Type Attributes Description
dataverseName string
options Object <optional>
ignoreIfExists boolean <optional>
timeout number <optional>
callback CreateDataverseCallback <optional>

View Source analyticsindexmanager.js, line 43

DataverseExistsError
CouchbaseError
Promise.<boolean>

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

Parameters:
Name Type Attributes Description
datasetName string
indexName string
fields Array.<string>
options Object <optional>
dataverseName string <optional>
ignoreIfExists boolean <optional>
timeout number <optional>
callback CreateAnalyticsIndexCallback <optional>

View Source analyticsindexmanager.js, line 333

IndexExistsError
CouchbaseError
Promise.<boolean>
Parameters:
Name Type Attributes Description
linkName string
options Object <optional>
timeout number <optional>
callback DisconnectLinkCallback <optional>

View Source analyticsindexmanager.js, line 543

CouchbaseError
Promise.<boolean>

# async dropDataset(datasetName, optionsopt, callbackopt) → {Promise.<boolean>}

Parameters:
Name Type Attributes Description
datasetName string
options Object <optional>
ignoreIfNotExists boolean <optional>
dataverseName string <optional>
timeout number <optional>
callback DropDatasetCallback <optional>

View Source analyticsindexmanager.js, line 218

DatasetNotFoundError
CouchbaseError
Promise.<boolean>

# async dropDataverse(dataverseName, optionsopt, callbackopt) → {Promise.<boolean>}

Parameters:
Name Type Attributes Description
dataverseName string
options Object <optional>
ignoreIfNotExists boolean <optional>
timeout number <optional>
callback DropDataverseCallback <optional>

View Source analyticsindexmanager.js, line 97

DataverseNotFoundError
CouchbaseError
Promise.<boolean>

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

Parameters:
Name Type Attributes Description
datasetName string
indexName string
options Object <optional>
dataverseName string <optional>
ignoreIfNotExists boolean <optional>
timeout number <optional>
callback DropAnalyticsIndexCallback <optional>

View Source analyticsindexmanager.js, line 404

AnalyticsIndexNotFoundError
CouchbaseError
Promise.<boolean>

# async getAllDatasets(optionsopt, callbackopt) → {Promise.<Array.<AnalyticsDataset>>}

Parameters:
Name Type Attributes Description
options Object <optional>
timeout number <optional>
callback GetAllDatasetsCallback <optional>

View Source analyticsindexmanager.js, line 281

CouchbaseError
Promise.<Array.<AnalyticsDataset>>

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

Parameters:
Name Type Attributes Description
options Object <optional>
timeout number <optional>
callback GetAllAnalyticsIndexesCallback <optional>

View Source analyticsindexmanager.js, line 460

CouchbaseError
Promise.<Array.<AnalyticsIndex>>

# async getPendingMutations(optionsopt, callbackopt) → {Promise.<Object.<string, number>>}

Parameters:
Name Type Attributes Description
options Object <optional>
timeout number <optional>
callback GetPendingMutationsCallback <optional>

View Source analyticsindexmanager.js, line 578

CouchbaseError
Promise.<Object.<string, number>>