Module spring.data.mongodb

Package org.springframework.data.mongodb.core

Class DefaultReactiveIndexOperations

java.lang.Object

org.springframework.data.mongodb.core.DefaultReactiveIndexOperations

All Implemented Interfaces:

ReactiveIndexOperations

public class DefaultReactiveIndexOperations
extends Object
implements ReactiveIndexOperations

Default implementation of ReactiveIndexOperations.

Since:

2.0

Author:

Mark Paluch, Christoph Strobl

Constructor Summary

Constructors

Constructor	Description
DefaultReactiveIndexOperations(ReactiveMongoOperations mongoOperations, String collectionName, QueryMapper queryMapper)	Creates a new DefaultReactiveIndexOperations.
DefaultReactiveIndexOperations(ReactiveMongoOperations mongoOperations, String collectionName, QueryMapper queryMapper, Class<?> type)	Creates a new DefaultReactiveIndexOperations.

Method Summary

Modifier and Type	Method	Description
Mono<Void>	alterIndex(String name, IndexOptions options)	Alters the index with given name.
Mono<String>	createIndex(IndexDefinition indexDefinition)	Create the index for the provided IndexDefinition for the collection indicated by the entity class.
Mono<Void>	dropAllIndexes()	Drops all indices from this collection.
Mono<Void>	dropIndex(String name)	Drops an index from this collection.
Flux<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.ReactiveIndexOperations

ensureIndex

Constructor Details

DefaultReactiveIndexOperations

public DefaultReactiveIndexOperations(ReactiveMongoOperations mongoOperations,
 String collectionName,
 QueryMapper queryMapper)

Creates a new DefaultReactiveIndexOperations.

Parameters:

mongoOperations - must not be null.

collectionName - must not be null.

queryMapper - must not be null.

DefaultReactiveIndexOperations

public DefaultReactiveIndexOperations(ReactiveMongoOperations mongoOperations,
 String collectionName,
 QueryMapper queryMapper,
 Class<?> type)

Creates a new DefaultReactiveIndexOperations.

Parameters:

mongoOperations - must not be null.

collectionName - must not be null.

queryMapper - must not be null.

type - used for mapping potential partial index filter expression, must not be null.

Method Details

createIndex

public Mono<String> createIndex(IndexDefinition indexDefinition)

Description copied from interface: ReactiveIndexOperations

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 ReactiveIndexOperations

Parameters:

indexDefinition - must not be null.

Returns:

the index name.

alterIndex

public Mono<Void> alterIndex(String name,
 IndexOptions options)

Description copied from interface: ReactiveIndexOperations

Alters the index with given name.

Specified by:

alterIndex in interface ReactiveIndexOperations

Parameters:

name - name of index to change.

options - index options.

dropIndex

public Mono<Void> dropIndex(String name)

Description copied from interface: ReactiveIndexOperations

Drops an index from this collection.

Specified by:

dropIndex in interface ReactiveIndexOperations

Parameters:

name - name of index to drop

dropAllIndexes

public Mono<Void> dropAllIndexes()

Description copied from interface: ReactiveIndexOperations

Drops all indices from this collection.

Specified by:

dropAllIndexes in interface ReactiveIndexOperations

getIndexInfo

public Flux<IndexInfo> getIndexInfo()

Description copied from interface: ReactiveIndexOperations

Returns the index information on the collection.

Specified by:

getIndexInfo in interface ReactiveIndexOperations

Returns:

index information on the collection