Class Cluster

Exposes the operations which are available to be performed against a cluster. Namely the ability to access to Buckets as well as performing management operations against the cluster.

Hierarchy

  • Cluster

Methods

  • Creates a Bucket object reference to a specific bucket.

    Parameters

    • bucketName: string

      The name of the bucket to reference.

    Returns Bucket

  • Returns a BucketManager which can be used to manage the buckets of this cluster.

    Returns BucketManager

  • Shuts down this cluster object. Cleaning up all resources associated with it.

    Parameters

    • Optional callback: NodeCallback<void>

      A node-style callback to be invoked after execution.

    Returns Promise<void>

  • Returns a diagnostics report about the currently active connections with the cluster. Includes information about remote and local addresses, last activity, and other diagnostics information.

    Parameters

    Returns Promise<DiagnosticsResult>

  • Returns a EventingFunctionManager which can be used to manage the eventing functions of this cluster. Volatile: This API is subject to change at any time.

    Returns EventingFunctionManager

  • Performs a ping operation against the cluster. Pinging the services which are specified (or all services if none are specified). Returns a report which describes the outcome of the ping operations which were performed.

    Parameters

    • Optional options: PingOptions

      Optional parameters for this operation.

    • Optional callback: NodeCallback<PingResult>

      A node-style callback to be invoked after execution.

    Returns Promise<PingResult>

  • Returns a QueryIndexManager which can be used to manage the query indexes of this cluster.

    Returns QueryIndexManager

  • Returns a SearchIndexManager which can be used to manage the search indexes of this cluster.

    Returns SearchIndexManager

  • Returns a Transactions object which can be used to perform transactions on this cluster.

    Returns Transactions

  • Returns a UserManager which can be used to manage the users of this cluster.

    Returns UserManager

Generated using TypeDoc