Class

AnalyticsIndexManager

AnalyticsIndexManager

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

Methods

Parameters:
Name Type Attributes Description
linkName string
options * <optional>
timeout integer <optional>
callback ConnectLinkCallback <optional>

View Source analyticsindexmanager.js, line 478

Promise.<boolean>

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

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

View Source analyticsindexmanager.js, line 144

Promise.<boolean>

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

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

View Source analyticsindexmanager.js, line 40

Promise.<boolean>

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

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

View Source analyticsindexmanager.js, line 314

Promise.<boolean>
Parameters:
Name Type Attributes Description
linkName string
options * <optional>
timeout integer <optional>
callback DisconnectLinkCallback <optional>

View Source analyticsindexmanager.js, line 511

Promise.<boolean>

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

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

View Source analyticsindexmanager.js, line 206

Promise.<boolean>

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

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

View Source analyticsindexmanager.js, line 91

Promise.<boolean>

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

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

View Source analyticsindexmanager.js, line 382

AnalyticsIndexNotFoundError
Promise.<boolean>

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

Parameters:
Name Type Attributes Description
options * <optional>
timeout integer <optional>
callback GetAllDatasetsCallback <optional>

View Source analyticsindexmanager.js, line 265

Promise.<Array.<AnalyticsDataset>>

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

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

View Source analyticsindexmanager.js, line 434

Promise.<Array.<AnalyticsIndex>>

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

Parameters:
Name Type Attributes Description
options * <optional>
timeout integer <optional>
callback GetPendingMutationsCallback <optional>

View Source analyticsindexmanager.js, line 543

Promise.<Object.<string, number>>