Packages

class AsyncBucket extends AnyRef

Represents a Couchbase bucket resource.

This is the asynchronous version of the Bucket API.

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. AsyncBucket
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. def collection(collectionName: String): AsyncCollection

    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

  2. lazy val collections: AsyncCollectionManager
  3. def defaultCollection: AsyncCollection

    Returns the Couchbase default collection resource.

  4. def defaultScope: AsyncScope

    Opens and returns the default Couchbase scope.

  5. val name: String
  6. def ping(options: PingOptions): Future[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.

  7. def ping(timeout: Option[Duration] = None): Future[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.

  8. val reactive: ReactiveBucket
  9. def scope(scopeName: String): AsyncScope

    Opens and returns a Couchbase scope resource.

    Opens and returns a Couchbase scope resource.

    scopeName

    the name of the scope

  10. lazy val viewIndexes: AsyncViewIndexManager
  11. def viewQuery(designDoc: String, viewName: String, timeout: Duration = ...): Future[ViewResult]

    Performs a view query against the cluster.

    Performs a view query against the cluster.

    This is asynchronous. See Bucket.reactive for a reactive streaming version of this API, and Bucket for a blocking 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 Future containing a Success(ViewResult) (which includes any returned rows) if successful, else a Failure

  12. def viewQuery(designDoc: String, viewName: String, options: ViewOptions): Future[ViewResult]

    Performs a view query against the cluster.

    Performs a view query against the cluster.

    This is asynchronous. See Bucket.reactive for a reactive streaming version of this API, and Bucket for a blocking 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 Future containing a Success(ViewResult) (which includes any returned rows) if successful, else a Failure

  13. def waitUntilReady(timeout: Duration, options: WaitUntilReadyOptions): Future[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

  14. def waitUntilReady(timeout: Duration): Future[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.