Module spring.data.mongodb

Package org.springframework.data.mongodb.core

Class DefaultIndexOperations

java.lang.Object

org.springframework.data.mongodb.core.DefaultIndexOperations

All Implemented Interfaces:

IndexOperations

public class DefaultIndexOperations
extends Object
implements IndexOperations

Default implementation of IndexOperations.

Author:

Mark Pollack, Oliver Gierke, Komi Innocent, Christoph Strobl, Mark Paluch

Constructor Summary

Constructors

Constructor	Description
DefaultIndexOperations(MongoOperations mongoOperations, String collectionName, Class<?> type)	Creates a new DefaultIndexOperations.
DefaultIndexOperations(MongoDatabaseFactory mongoDbFactory, String collectionName, QueryMapper queryMapper)	Deprecated. since 2.1.
DefaultIndexOperations(MongoDatabaseFactory mongoDbFactory, String collectionName, QueryMapper queryMapper, Class<?> type)	Deprecated. since 2.1.

Method Summary

Modifier and Type	Method	Description
void	alterIndex(String name, IndexOptions options)	Alters the index with given name.
String	createIndex(IndexDefinition indexDefinition)	Create the index for the provided IndexDefinition for the collection indicated by the entity class.
void	dropAllIndexes()	Drops all indices from this collection.
void	dropIndex(String name)	Drops an index from this collection.
<T> T	execute(CollectionCallback<T> callback)
List<IndexInfo>	getIndexInfo()	Returns the index information on the collection.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.data.mongodb.core.index.IndexOperations

ensureIndex

Constructor Details

DefaultIndexOperations

@Deprecated
public DefaultIndexOperations(MongoDatabaseFactory mongoDbFactory,
 String collectionName,
 QueryMapper queryMapper)

Deprecated.

since 2.1. Please use DefaultIndexOperations(MongoOperations, String, Class).

Creates a new DefaultIndexOperations.

Parameters:

mongoDbFactory - must not be null.

collectionName - must not be null.

queryMapper - must not be null.

DefaultIndexOperations

@Deprecated
public DefaultIndexOperations(MongoDatabaseFactory mongoDbFactory,
 String collectionName,
 QueryMapper queryMapper,
 @Nullable
 Class<?> type)

Deprecated.

since 2.1. Please use DefaultIndexOperations(MongoOperations, String, Class).

Creates a new DefaultIndexOperations.

Parameters:

mongoDbFactory - must not be null.

collectionName - must not be null.

queryMapper - must not be null.

type - Type used for mapping potential partial index filter expression. Can be null.

Since:

1.10

DefaultIndexOperations

public DefaultIndexOperations(MongoOperations mongoOperations,
 String collectionName,
 @Nullable
 Class<?> type)

Creates a new DefaultIndexOperations.

Parameters:

mongoOperations - must not be null.

collectionName - must not be null or empty.

type - can be null.

Since:

2.1

Method Details

createIndex

public String createIndex(IndexDefinition indexDefinition)

Description copied from interface: IndexOperations

Create the index for the provided IndexDefinition for the collection indicated by the entity class. If the index does not exist it will be created. Might error if the collection already defines an index with the same name but different settings.

Specified by:

createIndex in interface IndexOperations

Parameters:

indexDefinition - must not be null.

Returns:

the index name.

dropIndex

public void dropIndex(String name)

Description copied from interface: IndexOperations

Drops an index from this collection.

Specified by:

dropIndex in interface IndexOperations

Parameters:

name - name of index to drop

alterIndex

public void alterIndex(String name,
 IndexOptions options)

Description copied from interface: IndexOperations

Alters the index with given name.

Specified by:

alterIndex in interface IndexOperations

Parameters:

name - name of index to change.

options - index options.

dropAllIndexes

public void dropAllIndexes()

Description copied from interface: IndexOperations

Drops all indices from this collection.

Specified by:

dropAllIndexes in interface IndexOperations

getIndexInfo

public List<IndexInfo> getIndexInfo()

Description copied from interface: IndexOperations

Returns the index information on the collection.

Specified by:

getIndexInfo in interface IndexOperations

Returns:

index information on the collection

execute

@Nullable
public <T> T execute(CollectionCallback<T> callback)