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
reactor.core.publisher.Mono<Void>	alterIndex(String name, IndexOptions options)	Alters the index with given name.
reactor.core.publisher.Mono<Void>	dropAllIndexes()	Drops all indices from this collection.
reactor.core.publisher.Mono<Void>	dropIndex(String name)	Drops an index from this collection.
reactor.core.publisher.Mono<String>	ensureIndex(IndexDefinition indexDefinition)	Ensure that an index for the provided IndexDefinition exists for the collection indicated by the entity class.
reactor.core.publisher.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

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

ensureIndex

public reactor.core.publisher.Mono<String> ensureIndex(IndexDefinition indexDefinition)

Description copied from interface: ReactiveIndexOperations

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

Specified by:

ensureIndex in interface ReactiveIndexOperations

Parameters:

indexDefinition - must not be null.

Returns:

a Mono emitting the name of the index on completion.

alterIndex

public reactor.core.publisher.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 reactor.core.publisher.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 reactor.core.publisher.Mono<Void> dropAllIndexes()

Description copied from interface: ReactiveIndexOperations

Drops all indices from this collection.

Specified by:

dropAllIndexes in interface ReactiveIndexOperations

getIndexInfo

public reactor.core.publisher.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