Package org.springframework.data.repository.reactive

Interface ReactiveCrudRepository<T,ID>

All Superinterfaces:
Repository<T,ID>
@NoRepositoryBean public interface ReactiveCrudRepository<T,ID> extends Repository<T,ID>
Interface for generic CRUD operations on a repository for a specific type. This repository follows reactive paradigms and uses Project Reactor types which are built on top of Reactive Streams.

Save and delete operations with entities that have a version attribute trigger an onError with a OptimisticLockingFailureException when they encounter a different version value in the persistence store than in the entity passed as an argument.

Other delete operations that only receive ids or entities without version attribute do not trigger an error when no matching data is found in the persistence store.

Since:
2.0
Author:
Mark Paluch, Christph Strobl, Jens Schauder
See Also:
  • Mono
  • Flux

  • Method Summary

    Modifier and Type
    Method
    Description
    reactor.core.publisher.Mono<Long>
    count()
    Returns the number of entities available.
    reactor.core.publisher.Mono<Void>
    delete(T entity)
    Deletes a given entity.
    reactor.core.publisher.Mono<Void>
    deleteAll()
    Deletes all entities managed by the repository.
    reactor.core.publisher.Mono<Void>
    deleteAll(Iterable<? extends T> entities)
    Deletes the given entities.
    reactor.core.publisher.Mono<Void>
    deleteAll(org.reactivestreams.Publisher<? extends T> entityStream)
    Deletes the given entities supplied by a Publisher.
    reactor.core.publisher.Mono<Void>
    deleteAllById(Iterable<? extends ID> ids)
    Deletes all instances of the type T with the given IDs.
    reactor.core.publisher.Mono<Void>
    deleteById(ID id)
    Deletes the entity with the given id.
    reactor.core.publisher.Mono<Void>
    deleteById(org.reactivestreams.Publisher<ID> id)
    Deletes the entity with the given id supplied by a Publisher.
    reactor.core.publisher.Mono<Boolean>
    existsById(ID id)
    Returns whether an entity with the given id exists.
    reactor.core.publisher.Mono<Boolean>
    existsById(org.reactivestreams.Publisher<ID> id)
    Returns whether an entity with the given id, supplied by a Publisher, exists.
    reactor.core.publisher.Flux<T>
    findAll()
    Returns all instances of the type.
    reactor.core.publisher.Flux<T>
    findAllById(Iterable<ID> ids)
    Returns all instances of the type T with the given IDs.
    reactor.core.publisher.Flux<T>
    findAllById(org.reactivestreams.Publisher<ID> idStream)
    Returns all instances of the type T with the given IDs supplied by a Publisher.
    reactor.core.publisher.Mono<T>
    findById(ID id)
    Retrieves an entity by its id.
    reactor.core.publisher.Mono<T>
    findById(org.reactivestreams.Publisher<ID> id)
    Retrieves an entity by its id supplied by a Publisher.
    <S extends T>
    reactor.core.publisher.Mono<S>
    save(S entity)
    Saves a given entity.
    <S extends T>
    reactor.core.publisher.Flux<S>
    saveAll(Iterable<S> entities)
    Saves all given entities.
    <S extends T>
    reactor.core.publisher.Flux<S>
    saveAll(org.reactivestreams.Publisher<S> entityStream)
    Saves all given entities.

  • Method Details

    • save

      <S extends T> reactor.core.publisher.Mono<S> save(S entity)
      Saves a given entity. Use the returned instance for further operations as the save operation might have changed the entity instance completely.
      Parameters:
      entity - must not be null.
      Returns:
      Mono emitting the saved entity.
      Throws:
      IllegalArgumentException - in case the given entity is null.
      org.springframework.dao.OptimisticLockingFailureException - when the entity uses optimistic locking and has a version attribute with a different value from that found in the persistence store. Also thrown if the entity is assumed to be present but does not exist in the database.

    • saveAll

      <S extends T> reactor.core.publisher.Flux<S> saveAll(Iterable<S> entities)
      Saves all given entities.
      Parameters:
      entities - must not be null.
      Returns:
      Flux emitting the saved entities.
      Throws:
      IllegalArgumentException - in case the given entities or one of its entities is null.
      org.springframework.dao.OptimisticLockingFailureException - when at least one entity uses optimistic locking and has a version attribute with a different value from that found in the persistence store. Also thrown if at least one entity is assumed to be present but does not exist in the database.

    • saveAll

      <S extends T> reactor.core.publisher.Flux<S> saveAll(org.reactivestreams.Publisher<S> entityStream)
      Saves all given entities.
      Parameters:
      entityStream - must not be null.
      Returns:
      Flux emitting the saved entities.
      Throws:
      IllegalArgumentException - in case the given entityStream is null.
      org.springframework.dao.OptimisticLockingFailureException - when at least one entity uses optimistic locking and has a version attribute with a different value from that found in the persistence store. Also thrown if at least one entity is assumed to be present but does not exist in the database.

    • findById

      reactor.core.publisher.Mono<T> findById(ID id)
      Retrieves an entity by its id.
      Parameters:
      id - must not be null.
      Returns:
      Mono emitting the entity with the given id or Mono.empty() if none found.
      Throws:
      IllegalArgumentException - in case the given id is null.

    • findById

      reactor.core.publisher.Mono<T> findById(org.reactivestreams.Publisher<ID> id)
      Retrieves an entity by its id supplied by a Publisher.
      Parameters:
      id - must not be null. Uses the first emitted element to perform the find-query.
      Returns:
      Mono emitting the entity with the given id or Mono.empty() if none found.
      Throws:
      IllegalArgumentException - in case the given id is null.

    • existsById

      reactor.core.publisher.Mono<Boolean> existsById(ID id)
      Returns whether an entity with the given id exists.
      Parameters:
      id - must not be null.
      Returns:
      Mono emitting true if an entity with the given id exists, false otherwise.
      Throws:
      IllegalArgumentException - in case the given id is null.

    • existsById

      reactor.core.publisher.Mono<Boolean> existsById(org.reactivestreams.Publisher<ID> id)
      Returns whether an entity with the given id, supplied by a Publisher, exists. Uses the first emitted element to perform the exists-query.
      Parameters:
      id - must not be null.
      Returns:
      Mono emitting true if an entity with the given id exists, false otherwise.
      Throws:
      IllegalArgumentException - in case the given id is null.

    • findAll

      reactor.core.publisher.Flux<T> findAll()
      Returns all instances of the type.
      Returns:
      Flux emitting all entities.

    • findAllById

      reactor.core.publisher.Flux<T> findAllById(Iterable<ID> ids)
      Returns all instances of the type T with the given IDs.

      If some or all ids are not found, no entities are returned for these IDs.

      Note that the order of elements in the result is not guaranteed.

      Parameters:
      ids - must not be null nor contain any null values.
      Returns:
      Flux emitting the found entities. The size can be equal or less than the number of given ids.
      Throws:
      IllegalArgumentException - in case the given ids or one of its items is null.

    • findAllById

      reactor.core.publisher.Flux<T> findAllById(org.reactivestreams.Publisher<ID> idStream)
      Returns all instances of the type T with the given IDs supplied by a Publisher.

      If some or all ids are not found, no entities are returned for these IDs.

      Note that the order of elements in the result is not guaranteed.

      Parameters:
      idStream - must not be null.
      Returns:
      Flux emitting the found entities.
      Throws:
      IllegalArgumentException - in case the given idStream is null.

    • count

      reactor.core.publisher.Mono<Long> count()
      Returns the number of entities available.
      Returns:
      Mono emitting the number of entities.

    • deleteById

      reactor.core.publisher.Mono<Void> deleteById(ID id)
      Deletes the entity with the given id.

      If the entity is not found in the persistence store it is silently ignored.

      Parameters:
      id - must not be null.
      Returns:
      Mono signaling when operation has completed.
      Throws:
      IllegalArgumentException - in case the given id is null.

    • deleteById

      reactor.core.publisher.Mono<Void> deleteById(org.reactivestreams.Publisher<ID> id)
      Deletes the entity with the given id supplied by a Publisher.

      If the entity is not found in the persistence store it is silently ignored.

      Parameters:
      id - must not be null.
      Returns:
      Mono signaling when operation has completed.
      Throws:
      IllegalArgumentException - in case the given id is null.

    • delete

      reactor.core.publisher.Mono<Void> delete(T entity)
      Deletes a given entity.
      Parameters:
      entity - must not be null.
      Returns:
      Mono signaling when operation has completed.
      Throws:
      IllegalArgumentException - in case the given entity is null.
      org.springframework.dao.OptimisticLockingFailureException - when the entity uses optimistic locking and has a version attribute with a different value from that found in the persistence store. Also thrown if the entity is assumed to be present but does not exist in the database.

    • deleteAllById

      reactor.core.publisher.Mono<Void> deleteAllById(Iterable<? extends ID> ids)
      Deletes all instances of the type T with the given IDs.

      Entities that aren't found in the persistence store are silently ignored.

      Parameters:
      ids - must not be null.
      Returns:
      Mono signaling when operation has completed.
      Throws:
      IllegalArgumentException - in case the given ids or one of its elements is null. null.
      Since:
      2.5

    • deleteAll

      reactor.core.publisher.Mono<Void> deleteAll(Iterable<? extends T> entities)
      Deletes the given entities.
      Parameters:
      entities - must not be null.
      Returns:
      Mono signaling when operation has completed.
      Throws:
      IllegalArgumentException - in case the given entities or one of its entities is null.
      org.springframework.dao.OptimisticLockingFailureException - when at least one entity uses optimistic locking and has a version attribute with a different value from that found in the persistence store. Also thrown if at least one entity is assumed to be present but does not exist in the database.

    • deleteAll

      reactor.core.publisher.Mono<Void> deleteAll(org.reactivestreams.Publisher<? extends T> entityStream)
      Deletes the given entities supplied by a Publisher.
      Parameters:
      entityStream - must not be null.
      Returns:
      Mono signaling when operation has completed.
      Throws:
      IllegalArgumentException - in case the given entityStream is null.
      org.springframework.dao.OptimisticLockingFailureException - when at least one entity uses optimistic locking and has a version attribute with a different value from that found in the persistence store. Also thrown if at least one entity is assumed to be present but does not exist in the database.

    • deleteAll

      reactor.core.publisher.Mono<Void> deleteAll()
      Deletes all entities managed by the repository.
      Returns:
      Mono signaling when operation has completed.