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 Details

    • ensureIndex

      @Deprecated(since="4.5", forRemoval=true) Mono<String> ensureIndex(IndexDefinition indexDefinition)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 4.5, in favor of createIndex(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.

    • createIndex

      default Mono<String> createIndex(IndexDefinition indexDefinition)
      Create the 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:
      the index name.
      Since:
      4.5

    • alterIndex

      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

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

    • dropAllIndexes

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

    • getIndexInfo

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