org.springframework.data.jpa.repository

Interface JpaRepository<T,ID>

All Superinterfaces:

CrudRepository<T,ID>, PagingAndSortingRepository<T,ID>, QueryByExampleExecutor<T>, Repository<T,ID>

All Known Subinterfaces:

JpaRepositoryImplementation<T,ID>

All Known Implementing Classes:

QuerydslJpaRepository, SimpleJpaRepository

@NoRepositoryBean
public interface JpaRepository<T,ID>
extends PagingAndSortingRepository<T,ID>, QueryByExampleExecutor<T>

JPA specific extension of Repository.

Author:

Oliver Gierke, Christoph Strobl, Mark Paluch, Sander Krabbenborg, Jesse Wouters

Method Summary

Modifier and Type	Method and Description
void	deleteAllByIdInBatch(Iterable<ID> ids) Deletes the entities identified by the given ids using a single query.
void	deleteAllInBatch() Deletes all entities in a batch call.
void	deleteAllInBatch(Iterable<T> entities) Deletes the given entities in a batch which means it will create a single query.
default void	deleteInBatch(Iterable<T> entities) Deprecated. Use deleteAllInBatch(Iterable) instead.
List<T>	findAll()
<S extends T> List<S>	findAll(Example<S> example)
<S extends T> List<S>	findAll(Example<S> example, Sort sort)
List<T>	findAll(Sort sort)
List<T>	findAllById(Iterable<ID> ids)
void	flush() Flushes all pending changes to the database.
T	getById(ID id) Returns a reference to the entity with the given identifier.
T	getOne(ID id) Deprecated. use JpaRepository#getById(ID) instead.
<S extends T> List<S>	saveAll(Iterable<S> entities)
<S extends T> List<S>	saveAllAndFlush(Iterable<S> entities) Saves all entities and flushes changes instantly.
<S extends T> S	saveAndFlush(S entity) Saves an entity and flushes changes instantly.

Methods inherited from interface org.springframework.data.repository.PagingAndSortingRepository

findAll

Methods inherited from interface org.springframework.data.repository.CrudRepository

count, delete, deleteAll, deleteAll, deleteAllById, deleteById, existsById, findById, save

Methods inherited from interface org.springframework.data.repository.query.QueryByExampleExecutor

count, exists, findAll, findOne

Method Detail

findAll

List<T> findAll()

Specified by:

findAll in interface CrudRepository<T,ID>

findAll

List<T> findAll(Sort sort)

Specified by:

findAll in interface PagingAndSortingRepository<T,ID>

findAllById

List<T> findAllById(Iterable<ID> ids)

Specified by:

findAllById in interface CrudRepository<T,ID>

saveAll

<S extends T> List<S> saveAll(Iterable<S> entities)

Specified by:

saveAll in interface CrudRepository<T,ID>

flush

void flush()

Flushes all pending changes to the database.

saveAndFlush

<S extends T> S saveAndFlush(S entity)

Saves an entity and flushes changes instantly.

Parameters:

entity - entity to be saved. Must not be null.

Returns:

the saved entity

saveAllAndFlush

<S extends T> List<S> saveAllAndFlush(Iterable<S> entities)

Saves all entities and flushes changes instantly.

Parameters:

entities - entities to be deleted. Must not be null.

Returns:

the saved entities

Since:

2.5

deleteInBatch

@Deprecated
default void deleteInBatch(Iterable<T> entities)

Deprecated. Use deleteAllInBatch(Iterable) instead.

Deletes the given entities in a batch which means it will create a single query. This kind of operation leaves JPAs first level cache and the database out of sync. Consider flushing the EntityManager before calling this method.

Parameters:

entities - entities to be deleted. Must not be null.

deleteAllInBatch

void deleteAllInBatch(Iterable<T> entities)

Deletes the given entities in a batch which means it will create a single query. This kind of operation leaves JPAs first level cache and the database out of sync. Consider flushing the EntityManager before calling this method.

Parameters:

entities - entities to be deleted. Must not be null.

Since:

2.5

deleteAllByIdInBatch

void deleteAllByIdInBatch(Iterable<ID> ids)

Deletes the entities identified by the given ids using a single query. This kind of operation leaves JPAs first level cache and the database out of sync. Consider flushing the EntityManager before calling this method.

Parameters:

ids - the ids of the entities to be deleted. Must not be null.

Since:

2.5

deleteAllInBatch

void deleteAllInBatch()

Deletes all entities in a batch call.

getOne

@Deprecated
T getOne(ID id)

Deprecated. use JpaRepository#getById(ID) instead.

Returns a reference to the entity with the given identifier. Depending on how the JPA persistence provider is implemented this is very likely to always return an instance and throw an EntityNotFoundException on first access. Some of them will reject invalid identifiers immediately.

Parameters:

id - must not be null.

Returns:

a reference to the entity with the given identifier.

See Also:

for details on when an exception is thrown.

getById

T getById(ID id)

Returns a reference to the entity with the given identifier. Depending on how the JPA persistence provider is implemented this is very likely to always return an instance and throw an EntityNotFoundException on first access. Some of them will reject invalid identifiers immediately.

Parameters:

id - must not be null.

Returns:

a reference to the entity with the given identifier.

Since:

2.5

See Also:

for details on when an exception is thrown.

findAll

<S extends T> List<S> findAll(Example<S> example)

Specified by:

findAll in interface QueryByExampleExecutor<T>

findAll

<S extends T> List<S> findAll(Example<S> example,
                              Sort sort)

Specified by:

findAll in interface QueryByExampleExecutor<T>