Class Bucket
-
Method Summary
Modifier and TypeMethodDescriptionasync()
Provides access to the underlyingAsyncBucket
.collection
(String collectionName) Provides access to the collection with the given name for thisBucket
using the default scope.core()
Provides access to the underlyingCore
.Opens the default collection for thisBucket
using the default scope.Opens the defaultScope
.Returns the attachedClusterEnvironment
.name()
Returns the name of theBucket
.ping()
Performs application-level ping requests against services in the couchbase cluster.ping
(PingOptions options) Performs application-level ping requests with custom options against services in the couchbase cluster.reactive()
Provides access to the relatedReactiveBucket
.Opens theScope
with the given name.Queries a view on the bucket.viewQuery
(String designDoc, String viewName, ViewOptions options) Queries a view on the bucket with custom options.void
waitUntilReady
(Duration timeout) Waits until the desiredClusterState
is reached.void
waitUntilReady
(Duration timeout, WaitUntilReadyOptions options) Waits until the desiredClusterState
is reached.
-
Method Details
-
async
Provides access to the underlyingAsyncBucket
. -
reactive
Provides access to the relatedReactiveBucket
. -
name
Returns the name of theBucket
. -
environment
Returns the attachedClusterEnvironment
. -
collections
-
viewIndexes
-
core
Provides access to the underlyingCore
.This is advanced API, use with care!
-
scope
Opens theScope
with the given name.- Parameters:
name
- the name of the scope.- Returns:
- the
Scope
once opened.
-
defaultScope
Opens the defaultScope
.- Returns:
- the
Scope
once opened.
-
defaultCollection
Opens the default collection for thisBucket
using the default scope.This method does not block and the client will try to establish all needed resources in the background. If you need to eagerly await until all resources are established before performing an operation, use the
waitUntilReady(Duration)
method on theBucket
.- Returns:
- the opened default
Collection
.
-
collection
Provides access to the collection with the given name for thisBucket
using the default scope.This method does not block and the client will try to establish all needed resources in the background. If you need to eagerly await until all resources are established before performing an operation, use the
waitUntilReady(Duration)
method on theBucket
.- Returns:
- the opened named
Collection
.
-
viewQuery
Queries a view on the bucket.- Parameters:
designDoc
- the name of the design document in which the view resides.viewName
- the name of the view to query.- Returns:
- a
ViewResult
once completed. - Throws:
ViewNotFoundException
- if the view or design document is not found on the server.TimeoutException
- if the operation times out before getting a result.CouchbaseException
- for all other error reasons (acts as a base type and catch-all).
-
viewQuery
Queries a view on the bucket with custom options.- Parameters:
designDoc
- the name of the design document in which the view resides.viewName
- the name of the view to query.options
- allows to customize view options.- Returns:
- a
ViewResult
once completed. - Throws:
ViewNotFoundException
- if the view or design document is not found on the server.TimeoutException
- if the operation times out before getting a result.CouchbaseException
- for all other error reasons (acts as a base type and catch-all).
-
ping
Performs application-level ping requests against services in the couchbase cluster.- Returns:
- the
PingResult
once complete.
-
ping
Performs application-level ping requests with custom options against services in the couchbase cluster.- Returns:
- the
PingResult
once complete.
-
waitUntilReady
Waits until the desiredClusterState
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.
- Parameters:
timeout
- the maximum time to wait until readiness.
-
waitUntilReady
Waits until the desiredClusterState
is reached.This method will wait until either the cluster state is "online" by default, 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. You can tune the properties through
WaitUntilReadyOptions
.- Parameters:
timeout
- the maximum time to wait until readiness.options
- the options to customize the readiness waiting.
-