com.couchbase.client.java

Class AsyncScope

java.lang.Object

com.couchbase.client.java.AsyncScope

public class AsyncScope
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
String	bucketName() The name of the bucket this scope is attached to.
AsyncCollection	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.

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.

bucketName

public String bucketName()

The name of the bucket this scope is attached to.

core

@Stability.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

@Stability.Volatile
public AsyncCollection collection(String collectionName)

Opens a collection for this scope with an explicit name.

Parameters:

collectionName - the collection name.

Returns:

the requested collection if successful.