Class AnalyticsIndexManager

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

Index

Methods

createDataset createDataverse createIndex createLink dropDataset dropDataverse dropIndex dropLink getAllDatasets getAllIndexes getAllLinks getPendingMutations replaceLink

Methods

createDataset

createDataset(
    bucketName: string,
    datasetName: string,
    options?: CreateAnalyticsDatasetOptions,
    callback?: NodeCallback<void>,
): Promise<void>
Creates a new dataset.
Parameters
- bucketName: string
  The name of the bucket to create this dataset of.
- datasetName: string
  The name of the new dataset.
- Optionaloptions: CreateAnalyticsDatasetOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<void>
  A node-style callback to be invoked after execution.
Returns Promise<void>
- Defined in lib/analyticsindexmanager.ts:1227

createDataverse

createDataverse(
    dataverseName: string,
    options?: CreateAnalyticsDataverseOptions,
    callback?: NodeCallback<void>,
): Promise<void>
Creates a new dataverse.
Parameters
- dataverseName: string
  The name of the dataverse to create.
- Optionaloptions: CreateAnalyticsDataverseOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<void>
  A node-style callback to be invoked after execution.
Returns Promise<void>
- Defined in lib/analyticsindexmanager.ts:1144

createIndex

createIndex(
    datasetName: string,
    indexName: string,
    fields: { [key: string]: string },
    options?: CreateAnalyticsIndexOptions,
    callback?: NodeCallback<void>,
): Promise<void>
Creates a new index.
Parameters
- datasetName: string
  The name of the dataset to create this index on.
- indexName: string
  The name of index to create.
- fields: { [key: string]: string }
  A map of fields that the index should contain.
- Optionaloptions: CreateAnalyticsIndexOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<void>
  A node-style callback to be invoked after execution.
Returns Promise<void>
- Defined in lib/analyticsindexmanager.ts:1363

createLink

createLink(
    link: IAnalyticsLink,
    options?: CreateAnalyticsLinkOptions,
    callback?: NodeCallback<void>,
): Promise<void>
Creates a new analytics remote link.
Parameters
- link: IAnalyticsLink
  The settings for the link to create.
- Optionaloptions: CreateAnalyticsLinkOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<void>
  A node-style callback to be invoked after execution.
Returns Promise<void>
- Defined in lib/analyticsindexmanager.ts:1750

dropDataset

dropDataset(
    datasetName: string,
    options?: DropAnalyticsDatasetOptions,
    callback?: NodeCallback<void>,
): Promise<void>
Drops a previously created dataset.
Parameters
- datasetName: string
  The name of the dataset to drop.
- Optionaloptions: DropAnalyticsDatasetOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<void>
  A node-style callback to be invoked after execution.
Returns Promise<void>
- Defined in lib/analyticsindexmanager.ts:1273

dropDataverse

dropDataverse(
    dataverseName: string,
    options?: DropAnalyticsDataverseOptions,
    callback?: NodeCallback<void>,
): Promise<void>
Drops a previously created dataverse.
Parameters
- dataverseName: string
  The name of the dataverse to drop.
- Optionaloptions: DropAnalyticsDataverseOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<void>
  A node-style callback to be invoked after execution.
Returns Promise<void>
- Defined in lib/analyticsindexmanager.ts:1185

dropIndex

dropIndex(
    datasetName: string,
    indexName: string,
    options?: DropAnalyticsIndexOptions,
    callback?: NodeCallback<void>,
): Promise<void>
Drops a previously created index.
Parameters
- datasetName: string
  The name of the dataset containing the index to drop.
- indexName: string
  The name of the index to drop.
- Optionaloptions: DropAnalyticsIndexOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<void>
  A node-style callback to be invoked after execution.
Returns Promise<void>
- Defined in lib/analyticsindexmanager.ts:1411

dropLink

