com.mongodb.operation

类 RenameCollectionOperation

java.lang.Object

com.mongodb.operation.RenameCollectionOperation

所有已实现的接口:

AsyncWriteOperation<java.lang.Void>, WriteOperation<java.lang.Void>

public class RenameCollectionOperation
extends java.lang.Object
implements AsyncWriteOperation<java.lang.Void>, WriteOperation<java.lang.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.

从以下版本开始:

3.0

MongoDB documentation

renameCollection

构造器概要

构造器

构造器和说明
RenameCollectionOperation(MongoNamespace originalNamespace, MongoNamespace newNamespace)

方法概要

限定符和类型	方法和说明
RenameCollectionOperation	dropTarget(boolean dropTarget) Sets if mongod should drop the target of renameCollection prior to renaming the collection.
java.lang.Void	execute(WriteBinding binding) Rename the collection with oldCollectionName in database databaseName to the newCollectionName.
void	executeAsync(AsyncWriteBinding binding, SingleResultCallback<java.lang.Void> callback) General execute which can return anything of type T
boolean	isDropTarget() Gets if mongod should drop the target of renameCollection prior to renaming the collection.

从类继承的方法 java.lang.Object

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

构造器详细资料

RenameCollectionOperation

public RenameCollectionOperation(MongoNamespace originalNamespace,
                                 MongoNamespace newNamespace)

参数:

originalNamespace - the name of the collection to rename

newNamespace - the desired new name for the collection

方法详细资料

isDropTarget

public boolean isDropTarget()

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

返回:

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.

参数:

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

返回:

this

execute

public java.lang.Void execute(WriteBinding binding)

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

指定者:

execute 在接口中 WriteOperation<java.lang.Void>

参数:

binding - the binding

返回:

a void result

抛出:

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<java.lang.Void> callback)

从接口复制的说明: AsyncWriteOperation

General execute which can return anything of type T

指定者:

executeAsync 在接口中 AsyncWriteOperation<java.lang.Void>

参数:

binding - the binding to execute in the context of

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