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

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.
com.couchbase.client.core.Core	core() Provides access to the underlying Core.
ClusterEnvironment	environment() Provides access to the configured ClusterEnvironment for this scope.
ScopeEventingFunctionManager	eventingFunctions() Provides access to the eventing function management services for functions in 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.
SearchResult	search(String indexName, SearchRequest searchRequest) Performs a request against the Full Text Search (FTS) service, with default SearchOptions.
SearchResult	search(String indexName, SearchRequest searchRequest, SearchOptions options) Performs a request against the Full Text Search (FTS) service, with custom SearchOptions.
ScopeSearchIndexManager	searchIndexes() Allows management of scope FTS indexes.
SearchResult	searchQuery(String indexName, SearchQuery query) Performs a Full Text Search (FTS) query with default SearchOptions.
SearchResult	searchQuery(String indexName, SearchQuery query, SearchOptions options) Performs a Full Text Search (FTS) query with custom SearchOptions.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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 related ReactiveScope.

core

@Stability.Volatile
public com.couchbase.client.core.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

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 default QueryOptions in a Scope

Parameters:

statement - the N1QL query statement.

Returns:

the QueryResult once the response arrives successfully.

Throws:

com.couchbase.client.core.error.TimeoutException - if the operation times out before getting a result.

com.couchbase.client.core.error.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 custom QueryOptions in a Scope

Parameters:

statement - the N1QL query statement as a raw string.

options - the custom options for this query.

Returns:

the QueryResult once the response arrives successfully.

Throws:

com.couchbase.client.core.error.TimeoutException - if the operation times out before getting a result.

com.couchbase.client.core.error.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 default AnalyticsOptions on a scope

Parameters:

statement - the Analytics query statement as a raw string.

Returns:

the AnalyticsResult once the response arrives successfully.

Throws:

com.couchbase.client.core.error.TimeoutException - if the operation times out before getting a result.

com.couchbase.client.core.error.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 custom AnalyticsOptions on a scope

Parameters:

statement - the Analytics query statement as a raw string.

options - the custom options for this query.

Returns:

the AnalyticsResult once the response arrives successfully.

Throws:

com.couchbase.client.core.error.TimeoutException - if the operation times out before getting a result.

com.couchbase.client.core.error.CouchbaseException - for all other error reasons (acts as a base type and catch-all).

search

@Stability.Uncommitted
 @SinceCouchbase(value="7.6")
public SearchResult search(String indexName,
                                                                                SearchRequest searchRequest)

Performs a request against the Full Text Search (FTS) service, with default SearchOptions.

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

This method is for scoped FTS indexes. For global indexes, use Cluster instead.

Parameters:

searchRequest - the request, in the form of a SearchRequest

Returns:

the SearchResult once the response arrives successfully.

Throws:

com.couchbase.client.core.error.TimeoutException - if the operation times out before getting a result.

com.couchbase.client.core.error.CouchbaseException - for all other error reasons (acts as a base type and catch-all).

search

@Stability.Uncommitted
 @SinceCouchbase(value="7.6")
public SearchResult search(String indexName,
                                                                                SearchRequest searchRequest,
                                                                                SearchOptions options)

Performs a request against the Full Text Search (FTS) service, with custom SearchOptions.

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

This method is for scoped FTS indexes. For global indexes, use Cluster instead.

Parameters:

searchRequest - the request, in the form of a SearchRequest

Returns:

the SearchResult once the response arrives successfully.

Throws:

com.couchbase.client.core.error.TimeoutException - if the operation times out before getting a result.

com.couchbase.client.core.error.CouchbaseException - for all other error reasons (acts as a base type and catch-all).

searchQuery

public SearchResult searchQuery(String indexName,
                                SearchQuery query)

Performs a Full Text Search (FTS) query with default SearchOptions.

This method is for scoped FTS indexes. For global indexes, use Cluster instead.

New users should consider the newer search(String, SearchRequest) interface instead, which can do both the traditional FTS SearchQuery that this method performs, and/or can also be used to perform a VectorSearch.

Parameters:

query - the query, in the form of a SearchQuery

Returns:

the SearchResult once the response arrives successfully.

Throws:

com.couchbase.client.core.error.TimeoutException - if the operation times out before getting a result.

com.couchbase.client.core.error.CouchbaseException - for all other error reasons (acts as a base type and catch-all).

searchQuery

public SearchResult searchQuery(String indexName,
                                SearchQuery query,
                                SearchOptions options)

Performs a Full Text Search (FTS) query with custom SearchOptions.

This method is for scoped FTS indexes. For global indexes, use Cluster instead.

New users should consider the newer search(String, SearchRequest) interface instead, which can do both the traditional FTS SearchQuery that this method performs, and/or can also be used to perform a VectorSearch.

Parameters:

query - the query, in the form of a SearchQuery

options - the custom options for this query.

Returns:

the SearchResult once the response arrives successfully.

Throws:

com.couchbase.client.core.error.TimeoutException - if the operation times out before getting a result.

com.couchbase.client.core.error.CouchbaseException - for all other error reasons (acts as a base type and catch-all).

searchIndexes

@SinceCouchbase(value="7.6")
public ScopeSearchIndexManager searchIndexes()

Allows management of scope FTS indexes.

eventingFunctions

@Stability.Volatile
 @SinceCouchbase(value="7.1")
public ScopeEventingFunctionManager eventingFunctions()

Provides access to the eventing function management services for functions in this scope.