dropLink(
    linkName: string,
    dataverseName: string,
    options?: DropAnalyticsLinkOptions,
    callback?: NodeCallback<void>,
): Promise<void>
Drops an existing analytics remote link.
Parameters
- linkName: string
  The name of the link to drop.
- dataverseName: string
  The dataverse containing the link to drop.
- Optionaloptions: DropAnalyticsLinkOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<void>
  A node-style callback to be invoked after execution.
Returns Promise<void>
- Defined in lib/analyticsindexmanager.ts:1921

getAllDatasets

getAllDatasets(
options?: GetAllAnalyticsDatasetsOptions,
callback?: NodeCallback<AnalyticsDataset[]>,
): Promise<AnalyticsDataset[]>
Returns a list of all existing datasets.
Parameters
- Optionaloptions: GetAllAnalyticsDatasetsOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<AnalyticsDataset[]>
  A node-style callback to be invoked after execution.
Returns Promise<AnalyticsDataset[]>
- Defined in lib/analyticsindexmanager.ts:1315

getAllIndexes

getAllIndexes(
options?: GetAllAnalyticsIndexesOptions,
callback?: NodeCallback<AnalyticsIndex[]>,
): Promise<AnalyticsIndex[]>
Returns a list of all existing indexes.
Parameters
- Optionaloptions: GetAllAnalyticsIndexesOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<AnalyticsIndex[]>
  A node-style callback to be invoked after execution.
Returns Promise<AnalyticsIndex[]>
- Defined in lib/analyticsindexmanager.ts:1455

getAllLinks

getAllLinks(
options?: GetAllAnalyticsLinksOptions,
callback?: NodeCallback<AnalyticsLink[]>,
): Promise<AnalyticsLink[]>
Returns a list of existing analytics remote links.
Parameters
- Optionaloptions: GetAllAnalyticsLinksOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<AnalyticsLink[]>
  A node-style callback to be invoked after execution.
Returns Promise<AnalyticsLink[]>
- Defined in lib/analyticsindexmanager.ts:1961

getPendingMutations

getPendingMutations(
options?: GetPendingAnalyticsMutationsOptions,
callback?: NodeCallback<{ [k: string]: { [k: string]: number } }>,
): Promise<{ [k: string]: { [k: string]: number } }>
Returns a list of all pending mutations.
Parameters
- Optionaloptions: GetPendingAnalyticsMutationsOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<{ [k: string]: { [k: string]: number } }>
  A node-style callback to be invoked after execution.
Returns Promise<{ [k: string]: { [k: string]: number } }>
- Defined in lib/analyticsindexmanager.ts:1710

replaceLink

replaceLink(
    link: IAnalyticsLink,
    options?: ReplaceAnalyticsLinkOptions,
    callback?: NodeCallback<void>,
): Promise<void>
Replaces an existing analytics remote link.
Parameters
- link: IAnalyticsLink
  The settings for the updated link.
- Optionaloptions: ReplaceAnalyticsLinkOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<void>
  A node-style callback to be invoked after execution.
Returns Promise<void>
- Defined in lib/analyticsindexmanager.ts:1835

Class AnalyticsIndexManager

Index

Methods

Methods

createDataset

Parameters

Returns Promise<void>

createDataverse

Parameters

Returns Promise<void>

createIndex

Parameters

Returns Promise<void>

createLink

Parameters

Returns Promise<void>

dropDataset

Parameters

Returns Promise<void>

dropDataverse

Parameters

Returns Promise<void>

dropIndex

Parameters

Returns Promise<void>

dropLink

Parameters

Returns Promise<void>

getAllDatasets

Parameters

Returns Promise<AnalyticsDataset[]>

getAllIndexes

Parameters

Returns Promise<AnalyticsIndex[]>

getAllLinks

Parameters

Returns Promise<AnalyticsLink[]>

getPendingMutations

Parameters

Returns Promise<{ [k: string]: { [k: string]: number } }>

replaceLink

Parameters

Returns Promise<void>

Settings

On This Page