Package com.mongodb.operation

Class CreateIndexesOperation

java.lang.Object

com.mongodb.operation.CreateIndexesOperation

All Implemented Interfaces:

AsyncWriteOperation<Void>, WriteOperation<Void>

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

An operation that creates one or more indexes.

Multiple index creation is supported starting with MongoDB server version 2.6

Since:

3.0

MongoDB documentation

Create indexes

Constructor Summary

Constructors

Constructor	Description
CreateIndexesOperation(MongoNamespace namespace, List<IndexRequest> requests)	Deprecated. Prefer CreateIndexesOperation(MongoNamespace, List, WriteConcern)
CreateIndexesOperation(MongoNamespace namespace, List<IndexRequest> requests, WriteConcern writeConcern)	Construct a new instance.

Method Summary

Modifier and Type	Method	Description
Void	execute(WriteBinding binding)	General execute which can return anything of type T
void	executeAsync(AsyncWriteBinding binding, SingleResultCallback<Void> callback)	General execute which can return anything of type T
List<String>	getIndexNames()	Gets the index names.
long	getMaxTime(TimeUnit timeUnit)	Gets the maximum execution time on the server for this operation.
List<IndexRequest>	getRequests()	Gets the index requests.
WriteConcern	getWriteConcern()	Gets the write concern.
CreateIndexesOperation	maxTime(long maxTime, TimeUnit timeUnit)	Sets the maximum execution time on the server for this operation.

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateIndexesOperation

@Deprecated
public CreateIndexesOperation(MongoNamespace namespace,
                              List<IndexRequest> requests)

Deprecated. Prefer CreateIndexesOperation(MongoNamespace, List, WriteConcern)

Construct a new instance.

Parameters:

namespace - the database and collection namespace for the operation.

requests - the index request

CreateIndexesOperation

public CreateIndexesOperation(MongoNamespace namespace,
                              List<IndexRequest> requests,
                              WriteConcern writeConcern)

Construct a new instance.

Parameters:

namespace - the database and collection namespace for the operation.

requests - the index request

writeConcern - the write concern

Since:

3.4

Method Detail

getWriteConcern

public WriteConcern getWriteConcern()

Gets the write concern.

Returns:

the write concern, which may be null

Since:

3.4

getRequests

public List<IndexRequest> getRequests()

Gets the index requests.

Returns:

the index requests

getIndexNames

public List<String> getIndexNames()

Gets the index names.

Returns:

a list of index names

getMaxTime

public long getMaxTime(TimeUnit timeUnit)

Gets the maximum execution time on the server for this operation. The default is 0, which places no limit on the execution time.

Parameters:

timeUnit - the time unit to return the result in

Returns:

the maximum execution time in the given time unit

Since:

3.6

maxTime

public CreateIndexesOperation maxTime(long maxTime,
                                      TimeUnit timeUnit)

Sets the maximum execution time on the server for this operation.

Parameters:

maxTime - the max time

timeUnit - the time unit, which may not be null

Returns:

this

Since:

3.6

execute

public Void execute(WriteBinding binding)

Description copied from interface: WriteOperation

General execute which can return anything of type T

Specified by:

execute in interface WriteOperation<Void>

Parameters:

binding - the binding to execute in the context of

Returns:

T, the result of the execution

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