@Stability.Volatile public class Scope extends Object
If no scope is explicitly provided, the default scope is used.
| Modifier and Type | Method and Description |
|---|---|
AnalyticsResult |
analyticsQuery(String statement)
Performs an Analytics query with default
AnalyticsOptions on a scope |
AnalyticsResult |
analyticsQuery(String statement,
AnalyticsOptions options)
Performs an Analytics query with custom
AnalyticsOptions on a scope |
AsyncScope |
async()
Returns the underlying async scope.
|
String |
bucketName()
The name of the bucket this scope is attached to.
|
Collection |
collection(String collectionName)
Opens a collection for this scope with an explicit name.
|
Core |
core()
Provides access to the underlying
Core. |
ClusterEnvironment |
environment()
Provides access to the configured
ClusterEnvironment for this scope. |
String |
name()
The name of the scope.
|
QueryResult |
query(String statement)
Performs a N1QL query with default
QueryOptions in a Scope |
QueryResult |
query(String statement,
QueryOptions options)
Performs a N1QL query with custom
QueryOptions in a Scope |
ReactiveScope |
reactive()
Provides access to the related
ReactiveScope. |
public String name()
public String bucketName()
public AsyncScope async()
public ReactiveScope reactive()
ReactiveScope.@Stability.Volatile public Core core()
Core.
This is advanced API, use with care!
public ClusterEnvironment environment()
ClusterEnvironment for this scope.@Stability.Volatile public Collection collection(String collectionName)
collectionName - the collection name.@Stability.Volatile public QueryResult query(String statement)
QueryOptions in a Scopestatement - the N1QL query statement.QueryResult once the response arrives successfully.TimeoutException - if the operation times out before getting a result.CouchbaseException - for all other error reasons (acts as a base type and catch-all).@Stability.Volatile public QueryResult query(String statement, QueryOptions options)
QueryOptions in a Scopestatement - the N1QL query statement as a raw string.options - the custom options for this query.QueryResult once the response arrives successfully.TimeoutException - if the operation times out before getting a result.CouchbaseException - for all other error reasons (acts as a base type and catch-all).@Stability.Volatile public AnalyticsResult analyticsQuery(String statement)
AnalyticsOptions on a scopestatement - the Analytics query statement as a raw string.AnalyticsResult once the response arrives successfully.TimeoutException - if the operation times out before getting a result.CouchbaseException - for all other error reasons (acts as a base type and catch-all).@Stability.Volatile public AnalyticsResult analyticsQuery(String statement, AnalyticsOptions options)
AnalyticsOptions on a scopestatement - the Analytics query statement as a raw string.options - the custom options for this query.AnalyticsResult once the response arrives successfully.TimeoutException - if the operation times out before getting a result.CouchbaseException - for all other error reasons (acts as a base type and catch-all).Copyright © 2020 Couchbase, Inc.. All rights reserved.