org.springframework.data.mongodb.core.index

Interface IndexOperations

All Known Subinterfaces:

IndexOperationsAdapter

All Known Implementing Classes:

DefaultIndexOperations

public interface IndexOperations

Index operations on a collection.

Author:

Mark Pollack, Oliver Gierke, Christoph Strobl, Jens Schauder

Method Summary

Modifier and Type	Method and Description
void	dropAllIndexes() Drops all indices from this collection.
void	dropIndex(String name) Drops an index from this collection.
String	ensureIndex(IndexDefinition indexDefinition) Ensure that an index for the provided IndexDefinition exists for the collection indicated by the entity class.
List<IndexInfo>	getIndexInfo() Returns the index information on the collection.

Method Detail

ensureIndex

String ensureIndex(IndexDefinition indexDefinition)

Ensure that an index for the provided IndexDefinition exists for the collection indicated by the entity class. If not it will be created.

Parameters:

indexDefinition - must not be null.

dropIndex

void dropIndex(String name)

Drops an index from this collection.

Parameters:

name - name of index to drop

dropAllIndexes

void dropAllIndexes()

Drops all indices from this collection.

getIndexInfo

List<IndexInfo> getIndexInfo()

Returns the index information on the collection.

Returns:

index information on the collection