Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AnalyticsIndexManager

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

Hierarchy

  • AnalyticsIndexManager

Index

Methods

connectLink

  • Connects a not yet connected link.

    Parameters

    • linkName: 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>

createDataset

  • 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

  • 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

  • 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: {}

      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

  • Creates a new analytics remote link.

    Parameters

    Returns Promise<void>

disconnectLink

  • Disconnects a previously connected link.

    Parameters

    • linkName: 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>

dropDataset

  • 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

  • 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

  • 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

  • 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

  • Returns a list of existing analytics remote links.

    Parameters

    Returns Promise<AnalyticsLink[]>

getPendingMutations

  • Returns a list of all pending mutations.

    Parameters

    Returns Promise<{}>

replaceLink

  • Replaces an existing analytics remote link.

    Parameters

    Returns Promise<void>

Generated using TypeDoc