Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Bucket

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

Hierarchy

  • Bucket

Index

Accessors

name

  • get name(): string
  • The name of the bucket this Bucket object references.

    Returns string

Methods

collection

  • Creates a Collection object reference to a specific collection.

    Parameters

    • collectionName: string

      The name of the collection to reference.

    Returns Collection

collections

  • Returns a CollectionManager which can be used to manage the collections of this bucket.

    Returns CollectionManager

defaultCollection

  • Creates a Collection object reference to the default collection.

    Returns Collection

defaultScope

  • Creates a Scope object reference to the default scope.

    Returns Scope

ping

  • Performs a ping operation against the cluster. Pinging the bucket 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>

scope

  • scope(scopeName: string): Scope
  • Creates a Scope object reference to a specific scope.

    Parameters

    • scopeName: string

      The name of the scope to reference.

    Returns Scope

viewIndexes

  • Returns a ViewIndexManager which can be used to manage the view indexes of this bucket.

    Returns ViewIndexManager

viewQuery

  • Executes a view query.

    Type parameters

    • TValue = any

    • TKey = any

    Parameters

    • designDoc: string

      The name of the design document containing the view to execute.

    • viewName: string

      The name of the view to execute.

    • Optional options: ViewQueryOptions

      Optional parameters for this operation.

    • Optional callback: NodeCallback<ViewResult<TValue, TKey>>

      A node-style callback to be invoked after execution.

    Returns StreamableRowPromise<ViewResult<TValue, TKey>, ViewRow<TValue, TKey>, ViewMetaData>

Generated using TypeDoc