Packages

class Cluster extends AnyRef

Represents a connection to a Couchbase cluster.

These can be created through the functions in the companion object.

Since

1.0.0

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

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. lazy val analyticsIndexes: AnalyticsIndexManager
    Annotations
    @Volatile()
  5. def analyticsQuery(statement: String, parameters: AnalyticsParameters = AnalyticsParameters.None, timeout: Duration = _env.timeoutConfig.queryTimeout()): Try[AnalyticsResult]

    Performs an Analytics query against the cluster.

    Performs an Analytics query against the cluster.

    This is blocking. See Cluster.reactive for a reactive streaming version of this API, and Cluster.async for an asynchronous 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.analytics.AnalyticsOptions instead, which supports all available options.

    statement

    the Analytics query to execute

    parameters

    provides named or positional parameters for queries parameterised that way.

    timeout

    sets a maximum timeout for processing.

    returns

    a Future containing a Success(AnalyticsResult) (which includes any returned rows) if successful, else a Failure

  6. def analyticsQuery(statement: String, options: AnalyticsOptions): Try[AnalyticsResult]

    Performs an Analytics query against the cluster.

    Performs an Analytics query against the cluster.

    This is blocking. See Cluster.reactive for a reactive streaming version of this API, and Cluster.async for an asynchronous version.

    statement

    the Analytics query to execute

    options

    any query options - see com.couchbase.client.scala.analytics.AnalyticsOptions for documentation

    returns

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

  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. val async: AsyncCluster

    Access an asynchronous version of this API.

  9. def bucket(bucketName: String): Bucket

    Opens and returns a Couchbase bucket resource that exists on this cluster.

    Opens and returns a Couchbase bucket resource that exists on this cluster.

    bucketName

    the name of the bucket to open

  10. lazy val buckets: BucketManager

    The BucketManager provides access to creating and getting buckets.

    The BucketManager provides access to creating and getting buckets.

    Annotations
    @Volatile()
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  12. def diagnostics(options: DiagnosticsOptions): Try[DiagnosticsResult]

    Returns a DiagnosticsResult, reflecting the SDK's current view of all its existing connections to the cluster.

    Returns a DiagnosticsResult, reflecting the SDK's current view of all its existing connections to the cluster.

    options

    options to customize the report generation

    returns

    a DiagnosticsResult

  13. def diagnostics(reportId: String = UUID.randomUUID.toString): Try[DiagnosticsResult]

    Returns a DiagnosticsResult, reflecting the SDK's current view of all its existing connections to the cluster.

    Returns a DiagnosticsResult, reflecting the SDK's current view of all its existing connections to the cluster.

    reportId

    this will be returned in the DiagnosticsResult. If not specified it defaults to a UUID.

    returns

    a DiagnosticsResult

  14. def disconnect(timeout: Duration = ...): Unit

    Shutdown all cluster resources.

    Shutdown all cluster resources.

    This should be called before application exit.

    timeout

    how long the disconnect is allowed to take; defaults to disconnectTimeout on the environment

  15. def env: ClusterEnvironment

    The environment used to create this cluster

  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  18. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  24. 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.

  25. 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.

  26. def query(statement: String, parameters: QueryParameters = QueryParameters.None, timeout: Duration = _env.timeoutConfig.queryTimeout(), adhoc: Boolean = true): Try[QueryResult]

    Performs a N1QL query against the cluster.

    Performs a N1QL query against the cluster.

    This is blocking. See Cluster.reactive for a reactive streaming version of this API, and Cluster.async for an asynchronous 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.query.QueryOptions instead, which supports all available options.

    statement

    the N1QL statement to execute

    parameters

    provides named or positional parameters for queries parameterised that way.

    timeout

    sets a maximum timeout for processing.

    adhoc

    if true (the default), adhoc mode is enabled: queries are just run. If false, adhoc mode is disabled and transparent prepared statement mode is enabled: queries are first prepared so they can be executed more efficiently in the future.

    returns

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

  27. def query(statement: String, options: QueryOptions): Try[QueryResult]

    Performs a N1QL query against the cluster.

    Performs a N1QL query against the cluster.

    This is blocking. See Cluster.reactive for a reactive streaming version of this API, and Cluster.async for an asynchronous version.

    statement

    the N1QL statement to execute

    options

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

    returns

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

  28. lazy val queryIndexes: QueryIndexManager
    Annotations
    @Volatile()
  29. lazy val reactive: ReactiveCluster

    Access a reactive version of this API.

  30. lazy val searchIndexes: SearchIndexManager
    Annotations
    @Volatile()
  31. def searchQuery(indexName: String, query: SearchQuery, timeout: Duration = ...): Try[SearchResult]

    Performs a Full Text Search (FTS) query against the cluster.

    Performs a Full Text Search (FTS) query against the cluster.

    This is blocking. See Cluster.reactive for a reactive streaming version of this API, and Cluster.async for an asynchronous 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.search.SearchOptions instead, which supports all available options.

    indexName

    the name of the search index to use

    query

    the FTS query to execute. See com.couchbase.client.scala.search.queries.SearchQuery for more

    timeout

    how long the operation is allowed to take

    returns

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

  32. def searchQuery(indexName: String, query: SearchQuery, options: SearchOptions): Try[SearchResult]

    Performs a Full Text Search (FTS) query against the cluster.

    Performs a Full Text Search (FTS) query against the cluster.

    This is blocking. See Cluster.reactive for a reactive streaming version of this API, and Cluster.async for an asynchronous version.

    indexName

    the name of the search index to use

    query

    the FTS query to execute. See com.couchbase.client.scala.search.queries.SearchQuery for more

    options

    the FTS query to execute. See com.couchbase.client.scala.search.SearchOptions for how to construct

    returns

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

  33. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  34. def toString(): String
    Definition Classes
    AnyRef → Any
  35. lazy val users: UserManager

    The UserManager provides programmatic access to and creation of users and groups.

    The UserManager provides programmatic access to and creation of users and groups.

    Annotations
    @Volatile()
  36. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  38. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  39. 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

  40. 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.

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from AnyRef

Inherited from Any

Ungrouped