Package com.couchbase.client.java
Class Scope
- java.lang.Object
-
- com.couchbase.client.java.Scope
-
public class Scope 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 Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AnalyticsResultanalyticsQuery(String statement)Performs an Analytics query with defaultAnalyticsOptionson a scopeAnalyticsResultanalyticsQuery(String statement, AnalyticsOptions options)Performs an Analytics query with customAnalyticsOptionson a scopeAsyncScopeasync()Returns the underlying async scope.StringbucketName()The name of the bucket this scope is attached to.Collectioncollection(String collectionName)Opens a collection for this scope with an explicit name.Corecore()Provides access to the underlyingCore.ClusterEnvironmentenvironment()Provides access to the configuredClusterEnvironmentfor this scope.Stringname()The name of the scope.QueryResultquery(String statement)Performs a N1QL query with defaultQueryOptionsin a ScopeQueryResultquery(String statement, QueryOptions options)Performs a N1QL query with customQueryOptionsin a ScopeReactiveScopereactive()Provides access to the relatedReactiveScope.
-
-
-
Method Detail
-
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.
-
reactive
public ReactiveScope reactive()
Provides access to the relatedReactiveScope.
-
core
@Volatile public Core core()
Provides access to the underlyingCore.This is advanced API, use with care!
-
environment
public ClusterEnvironment environment()
Provides access to the configuredClusterEnvironmentfor this scope.
-
collection
public Collection 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
public QueryResult query(String statement)
Performs a N1QL query with defaultQueryOptionsin a Scope- Parameters:
statement- the N1QL query statement.- Returns:
- the
QueryResultonce the response arrives successfully. - Throws:
TimeoutException- if the operation times out before getting a result.CouchbaseException- for all other error reasons (acts as a base type and catch-all).
-
query
public QueryResult query(String statement, QueryOptions options)
Performs a N1QL query with customQueryOptionsin a Scope- Parameters:
statement- the N1QL query statement as a raw string.options- the custom options for this query.- Returns:
- the
QueryResultonce the response arrives successfully. - Throws:
TimeoutException- if the operation times out before getting a result.CouchbaseException- for all other error reasons (acts as a base type and catch-all).
-
analyticsQuery
public AnalyticsResult analyticsQuery(String statement)
Performs an Analytics query with defaultAnalyticsOptionson a scope- Parameters:
statement- the Analytics query statement as a raw string.- Returns:
- the
AnalyticsResultonce the response arrives successfully. - Throws:
TimeoutException- if the operation times out before getting a result.CouchbaseException- for all other error reasons (acts as a base type and catch-all).
-
analyticsQuery
public AnalyticsResult analyticsQuery(String statement, AnalyticsOptions options)
Performs an Analytics query with customAnalyticsOptionson a scope- Parameters:
statement- the Analytics query statement as a raw string.options- the custom options for this query.- Returns:
- the
AnalyticsResultonce the response arrives successfully. - Throws:
TimeoutException- if the operation times out before getting a result.CouchbaseException- for all other error reasons (acts as a base type and catch-all).
-
-