Packages

class ReactiveScope extends AnyRef

Represents a Couchbase scope resource.

This is a reactive version of the Scope interface.

Applications should not create these manually, but instead first open a Cluster and through that a Bucket.

Since

1.0.0

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

Instance Constructors

  1. new ReactiveScope(async: AsyncScope, bucketName: String)

    bucketName

    the name of the bucket this scope is on

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. def analyticsQuery(statement: String, options: AnalyticsOptions = AnalyticsOptions.Default): SMono[ReactiveAnalyticsResult]

    Performs an Analytics query against the cluster.

    Performs an Analytics query against the cluster.

    This is a blocking API. See Scope.async for an Future-based async version of this API, and Scope.reactive for a reactive version. The reactive version includes backpressure-aware row streaming.

    The reason to use this Scope-based variant over ReactiveCluster.analyticsQuery is that it will automatically provide the "query_context" parameter to the query service, allowing queries to be performed on collections without having to fully specify their bucket and scope names in the query statement.

    statement

    the Analytics query to execute

    options

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

    returns

    a ReactiveAnalyticsResult

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. val bucketName: String
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  8. def collection(collectionName: String): ReactiveCollection

    Opens and returns a Couchbase collection resource, that exists on this scope.

  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. def name: String

    The name of this scope.

  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  18. def query(statement: String, options: QueryOptions = QueryOptions()): SMono[ReactiveQueryResult]

    Performs a N1QL query against the cluster.

    Performs a N1QL query against the cluster.

    This is a reactive API. See Scope.async for an Future-based async version of this API, and Scope for a blocking version.

    The reason to use this Scope-based variant over ReactiveCluster.query is that it will automatically provide the "query_context" parameter to the query service, allowing queries to be specified on scopes and collections without having to fully reference them in the query statement.

    statement

    the N1QL statement to execute

    options

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

    returns

    a ReactiveQueryResult

  19. def search(indexName: String, request: SearchRequest, options: SearchOptions): SMono[ReactiveSearchResult]

    Performs a Full Text Search (FTS) query.

    Performs a Full Text Search (FTS) query.

    This can be used to perform a traditional FTS query, and/or a vector search.

    Use this to access scoped FTS indexes, and Cluster.search for global indexes.

    indexName

    the name of the search index to use

    request

    the request to send to the FTS service.

    options

    see com.couchbase.client.scala.search.SearchOptions

    returns

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

    Annotations
    @SinceCouchbase()
  20. def search(indexName: String, request: SearchRequest): SMono[ReactiveSearchResult]

    Performs a Full Text Search (FTS) query.

    Performs a Full Text Search (FTS) query.

    This can be used to perform a traditional FTS query, and/or a vector search.

    Use this to access scoped FTS indexes, and Cluster.search for global indexes.

    indexName

    the name of the search index to use

    request

    the request to send to the FTS service.

    returns

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

    Annotations
    @SinceCouchbase()
  21. lazy val searchIndexes: ReactiveScopeSearchIndexManager

    Allows managing scoped FTS indexes.

    Allows managing scoped FTS indexes.

    Annotations
    @SinceCouchbase()
  22. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  23. def toString(): String
    Definition Classes
    AnyRef → Any
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

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

Inherited from AnyRef

Inherited from Any

Ungrouped