Packages

class AsyncScope extends AnyRef

Represents a Couchbase scope resource.

This is an asynchronous 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. AsyncScope
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. def analyticsQuery(statement: String, options: AnalyticsOptions = AnalyticsOptions.Default): Future[AnalyticsResult]

    Performs an Analytics query against the cluster.

    Performs an Analytics query against the cluster.

    This is asynchronous. See Cluster.reactive for a reactive streaming version of this API, and Cluster for a blocking version. The reactive version includes backpressure-aware row streaming.

    The reason to use this Scope-based variant over AsyncCluster.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 Future containing a Success(AnalyticsResult) (which includes any returned rows) if successful, else a Failure

  2. def collection(collectionName: String): AsyncCollection

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

  3. def name: String

    The name of this scope.

  4. def query(statement: String, options: QueryOptions = QueryOptions()): Future[QueryResult]

    Performs a N1QL query against the cluster.

    Performs a N1QL query against the cluster.

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

    The reason to use this Scope-based variant over AsyncCluster.query 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 N1QL statement to execute

    options

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

    returns

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