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

Interface ReactiveIndexOperations

All Known Implementing Classes:
DefaultReactiveIndexOperations
public interface ReactiveIndexOperations
Index operations on a collection.
Since:
2.0
Author:
Mark Paluch, Christoph Strobl

  • 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.

  • Method Details

    • ensureIndex

      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. If not it will be created.
      Parameters:
      indexDefinition - must not be null.
      Returns:
      a Mono emitting the name of the index on completion.

    • alterIndex

      reactor.core.publisher.Mono<Void> alterIndex(String name, IndexOptions options)
      Alters the index with given name.
      Parameters:
      name - name of index to change.
      options - index options.
      Since:
      4.1

    • dropIndex

      reactor.core.publisher.Mono<Void> dropIndex(String name)
      Drops an index from this collection.
      Parameters:
      name - name of index to drop

    • dropAllIndexes

      reactor.core.publisher.Mono<Void> dropAllIndexes()
      Drops all indices from this collection.

    • getIndexInfo

      reactor.core.publisher.Flux<IndexInfo> getIndexInfo()
      Returns the index information on the collection.
      Returns:
      index information on the collection