com.couchbase.client.java.manager.collection

Class CollectionManager

java.lang.Object

com.couchbase.client.java.manager.collection.CollectionManager

@Stability.Volatile
public class CollectionManager
extends Object

The CollectionManager provides APIs to manage bucket collections and scopes.

Constructor Summary

Constructors

Constructor and Description
CollectionManager(AsyncCollectionManager asyncCollectionManager)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

CollectionManager

public CollectionManager(AsyncCollectionManager asyncCollectionManager)

Method Detail

createCollection

public 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.

Throws:

CollectionExistsException - if the collection already exists

ScopeNotFoundException - if the specified scope does not exist.

createCollection

public 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.

Throws:

CollectionExistsException - if the collection already exists

ScopeNotFoundException - if the specified scope does not exist.

dropCollection

public void dropCollection(CollectionSpec collectionSpec)

Drops a collection if it exists.

Parameters:

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

Throws:

CollectionNotFoundException - if the collection did not exist.

ScopeNotFoundException - if the specified scope does not exist.

dropCollection

public void dropCollection(CollectionSpec collectionSpec,
                           DropCollectionOptions options)

Drops a collection if it exists.

Parameters:

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

Throws:

CollectionNotFoundException - if the collection did not exist.

ScopeNotFoundException - if the specified scope does not exist.

createScope

public void createScope(String scopeName)

Creates a scope if it does not already exist.

Parameters:

scopeName - the name of the scope to create.

Throws:

ScopeExistsException - if the scope already exists.

createScope

public void createScope(String scopeName,
                        CreateScopeOptions options)

Creates a scope if it does not already exist.

Parameters:

scopeName - the name of the scope to create.

Throws:

ScopeExistsException - if the scope already exists.

dropScope

public void dropScope(String scopeName)

Drops a scope if it exists.

Parameters:

scopeName - the name of the scope to drop.

Throws:

ScopeNotFoundException - if the scope did not exist.

dropScope

public void dropScope(String scopeName,
                      DropScopeOptions options)

Drops a scope if it exists.

Parameters:

scopeName - the name of the scope to drop.

Throws:

ScopeNotFoundException - if the scope did not exist.

getScope

@Deprecated
public ScopeSpec getScope(String scopeName)

Deprecated. use getAllScopes() instead.

Returns the scope if it exists.

Parameters:

scopeName - the name of the scope.

Returns:

information about the requested scope.

Throws:

ScopeNotFoundException - if scope does not exist

getScope

@Deprecated
public ScopeSpec getScope(String scopeName,
                                      GetScopeOptions options)

Deprecated. use getAllScopes(GetAllScopesOptions) instead.

Returns the scope if it exists.

Parameters:

scopeName - the name of the scope.

Returns:

information about the requested scope.

Throws:

ScopeNotFoundException - if scope does not exist

getAllScopes

public List<ScopeSpec> getAllScopes()

Returns all scopes in this bucket.

Returns:

a list of all scopes in this bucket.

getAllScopes

public List<ScopeSpec> getAllScopes(GetAllScopesOptions options)

Returns all scopes in this bucket.

Returns:

a list of all scopes in this bucket.