com.couchbase.client.java.manager.collection.CollectionManager Maven / Gradle / Ivy
Show all versions of java-client Show documentation
/*
* Copyright 2019 Couchbase, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.couchbase.client.java.manager.collection;
import com.couchbase.client.core.annotation.Stability;
import com.couchbase.client.core.error.CollectionExistsException;
import com.couchbase.client.core.error.CollectionNotFoundException;
import com.couchbase.client.core.error.CouchbaseException;
import com.couchbase.client.core.error.ScopeExistsException;
import com.couchbase.client.core.error.ScopeNotFoundException;
import com.couchbase.client.java.Bucket;
import java.util.List;
import static com.couchbase.client.java.AsyncUtils.block;
import static com.couchbase.client.java.manager.collection.CreateCollectionOptions.createCollectionOptions;
import static com.couchbase.client.java.manager.collection.CreateCollectionSettings.createCollectionSettings;
import static com.couchbase.client.java.manager.collection.CreateScopeOptions.createScopeOptions;
import static com.couchbase.client.java.manager.collection.DropCollectionOptions.dropCollectionOptions;
import static com.couchbase.client.java.manager.collection.DropScopeOptions.dropScopeOptions;
import static com.couchbase.client.java.manager.collection.GetAllScopesOptions.getAllScopesOptions;
import static com.couchbase.client.java.manager.collection.GetScopeOptions.getScopeOptions;
/**
* The {@link CollectionManager} provides APIs to manage bucket collections and scopes.
*/
@Stability.Volatile
public class CollectionManager {
/**
* The underlying async collection manager.
*/
private final AsyncCollectionManager asyncCollectionManager;
/**
* Creates a new {@link CollectionManager}.
*
* This API is not intended to be called by the user directly, use {@link Bucket#collections()}
* instead.
*
* @param async the underlying async collection manager.
*/
@Stability.Internal
public CollectionManager(final AsyncCollectionManager async) {
this.asyncCollectionManager = async;
}
/**
* Creates a collection if it does not already exist.
*
* Note that a scope needs to be created first (via {@link #createScope(String)}) if it doesn't exist already.
*
* @param collectionSpec the collection spec that contains the properties of the collection.
* @throws CollectionExistsException if the collection already exists
* @throws ScopeNotFoundException if the specified scope does not exist.
* @throws CouchbaseException if any other generic unhandled/unexpected errors.
* @deprecated This method cannot be used to set the collection's "history" property.
* Please use {@link #createCollection(String, String, CreateCollectionSettings)} instead.
*/
@Deprecated
public void createCollection(final CollectionSpec collectionSpec) {
createCollection(collectionSpec, createCollectionOptions());
}
/**
* Creates a collection if it does not already exist with custom options.
*
* Note that a scope needs to be created first (via {@link #createScope(String)}) if it doesn't exist already.
*
* @param collectionSpec the collection spec that contains the properties of the collection.
* @param options the custom options to apply.
* @throws CollectionExistsException if the collection already exists
* @throws ScopeNotFoundException if the specified scope does not exist.
* @throws CouchbaseException if any other generic unhandled/unexpected errors.
*
* @deprecated This method cannot be used to set the collection's "history" property.
* Please use {@link #createCollection(String, String, CreateCollectionSettings, CreateCollectionOptions)} instead.
*/
@Deprecated
public void createCollection(final CollectionSpec collectionSpec, final CreateCollectionOptions options) {
block(asyncCollectionManager.createCollection(collectionSpec, options));
}
/**
* Creates a collection if it does not already exist.
*
* Note that a scope needs to be created first (via {@link #createScope(String)}) if it doesn't exist already.
*
* @param scopeName the scope name
* @param collectionName the collection name
* @throws CollectionExistsException if the collection already exists
* @throws ScopeNotFoundException if the specified scope does not exist.
* @throws CouchbaseException if any other generic unhandled/unexpected errors.
*/
@Stability.Volatile
public void createCollection(final String scopeName, final String collectionName) {
createCollection(scopeName, collectionName, createCollectionSettings(), createCollectionOptions());
}
/**
* Creates a collection if it does not already exist with custom options.
*
* Note that a scope needs to be created first (via {@link #createScope(String)}) if it doesn't exist already.
*
* @param scopeName the scope name to create the collection in
* @param collectionName the collection name
* @param settings the collection settings
* @throws CollectionExistsException if the collection already exists
* @throws ScopeNotFoundException if the specified scope does not exist.
* @throws CouchbaseException if any other generic unhandled/unexpected errors.
*/
@Stability.Volatile
public void createCollection(final String scopeName, final String collectionName, final CreateCollectionSettings settings) {
block(asyncCollectionManager.createCollection(scopeName, collectionName, settings));
}
/**
* Creates a collection if it does not already exist with custom options.
*
* Note that a scope needs to be created first (via {@link #createScope(String)}) if it doesn't exist already.
*
* @param scopeName the scope name to create the collection in
* @param collectionName the collection name
* @param settings the collection settings
* @param options the custom options to apply.
* @throws CollectionExistsException if the collection already exists
* @throws ScopeNotFoundException if the specified scope does not exist.
* @throws CouchbaseException if any other generic unhandled/unexpected errors.
*/
@Stability.Volatile
public void createCollection(final String scopeName, final String collectionName, final CreateCollectionSettings settings, final CreateCollectionOptions options) {
block(asyncCollectionManager.createCollection(scopeName, collectionName, settings, options));
}
/**
* Creates a scope if it does not already exist.
*
* @param scopeName the name of the scope to create.
* @throws ScopeExistsException if the scope already exists.
* @throws CouchbaseException if any other generic unhandled/unexpected errors.
*/
public void createScope(final String scopeName) {
createScope(scopeName, createScopeOptions());
}
/**
* Creates a scope if it does not already exist with custom options.
*
* @param scopeName the name of the scope to create.
* @param options the custom options to apply.
* @throws ScopeExistsException if the scope already exists.
* @throws CouchbaseException if any other generic unhandled/unexpected errors.
*/
public void createScope(final String scopeName, final CreateScopeOptions options) {
block(asyncCollectionManager.createScope(scopeName, options));
}
/**
* Updates a collection with custom options.
*
* @param scopeName name of scope to update collection in
* @param collectionName name of collection to update
* @param settings the collection settings
* @throws CollectionNotFoundException (async) if the collection does not exist.
* @throws ScopeNotFoundException (async) if the specified scope does not exist.
* @throws CouchbaseException (async) if any other generic unhandled/unexpected errors.
*/
@Stability.Volatile
public void updateCollection(String scopeName, String collectionName, UpdateCollectionSettings settings) {
block(asyncCollectionManager.updateCollection(scopeName, collectionName, settings));
}
/**
* Updates a collection with custom options.
*
* @param scopeName name of scope to update collection in
* @param collectionName name of collection to update
* @param settings the collection settings
* @param options the custom options to apply.
* @throws CollectionNotFoundException (async) if the collection does not exist.
* @throws ScopeNotFoundException (async) if the specified scope does not exist.
* @throws CouchbaseException (async) if any other generic unhandled/unexpected errors.
*/
@Stability.Volatile
public void updateCollection(String scopeName, String collectionName, UpdateCollectionSettings settings, UpdateCollectionOptions options) {
block(asyncCollectionManager.updateCollection(scopeName, collectionName, settings, options));
}
/**
* Drops a collection if it exists.
*
* @param collectionSpec the collection spec that contains the properties of the collection.
* @throws CollectionNotFoundException if the collection did not exist.
* @throws ScopeNotFoundException if the specified scope does not exist.
* @throws CouchbaseException if any other generic unhandled/unexpected errors.
* @deprecated Please use {@link #dropCollection(String, String)} instead.
*/
@Deprecated
public void dropCollection(final CollectionSpec collectionSpec) {
dropCollection(collectionSpec, dropCollectionOptions());
}
/**
* Drops a collection if it exists with custom options.
*
* @param collectionSpec the collection spec that contains the properties of the collection.
* @param options the custom options to apply.
* @throws CollectionNotFoundException if the collection did not exist.
* @throws ScopeNotFoundException if the specified scope does not exist.
* @throws CouchbaseException if any other generic unhandled/unexpected errors.
* @deprecated Please use {@link #dropCollection(String, String, DropCollectionOptions)} instead.
*/
@Deprecated
public void dropCollection(final CollectionSpec collectionSpec, final DropCollectionOptions options) {
block(asyncCollectionManager.dropCollection(collectionSpec, options));
}
/**
* Drops a collection if it exists.
*
* @param scopeName the scope name containing the collection to drop
* @param collectionName the collection name
* @throws CollectionNotFoundException if the collection did not exist.
* @throws ScopeNotFoundException if the specified scope does not exist.
* @throws CouchbaseException if any other generic unhandled/unexpected errors.
*/
@Stability.Volatile
public void dropCollection(final String scopeName, final String collectionName) {
dropCollection(scopeName, collectionName, dropCollectionOptions());
}
/**
* Drops a collection if it exists with custom options.
*
* @param scopeName the scope name containing the collection to drop
* @param collectionName the collection name
* @param options the custom options to apply.
* @throws CollectionNotFoundException if the collection did not exist.
* @throws ScopeNotFoundException if the specified scope does not exist.
* @throws CouchbaseException if any other generic unhandled/unexpected errors.
*/
@Stability.Volatile
public void dropCollection(final String scopeName, final String collectionName, final DropCollectionOptions options) {
block(asyncCollectionManager.dropCollection(scopeName, collectionName, options));
}
/**
* Drops a scope if it exists.
*
* @param scopeName the name of the scope to drop.
* @throws ScopeNotFoundException if the scope did not exist.
* @throws CouchbaseException if any other generic unhandled/unexpected errors.
*/
public void dropScope(final String scopeName) {
dropScope(scopeName, dropScopeOptions());
}
/**
* Drops a scope if it exists with custom options.
*
* @param scopeName the name of the scope to drop.
* @param options the custom options to apply.
* @throws ScopeNotFoundException if the scope did not exist.
* @throws CouchbaseException if any other generic unhandled/unexpected errors.
*/
public void dropScope(final String scopeName, final DropScopeOptions options) {
block(asyncCollectionManager.dropScope(scopeName, options));
}
/**
* Returns the scope if it exists.
*
* @param scopeName the name of the scope.
* @return containing information about the scope.
* @throws ScopeNotFoundException if scope does not exist.
* @throws CouchbaseException if any other generic unhandled/unexpected errors.
* @deprecated use {@link #getAllScopes()} instead.
*/
@Deprecated
public ScopeSpec getScope(final String scopeName) {
return getScope(scopeName, getScopeOptions());
}
/**
* Returns the scope if it exists with custom options.
*
* @param scopeName the name of the scope.
* @param options the custom options to apply.
* @return containing information about the scope.
* @throws ScopeNotFoundException if scope does not exist.
* @throws CouchbaseException if any other generic unhandled/unexpected errors.
* @deprecated use {@link #getAllScopes(GetAllScopesOptions)} instead.
*/
@Deprecated
public ScopeSpec getScope(final String scopeName, final GetScopeOptions options) {
return block(asyncCollectionManager.getScope(scopeName, options));
}
/**
* Returns all scopes in this bucket.
*
* @return a (potentially empty) list of scopes in the bucket.
* @throws CouchbaseException if any other generic unhandled/unexpected errors.
*/
public List getAllScopes() {
return getAllScopes(getAllScopesOptions());
}
/**
* Returns all scopes in this bucket with custom options.
*
* @param options the custom options to apply.
* @return a (potentially empty) list of scopes in the bucket.
* @throws CouchbaseException if any other generic unhandled/unexpected errors.
*/
public List getAllScopes(final GetAllScopesOptions options) {
return block(asyncCollectionManager.getAllScopes(options));
}
}