class ReactiveBucket extends AnyRef
Represents a Couchbase bucket resource.
This is the reactive version of the Bucket API.
Applications should not create these manually, but instead use the functions in Cluster.
- Since
1.0.0
- Alphabetic
- By Inheritance
- ReactiveBucket
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- val async: AsyncBucket
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- def collection(collectionName: String): ReactiveCollection
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
- lazy val collections: ReactiveCollectionManager
- def defaultCollection: ReactiveCollection
Returns the Couchbase default collection resource.
- def defaultScope: ReactiveScope
Opens and returns the default Couchbase scope.
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- def ping(options: PingOptions): SMono[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 the .diagnostics instead.
- options
options to customize the ping
- returns
the
PingResult
once complete.
- def ping(timeout: Option[Duration] = None): SMono[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 the .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.
- def scope(scopeName: String): ReactiveScope
Opens and returns a Couchbase scope resource.
Opens and returns a Couchbase scope resource.
- scopeName
the name of the scope
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- lazy val viewIndexes: ReactiveViewIndexManager
- def viewQuery(designDoc: String, viewName: String, timeout: Duration = async.environment.timeoutConfig.viewTimeout()): SMono[ReactiveViewResult]
Performs a view query against the cluster.
Performs a view query against the cluster.
This is a reactive streaming version of this API. See Bucket for a synchronous blocking version, 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
Mono
containing a view.ViewResult (which includes any returned rows)
- def viewQuery(designDoc: String, viewName: String, options: ViewOptions): SMono[ReactiveViewResult]
Performs a view query against the cluster.
Performs a view query against the cluster.
This is a reactive streaming version of this API. See Bucket for a synchronous blocking version, 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 view.ViewOptions for documentation
- returns
a
Mono
containing a view.ViewResult (which includes any returned rows)
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def waitUntilReady(timeout: Duration, options: WaitUntilReadyOptions): SMono[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
- def waitUntilReady(timeout: Duration): SMono[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.
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)