com.couchbase.client.java.manager.collection

Class AsyncCollectionManager

java.lang.Object

com.couchbase.client.java.manager.ManagerSupport

com.couchbase.client.java.manager.collection.AsyncCollectionManager

@Stability.Volatile
public class AsyncCollectionManager
extends ManagerSupport

The AsyncCollectionManager provides APIs to manage bucket collections and scopes.

Constructor Summary

Constructors

Constructor and Description
AsyncCollectionManager(Core core, String bucketName)

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Void>	createCollection(CollectionSpec collectionSpec) Creates a collection if it does not already exist.
CompletableFuture<Void>	createCollection(CollectionSpec collectionSpec, CreateCollectionOptions options) Creates a collection if it does not already exist.
CompletableFuture<Void>	createScope(String scopeName) Creates a scope if it does not already exist.
CompletableFuture<Void>	createScope(String scopeName, CreateScopeOptions options) Creates a scope if it does not already exist.
CompletableFuture<Void>	dropCollection(CollectionSpec collectionSpec) Drops a collection if it exists.
CompletableFuture<Void>	dropCollection(CollectionSpec collectionSpec, DropCollectionOptions options) Drops a collection if it exists.
CompletableFuture<Void>	dropScope(String scopeName) Drops a scope if it exists.
CompletableFuture<Void>	dropScope(String scopeName, DropScopeOptions options) Drops a scope if it exists.
CompletableFuture<List<ScopeSpec>>	getAllScopes() Returns all scopes in this bucket.
CompletableFuture<List<ScopeSpec>>	getAllScopes(GetAllScopesOptions options) Returns all scopes in this bucket.
CompletableFuture<ScopeSpec>	getScope(String scopeName) Returns the scope if it exists.
CompletableFuture<ScopeSpec>	getScope(String scopeName, GetScopeOptions options) Returns the scope if it exists.

Methods inherited from class com.couchbase.client.java.manager.ManagerSupport

checkStatus, sendRequest, sendRequest, sendRequest, sendRequest, sendRequest

Methods inherited from class java.lang.Object

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

Constructor Detail

AsyncCollectionManager

public AsyncCollectionManager(Core core,
                              String bucketName)

Method Detail

createCollection

public CompletableFuture<Void> createCollection(CollectionSpec collectionSpec)

Creates a collection if it does not already exist.

Parameters:

collectionSpec - the collection spec that contains the properties of the collection.

Returns:

a CompletableFuture once the collection creation completed.

Throws:

CollectionExistsException - (async) if the collection already exists

ScopeNotFoundException - (async) if the specified scope does not exist.

createCollection

public CompletableFuture<Void> createCollection(CollectionSpec collectionSpec,
                                                CreateCollectionOptions options)

Creates a collection if it does not already exist.

Parameters:

collectionSpec - the collection spec that contains the properties of the collection.

Returns:

a CompletableFuture once the collection creation completed.

Throws:

CollectionExistsException - (async) if the collection already exists

ScopeNotFoundException - (async) if the specified scope does not exist.

createScope

public CompletableFuture<Void> createScope(String scopeName)

Creates a scope if it does not already exist.

Parameters:

scopeName - the name of the scope to create.

Returns:

a CompletableFuture once the scope creation completed.

Throws:

ScopeExistsException - (async) if the scope already exists.

createScope

public CompletableFuture<Void> createScope(String scopeName,
                                           CreateScopeOptions options)

Creates a scope if it does not already exist.

Parameters:

scopeName - the name of the scope to create.

Returns:

a CompletableFuture once the scope creation completed.

Throws:

ScopeExistsException - (async) if the scope already exists.

dropCollection

public CompletableFuture<Void> dropCollection(CollectionSpec collectionSpec)

Drops a collection if it exists.

Parameters:

collectionSpec - the collection spec that contains the properties of the collection.

Returns:

a CompletableFuture once the collection is dropped.

Throws:

CollectionNotFoundException - (async) if the collection did not exist.

ScopeNotFoundException - (async) if the specified scope does not exist.

dropCollection

public CompletableFuture<Void> dropCollection(CollectionSpec collectionSpec,
                                              DropCollectionOptions options)

Drops a collection if it exists.

Parameters:

collectionSpec - the collection spec that contains the properties of the collection.

Returns:

a CompletableFuture once the collection is dropped.

Throws:

CollectionNotFoundException - (async) if the collection did not exist.

ScopeNotFoundException - (async) if the specified scope does not exist.

dropScope

public CompletableFuture<Void> dropScope(String scopeName)

Drops a scope if it exists.

Parameters:

scopeName - the name of the scope to drop.

Returns:

a CompletableFuture once the scope is dropped.

Throws:

ScopeNotFoundException - (async) if the scope did not exist.

dropScope

public CompletableFuture<Void> dropScope(String scopeName,
                                         DropScopeOptions options)

Drops a scope if it exists.

Parameters:

scopeName - the name of the scope to drop.

Returns:

a CompletableFuture once the scope is dropped.

Throws:

ScopeNotFoundException - (async) if the scope did not exist.

getScope

public CompletableFuture<ScopeSpec> getScope(String scopeName)

Returns the scope if it exists.

Parameters:

scopeName - the name of the scope.

Returns:

a CompletableFuture containing information about the scope.

Throws:

ScopeNotFoundException - (async) if scope does not exist.

getScope

public CompletableFuture<ScopeSpec> getScope(String scopeName,
                                             GetScopeOptions options)

Returns the scope if it exists.

Parameters:

scopeName - the name of the scope.

Returns:

a CompletableFuture containing information about the scope.

Throws:

ScopeNotFoundException - (async) if scope does not exist.

getAllScopes

public CompletableFuture<List<ScopeSpec>> getAllScopes()

Returns all scopes in this bucket.

Returns:

a CompletableFuture with a list of scopes in the bucket.

getAllScopes

public CompletableFuture<List<ScopeSpec>> getAllScopes(GetAllScopesOptions options)

Returns all scopes in this bucket.

Returns:

a CompletableFuture with a list of scopes in the bucket.