Module spring.data.mongodb

Package org.springframework.data.mongodb.core.index

Class DefaultSearchIndexOperations

java.lang.Object

org.springframework.data.mongodb.core.index.DefaultSearchIndexOperations

All Implemented Interfaces:

SearchIndexOperations

public class DefaultSearchIndexOperations
extends Object
implements SearchIndexOperations

Since:

4.5

Author:

Christoph Strobl, Mark Paluch

Constructor Summary

Constructors

Constructor	Description
DefaultSearchIndexOperations(MongoOperations mongoOperations, Class<?> type)
DefaultSearchIndexOperations(MongoOperations mongoOperations, String collectionName, Class<?> type)

Method Summary

Modifier and Type	Method	Description
String	createIndex(SearchIndexDefinition indexDefinition)	Create the index for the given SearchIndexDefinition in the collection indicated by the entity class.
void	dropAllIndexes()	Drops all search indices from the collection indicated by the entity class.
void	dropIndex(String indexName)	Drops an index from the collection indicated by the entity class.
boolean	exists(String indexName)	Check whether an index with the given indexName exists for the collection indicated by the entity class.
SearchIndexStatus	status(String indexName)	Check the actual status of an index.
void	updateIndex(SearchIndexDefinition indexDefinition)	Alters the search index matching the index name.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultSearchIndexOperations

public DefaultSearchIndexOperations(MongoOperations mongoOperations,
 Class<?> type)

DefaultSearchIndexOperations

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

Method Details

createIndex

public String createIndex(SearchIndexDefinition indexDefinition)

Description copied from interface: SearchIndexOperations

Create the index for the given SearchIndexDefinition in the collection indicated by the entity class.

Specified by:

createIndex in interface SearchIndexOperations

Parameters:

indexDefinition - must not be null.

Returns:

the index name.

updateIndex

public void updateIndex(SearchIndexDefinition indexDefinition)

Description copied from interface: SearchIndexOperations

Alters the search index matching the index name.

Atlas Search might not support updating indices which raises a DataAccessException.

Specified by:

updateIndex in interface SearchIndexOperations

Parameters:

indexDefinition - the index definition.

exists

public boolean exists(String indexName)

Description copied from interface: SearchIndexOperations

Check whether an index with the given indexName exists for the collection indicated by the entity class. To ensure an existing index is queryable it is recommended to check its status.

Specified by:

exists in interface SearchIndexOperations

Parameters:

indexName - name of index to check for presence.

Returns:

true if the index exists; false otherwise.

status

public SearchIndexStatus status(String indexName)

Description copied from interface: SearchIndexOperations

Check the actual status of an index.

Specified by:

status in interface SearchIndexOperations

Parameters:

indexName - name of index to get the status for.

Returns:

the current status of the index or SearchIndexStatus.DOES_NOT_EXIST if the index cannot be found.

dropAllIndexes

public void dropAllIndexes()

Description copied from interface: SearchIndexOperations

Drops all search indices from the collection indicated by the entity class.

Specified by:

dropAllIndexes in interface SearchIndexOperations

dropIndex

public void dropIndex(String indexName)

Description copied from interface: SearchIndexOperations

Drops an index from the collection indicated by the entity class.

Specified by:

dropIndex in interface SearchIndexOperations

Parameters:

indexName - name of index to drop.