Packages

class Bucket extends AnyRef

Represents a Couchbase bucket resource.

Applications should not create these manually, but instead use the functions in Cluster.

Since

1.0.0

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Bucket
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. val async: AsyncBucket
  2. def collection(collectionName: String): Collection

    Opens a Couchbase collection resource on the default scope.

    Opens a Couchbase collection resource on the default scope.

    collectionName

    the name of the collection

    returns

    a created collection resource

    Annotations
    @Volatile()
  3. lazy val collections: CollectionManager
    Annotations
    @Volatile()
  4. def defaultCollection: Collection

    Returns the Couchbase default collection resource.

  5. def defaultScope: Scope

    Opens and returns the default Couchbase scope.

    Opens and returns the default Couchbase scope.

    Annotations
    @Volatile()
  6. def name: String

    Returns the name of this bucket.

  7. def ping(options: PingOptions): Try[PingResult]

    Performs application-level ping requests with custom options against services in the Couchbase cluster.

    Performs application-level ping requests with custom options against services in the Couchbase cluster.

    Note that this operation performs active I/O against services and endpoints to assess their health. If you do not wish to perform I/O, consider using .diagnostics() instead.

    options

    options to customize the ping

    returns

    the PingResult once complete.

  8. def ping(timeout: Option[Duration] = None): Try[PingResult]

    Performs application-level ping requests with custom options against services in the Couchbase cluster.

    Performs application-level ping requests with custom options against services in the Couchbase cluster.

    Note that this operation performs active I/O against services and endpoints to assess their health. If you do not wish to perform I/O, consider using .diagnostics() instead.

    This overload provides only the most commonly used options. If you need to configure something more esoteric, use the overload that takes a com.couchbase.client.scala.diagnostics.PingOptions instead, which supports all available options.

    timeout

    the timeout to use for the operation

    returns

    the PingResult once complete.

  9. lazy val reactive: ReactiveBucket

    Provides a reactive version of this API.

  10. def scope(scopeName: String): Scope

    Opens and returns a Couchbase scope resource.

    Opens and returns a Couchbase scope resource.

    scopeName

    the name of the scope

    Annotations
    @Volatile()
  11. lazy val viewIndexes: ViewIndexManager
    Annotations
    @Volatile()
  12. def viewQuery(designDoc: String, viewName: String, timeout: Duration = ...): Try[ViewResult]

    Performs a view query against the cluster.

    Performs a view query against the cluster.

    This is synchronous (blocking). See Bucket.reactive for a reactive streaming version of this API, and Bucket.async for an async version.

    This overload provides only the most commonly used options. If you need to configure something more esoteric, use the overload that takes a com.couchbase.client.scala.view.ViewOptions instead, which supports all available options.

    designDoc

    the view design document to use

    viewName

    the view to use

    timeout

    how long the operation is allowed to take

    returns

    a Try containing a Success(ViewResult) (which includes any returned rows) if successful, else a Failure

  13. def viewQuery(designDoc: String, viewName: String, options: ViewOptions): Try[ViewResult]

    Performs a view query against the cluster.

    Performs a view query against the cluster.

    This is synchronous (blocking). See Bucket.reactive for a reactive streaming version of this API, and Bucket.async for an async version.

    designDoc

    the view design document to use

    viewName

    the view to use

    options

    any view query options - see com.couchbase.client.scala.view.ViewOptions for documentation

    returns

    a Try containing a Success(ViewResult) (which includes any returned rows) if successful, else a Failure

  14. def waitUntilReady(timeout: Duration, options: WaitUntilReadyOptions): Try[Unit]

    Waits until the desired ClusterState is reached.

    Waits until the desired ClusterState is reached.

    This method will wait until either the cluster state is "online", or the timeout is reached. Since the SDK is bootstrapping lazily, this method allows to eagerly check during bootstrap if all of the services are online and usable before moving on.

    timeout

    the maximum time to wait until readiness.

    options

    options to customize the wait

  15. def waitUntilReady(timeout: Duration): Try[Unit]

    Waits until the desired ClusterState is reached.

    Waits until the desired ClusterState is reached.

    This method will wait until either the cluster state is "online", or the timeout is reached. Since the SDK is bootstrapping lazily, this method allows to eagerly check during bootstrap if all of the services are online and usable before moving on.

    This overload provides only the most commonly used options. If you need to configure something more esoteric, use the overload that takes a com.couchbase.client.scala.diagnostics.WaitUntilReadyOptions instead, which supports all available options.

    timeout

    the maximum time to wait until readiness.