Package com.couchbase.client.java

Class ReactiveScope

java.lang.Object
com.couchbase.client.java.ReactiveScope
public class ReactiveScope
extends Object
The scope identifies a group of collections and allows high application density as a result.

If no scope is explicitly provided, the default scope is used.

Since:
3.0.0

  • Method Details

    • name

      public String name()
      The name of the scope.
      Returns:
      the name of the scope.

    • bucketName

      public String bucketName()
      The name of the bucket this scope is attached to.

    • async

      public AsyncScope async()
      Returns the underlying async scope.

    • core

      @Volatile public Core core()
      Provides access to the underlying Core.

      This is advanced API, use with care!

    • environment

      public ClusterEnvironment environment()
      Provides access to the configured ClusterEnvironment for this scope.

    • collection

      @Volatile public ReactiveCollection collection​(String collectionName)
      Opens a collection for this scope with an explicit name.
      Parameters:
      collectionName - the collection name.
      Returns:
      the requested collection if successful.

    • query

      @Volatile public reactor.core.publisher.Mono<ReactiveQueryResult> query​(String statement)
      Performs a N1QL query with default QueryOptions in a Scope
      Parameters:
      statement - the N1QL query statement as a raw string.
      Returns:
      the ReactiveQueryResult once the response arrives successfully.

    • query

      @Volatile public reactor.core.publisher.Mono<ReactiveQueryResult> query​(String statement, QueryOptions options)
      Performs a N1QL query with custom QueryOptions in a Scope
      Parameters:
      statement - the N1QL query statement as a raw string.
      options - the custom options for this query.
      Returns:
      the ReactiveQueryResult once the response arrives successfully.

    • analyticsQuery

      @Volatile public reactor.core.publisher.Mono<ReactiveAnalyticsResult> analyticsQuery​(String statement)
      Performs an Analytics query with default AnalyticsOptions on a scope
      Parameters:
      statement - the Analytics query statement as a raw string.
      Returns:
      the ReactiveAnalyticsResult once the response arrives successfully.

    • analyticsQuery

      @Volatile public reactor.core.publisher.Mono<ReactiveAnalyticsResult> analyticsQuery​(String statement, AnalyticsOptions options)
      Performs an Analytics query with custom AnalyticsOptions on a scope
      Parameters:
      statement - the Analytics query statement as a raw string.
      options - the custom options for this analytics query.
      Returns:
      the ReactiveAnalyticsResult once the response arrives successfully.