Class AnalyticsIndexManager

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

Methods

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

Methods

connectLink

  • connectLink(linkStr, options?, callback?): Promise<void>

  • Connects a not yet connected link.

    Parameters

    • linkStr: string

      The name of the link to connect.

    • Optional options: ConnectAnalyticsLinkOptions

      Optional parameters for this operation.

    • Optional callback: NodeCallback<void>

      A node-style callback to be invoked after execution.

    Returns Promise<void>

    Deprecated

    Use the other overload instead.

  • connectLink(options?, callback?): Promise<void>

  • Connects a not yet connected link.

    Parameters

    Returns Promise<void>

createDataset

  • createDataset(bucketName, datasetName, options?, callback?): 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.

    • Optional options: CreateAnalyticsDatasetOptions

      Optional parameters for this operation.

    • Optional callback: NodeCallback<void>

      A node-style callback to be invoked after execution.

    Returns Promise<void>

createDataverse

  • createDataverse(dataverseName, options?, callback?): Promise<void>

  • Creates a new dataverse.

    Parameters

    • dataverseName: string

      The name of the dataverse to create.

    • Optional options: CreateAnalyticsDataverseOptions

      Optional parameters for this operation.

    • Optional callback: NodeCallback<void>

      A node-style callback to be invoked after execution.

    Returns Promise<void>

createIndex

  • createIndex(datasetName, indexName, fields, options?, callback?): 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.

      • [key: string]: string
    • Optional options: CreateAnalyticsIndexOptions

      Optional parameters for this operation.

    • Optional callback: NodeCallback<void>

      A node-style callback to be invoked after execution.

    Returns Promise<void>

createLink

  • createLink(link, options?, callback?): Promise<void>

  • Creates a new analytics remote link.

    Parameters

    Returns Promise<void>

disconnectLink

  • disconnectLink(linkStr, options?, callback?): Promise<void>

  • Disconnects a previously connected link.

    Parameters

    • linkStr: string

      The name of the link to disconnect.

    • Optional options: DisconnectAnalyticsLinkOptions

      Optional parameters for this operation.

    • Optional callback: NodeCallback<void>

      A node-style callback to be invoked after execution.

    Returns Promise<void>

    Deprecated

    Use the other overload instead.

  • disconnectLink(options?, callback?): Promise<void>

  • Disconnects a previously connected link.

    Parameters

    Returns Promise<void>

dropDataset

  • dropDataset(datasetName, options?, callback?): Promise<void>

  • Drops a previously created dataset.

    Parameters

    • datasetName: string

      The name of the dataset to drop.

    • Optional options: DropAnalyticsDatasetOptions

      Optional parameters for this operation.

    • Optional callback: NodeCallback<void>

      A node-style callback to be invoked after execution.

    Returns Promise<void>

dropDataverse

  • dropDataverse(dataverseName, options?, callback?): Promise<void>

  • Drops a previously created dataverse.

    Parameters

    • dataverseName: string

      The name of the dataverse to drop.

    • Optional options: DropAnalyticsDataverseOptions

      Optional parameters for this operation.

    • Optional callback: NodeCallback<void>

      A node-style callback to be invoked after execution.

    Returns Promise<void>

dropIndex

  • dropIndex(datasetName, indexName, options?, callback?): 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.

    • Optional options: DropAnalyticsIndexOptions

      Optional parameters for this operation.

    • Optional callback: NodeCallback<void>

      A node-style callback to be invoked after execution.

    Returns Promise<void>

dropLink

  • dropLink(linkName, dataverseName, options?, callback?): 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.

    • Optional options: DropAnalyticsLinkOptions

      Optional parameters for this operation.

    • Optional callback: NodeCallback<void>

      A node-style callback to be invoked after execution.

    Returns Promise<void>

getAllDatasets

getAllIndexes

getAllLinks

getPendingMutations

  • getPendingMutations(options?, callback?): Promise<{
        [k: string]: {
            [k: string]: number;
        };
    }>

  • Returns a list of all pending mutations.

    Parameters

    • Optional options: GetPendingAnalyticsMutationsOptions

      Optional parameters for this operation.

    • Optional callback: NodeCallback<{
          [k: string]: {
              [k: string]: number;
          };
      }>

      A node-style callback to be invoked after execution.

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

replaceLink

  • replaceLink(link, options?, callback?): Promise<void>

  • Replaces an existing analytics remote link.

    Parameters

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

connectLinkcreateDatasetcreateDataversecreateIndexcreateLinkdisconnectLinkdropDatasetdropDataversedropIndexdropLinkgetAllDatasetsgetAllIndexesgetAllLinksgetPendingMutationsreplaceLink