com.mongodb.operation

Class RenameCollectionOperation

java.lang.Object

com.mongodb.operation.RenameCollectionOperation

All Implemented Interfaces:

AsyncWriteOperation<Void>, WriteOperation<Void>

public class RenameCollectionOperation
extends Object
implements AsyncWriteOperation<Void>, WriteOperation<Void>

An operation that renames the given collection to the new name.

If the new name is the same as an existing collection and dropTarget is true, this existing collection will be dropped. If dropTarget is false and the newCollectionName is the same as an existing collection, a MongoServerException will be thrown.

Since:

3.0

MongoDB documentation

renameCollection

Constructor Summary

Constructors

Constructor and Description
RenameCollectionOperation(MongoNamespace originalNamespace, MongoNamespace newNamespace) Deprecated. Prefer RenameCollectionOperation(MongoNamespace, MongoNamespace, WriteConcern)
RenameCollectionOperation(MongoNamespace originalNamespace, MongoNamespace newNamespace, WriteConcern writeConcern)

Method Summary

Modifier and Type	Method and Description
RenameCollectionOperation	dropTarget(boolean dropTarget) Sets if mongod should drop the target of renameCollection prior to renaming the collection.
Void	execute(WriteBinding binding) Rename the collection with oldCollectionName in database databaseName to the newCollectionName.
void	executeAsync(AsyncWriteBinding binding, SingleResultCallback<Void> callback) General execute which can return anything of type T
WriteConcern	getWriteConcern() Gets the write concern.
boolean	isDropTarget() Gets if mongod should drop the target of renameCollection prior to renaming the collection.

Methods inherited from class java.lang.Object

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

Constructor Detail

RenameCollectionOperation

@Deprecated
public RenameCollectionOperation(MongoNamespace originalNamespace,
                                             MongoNamespace newNamespace)

Deprecated. Prefer RenameCollectionOperation(MongoNamespace, MongoNamespace, WriteConcern)

Parameters:

originalNamespace - the name of the collection to rename

newNamespace - the desired new name for the collection

RenameCollectionOperation

public RenameCollectionOperation(MongoNamespace originalNamespace,
                                 MongoNamespace newNamespace,
                                 WriteConcern writeConcern)

Parameters:

originalNamespace - the name of the collection to rename

newNamespace - the desired new name for the collection

writeConcern - the writeConcern

Since:

3.4

Method Detail

getWriteConcern

public WriteConcern getWriteConcern()

Gets the write concern.

Returns:

the write concern, which may be null

Since:

3.4

isDropTarget

public boolean isDropTarget()

Gets if mongod should drop the target of renameCollection prior to renaming the collection.

Returns:

true if mongod should drop the target of renameCollection prior to renaming the collection.

dropTarget

public RenameCollectionOperation dropTarget(boolean dropTarget)

Sets if mongod should drop the target of renameCollection prior to renaming the collection.

Parameters:

dropTarget - true if mongod should drop the target of renameCollection prior to renaming the collection.

Returns:

this

execute

public Void execute(WriteBinding binding)

Rename the collection with oldCollectionName in database databaseName to the newCollectionName.

Specified by:

execute in interface WriteOperation<Void>

Parameters:

binding - the binding

Returns:

a void result

Throws:

MongoServerException - if you provide a newCollectionName that is the name of an existing collection and dropTarget is false, or if the oldCollectionName is the name of a collection that doesn't exist

executeAsync

public void executeAsync(AsyncWriteBinding binding,
                         SingleResultCallback<Void> callback)

Description copied from interface: AsyncWriteOperation

General execute which can return anything of type T

Specified by:

executeAsync in interface AsyncWriteOperation<Void>

Parameters:

binding - the binding to execute in the context of

callback - the callback to be called when the operation has been executed