Module spring.data.jpa

Package org.springframework.data.jpa.repository.support

Class SimpleJpaRepository<T,ID>

java.lang.Object

org.springframework.data.jpa.repository.support.SimpleJpaRepository<T,ID>

Type Parameters:

T - the type of the entity to handle

ID - the type of the entity's identifier

All Implemented Interfaces:

JpaRepository<T,ID>, JpaSpecificationExecutor<T>, JpaRepositoryConfigurationAware, JpaRepositoryImplementation<T,ID>, CrudRepository<T,ID>, ListCrudRepository<T,ID>, ListPagingAndSortingRepository<T,ID>, PagingAndSortingRepository<T,ID>, QueryByExampleExecutor<T>, Repository<T,ID>

Direct Known Subclasses:

QuerydslJpaRepository

@Repository
@Transactional(readOnly=true)
public class SimpleJpaRepository<T,ID>
extends Object
implements JpaRepositoryImplementation<T,ID>

Default implementation of the CrudRepository interface. This will offer you a more sophisticated interface than the plain EntityManager .

Author:

Oliver Gierke, Eberhard Wolff, Thomas Darimont, Mark Paluch, Christoph Strobl, Stefan Fussenegger, Jens Schauder, David Madden, Moritz Becker, Sander Krabbenborg, Jesse Wouters, Greg Turnquist, Yanming Zhou, Ernst-Jan van der Laan, Diego Krupitza, Seol-JY, Joshua Chen, Giheon Do

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.data.jpa.repository.JpaSpecificationExecutor

JpaSpecificationExecutor.SpecificationFluentQuery<T>

Constructor Summary

Constructors

Constructor	Description
SimpleJpaRepository(Class<T> domainClass, jakarta.persistence.EntityManager entityManager)	Creates a new SimpleJpaRepository to manage objects of the given domain type.
SimpleJpaRepository(JpaEntityInformation<T,?> entityInformation, jakarta.persistence.EntityManager entityManager)	Creates a new SimpleJpaRepository to manage objects of the given JpaEntityInformation.

Method Summary

Modifier and Type	Method	Description
long	count()
<S extends T> long	count(Example<S> example)
long	count(Specification<T> spec)	Returns the number of instances that the given Specification will return.
long	delete(Specification<T> spec)	Deletes by the Specification and returns the number of rows deleted.
void	delete(T entity)
void	deleteAll()
void	deleteAll(Iterable<? extends T> entities)
void	deleteAllById(Iterable<? extends ID> ids)
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.
void	deleteById(ID id)
<S extends T> boolean	exists(Example<S> example)
boolean	exists(Specification<T> spec)	Checks whether the data store contains elements that match the given Specification.
boolean	existsById(ID id)
List<T>	findAll()
<S extends T> List<S>	findAll(Example<S> example)
<S extends T> Page<S>	findAll(Example<S> example, Pageable pageable)
<S extends T> List<S>	findAll(Example<S> example, Sort sort)
Page<T>	findAll(Pageable pageable)
List<T>	findAll(Sort sort)
List<T>	findAll(Specification<T> spec)	Returns all entities matching the given Specification.
Page<T>	findAll(Specification<T> spec, Pageable pageable)	Returns a Page of entities matching the given Specification.
List<T>	findAll(Specification<T> spec, Sort sort)	Returns all entities matching the given Specification and Sort.
Page<T>	findAll(Specification<T> spec, Specification<T> countSpec, Pageable pageable)	Returns a Page of entities matching the given Specification.
List<T>	findAllById(Iterable<ID> ids)
<S extends T, R> R	findBy(Example<S> example, Function<FluentQuery.FetchableFluentQuery<S>,R> queryFunction)
<S extends T, R> R	findBy(Specification<T> spec, Function<? super JpaSpecificationExecutor.SpecificationFluentQuery<S>,R> queryFunction)	Returns entities matching the given Specification applying the queryFunction that defines the query and its result type.
Optional<T>	findById(ID id)
<S extends T> Optional<S>	findOne(Example<S> example)
Optional<T>	findOne(Specification<T> spec)	Returns a single entity matching the given Specification or Optional.empty() if none found.
void	flush()	Flushes all pending changes to the database.
T	getById(ID id)	Deprecated.
protected <S extends T> jakarta.persistence.TypedQuery<Long>	getCountQuery(Specification<S> spec, Class<S> domainClass)	Creates a new count query for the given Specification.
protected jakarta.persistence.TypedQuery<Long>	getCountQuery(Specification<T> spec)	Deprecated. override getCountQuery(Specification, Class) instead
protected Class<T>	getDomainClass()
T	getOne(ID id)	Deprecated.
protected <S extends T> jakarta.persistence.TypedQuery<S>	getQuery(Specification<S> spec, Class<S> domainClass, Pageable pageable)	Creates a new TypedQuery from the given Specification.
protected <S extends T> jakarta.persistence.TypedQuery<S>	getQuery(Specification<S> spec, Class<S> domainClass, Sort sort)	Creates a TypedQuery for the given Specification and Sort.
protected jakarta.persistence.TypedQuery<T>	getQuery(Specification<T> spec, Pageable pageable)	Creates a new TypedQuery from the given Specification.
protected jakarta.persistence.TypedQuery<T>	getQuery(Specification<T> spec, Sort sort)	Creates a TypedQuery for the given Specification and Sort.
protected QueryHints	getQueryHints()	Returns QueryHints with the query hints based on the current CrudMethodMetadata and potential EntityGraph information.
protected QueryHints	getQueryHintsForCount()	Returns QueryHints with the query hints on the current CrudMethodMetadata for count queries.
T	getReferenceById(ID id)	Returns a reference to the entity with the given identifier.
protected CrudMethodMetadata	getRepositoryMethodMetadata()
protected <S extends T> Page<S>	readPage(jakarta.persistence.TypedQuery<S> query, Class<S> domainClass, Pageable pageable, Specification<S> spec)	Reads the given TypedQuery into a Page applying the given Pageable and Specification.
protected Page<T>	readPage(jakarta.persistence.TypedQuery<T> query, Pageable pageable, Specification<T> spec)	Deprecated. use readPage(TypedQuery, Class, Pageable, Specification) instead
<S extends T> S	save(S entity)
<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.
void	setEscapeCharacter(EscapeCharacter escapeCharacter)	Configures the EscapeCharacter to be used with the repository.
void	setProjectionFactory(ProjectionFactory projectionFactory)	Configures the ProjectionFactory to be used with the repository.
void	setRepositoryMethodMetadata(CrudMethodMetadata metadata)	Configures a custom CrudMethodMetadata to be used to detect LockModeTypes and query hints to be applied to queries.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.data.jpa.repository.JpaRepository

deleteInBatch

Constructor Details

SimpleJpaRepository

public SimpleJpaRepository(JpaEntityInformation<T,?> entityInformation,
 jakarta.persistence.EntityManager entityManager)

Creates a new SimpleJpaRepository to manage objects of the given JpaEntityInformation.

Parameters:

entityInformation - must not be null.

entityManager - must not be null.

SimpleJpaRepository

public SimpleJpaRepository(Class<T> domainClass,
 jakarta.persistence.EntityManager entityManager)

Creates a new SimpleJpaRepository to manage objects of the given domain type.

Parameters:

domainClass - must not be null.

entityManager - must not be null.

Method Details

setRepositoryMethodMetadata

public void setRepositoryMethodMetadata(CrudMethodMetadata metadata)

Configures a custom CrudMethodMetadata to be used to detect LockModeTypes and query hints to be applied to queries.

Specified by:

setRepositoryMethodMetadata in interface JpaRepositoryConfigurationAware

Parameters:

metadata -

setEscapeCharacter

public void setEscapeCharacter(EscapeCharacter escapeCharacter)

Description copied from interface: JpaRepositoryConfigurationAware

Configures the EscapeCharacter to be used with the repository.

Specified by:

setEscapeCharacter in interface JpaRepositoryConfigurationAware

Parameters:

escapeCharacter - must not be null.

setProjectionFactory

public void setProjectionFactory(ProjectionFactory projectionFactory)

Description copied from interface: JpaRepositoryConfigurationAware

Configures the ProjectionFactory to be used with the repository.

Specified by:

setProjectionFactory in interface JpaRepositoryConfigurationAware

Parameters:

projectionFactory - must not be null.

getRepositoryMethodMetadata

@Nullable
protected CrudMethodMetadata getRepositoryMethodMetadata()

getDomainClass

protected Class<T> getDomainClass()

deleteById

@Transactional
public void deleteById(ID id)

Specified by:

deleteById in interface CrudRepository<T,ID>

delete

@Transactional
public void delete(T entity)

Specified by:

delete in interface CrudRepository<T,ID>

deleteAllById

@Transactional
public void deleteAllById(Iterable<? extends ID> ids)

Specified by:

deleteAllById in interface CrudRepository<T,ID>

deleteAllByIdInBatch

@Transactional
public void deleteAllByIdInBatch(Iterable<ID> ids)

Description copied from interface: JpaRepository

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.

Specified by:

deleteAllByIdInBatch in interface JpaRepository<T,ID>

Parameters:

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

deleteAll

@Transactional
public void deleteAll(Iterable<? extends T> entities)

Specified by:

deleteAll in interface CrudRepository<T,ID>

deleteAllInBatch

@Transactional
public void deleteAllInBatch(Iterable<T> entities)

Description copied from interface: JpaRepository

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.

It will also NOT honor cascade semantics of JPA, nor will it emit JPA lifecycle events.

Specified by:

deleteAllInBatch in interface JpaRepository<T,ID>

Parameters:

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

deleteAll

@Transactional
public void deleteAll()

Specified by:

deleteAll in interface CrudRepository<T,ID>

deleteAllInBatch

@Transactional
public void deleteAllInBatch()

Description copied from interface: JpaRepository

Deletes all entities in a batch call.

Specified by:

deleteAllInBatch in interface JpaRepository<T,ID>

findById

public Optional<T> findById(ID id)

Specified by:

findById in interface CrudRepository<T,ID>

getOne

@Deprecated
public T getOne(ID id)

Deprecated.

Description copied from interface: JpaRepository

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.

Specified by:

getOne in interface JpaRepository<T,ID>

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

@Deprecated
public T getById(ID id)

Deprecated.

Description copied from interface: JpaRepository

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.

Specified by:

getById in interface JpaRepository<T,ID>

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.

getReferenceById

public T getReferenceById(ID id)

Description copied from interface: JpaRepository

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.

Specified by:

getReferenceById in interface JpaRepository<T,ID>

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.

existsById

public boolean existsById(ID id)

Specified by:

existsById in interface CrudRepository<T,ID>

findAll

public List<T> findAll()

Specified by:

findAll in interface CrudRepository<T,ID>

Specified by:

findAll in interface ListCrudRepository<T,ID>

findAllById

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

Specified by:

findAllById in interface CrudRepository<T,ID>

Specified by:

findAllById in interface ListCrudRepository<T,ID>

findAll

public List<T> findAll(Sort sort)

Specified by:

findAll in interface ListPagingAndSortingRepository<T,ID>

Specified by:

findAll in interface PagingAndSortingRepository<T,ID>

findAll

public Page<T> findAll(Pageable pageable)

Specified by:

findAll in interface PagingAndSortingRepository<T,ID>

findOne

public Optional<T> findOne(Specification<T> spec)

Description copied from interface: JpaSpecificationExecutor

Returns a single entity matching the given Specification or Optional.empty() if none found.

Specified by:

findOne in interface JpaSpecificationExecutor<T>

Parameters:

spec - must not be null.

Returns:

never null.

findAll

public List<T> findAll(Specification<T> spec)

Description copied from interface: JpaSpecificationExecutor

Returns all entities matching the given Specification.

If no Specification is given all entities matching <T> will be selected.

Specified by:

findAll in interface JpaSpecificationExecutor<T>

Parameters:

spec - can be null.

Returns:

never null.

findAll

public Page<T> findAll(@Nullable
 Specification<T> spec,
 Pageable pageable)

Description copied from interface: JpaSpecificationExecutor

Returns a Page of entities matching the given Specification.

If no Specification is given all entities matching <T> will be selected.

Specified by:

findAll in interface JpaSpecificationExecutor<T>

Parameters:

spec - can be null.

pageable - must not be null.

Returns:

never null.

findAll

public Page<T> findAll(@Nullable
 Specification<T> spec,
 @Nullable
 Specification<T> countSpec,
 Pageable pageable)

Description copied from interface: JpaSpecificationExecutor

Returns a Page of entities matching the given Specification.

Supports counting the total number of entities matching the Specification.

Specified by:

findAll in interface JpaSpecificationExecutor<T>

Parameters:

spec - can be null, if no Specification is given all entities matching <T> will be selected.

countSpec - can be null，if no Specification is given all entities matching <T> will be counted.

pageable - must not be null.

Returns:

never null.

findAll

public List<T> findAll(@Nullable
 Specification<T> spec,
 Sort sort)

Description copied from interface: JpaSpecificationExecutor

Returns all entities matching the given Specification and Sort.

If no Specification is given all entities matching <T> will be selected.

Specified by:

findAll in interface JpaSpecificationExecutor<T>

Parameters:

spec - can be null.

sort - must not be null.

Returns:

never null.

exists

public boolean exists(Specification<T> spec)

Description copied from interface: JpaSpecificationExecutor

Checks whether the data store contains elements that match the given Specification.

Specified by:

exists in interface JpaSpecificationExecutor<T>

Parameters:

spec - the Specification to use for the existence check, ust not be null.

Returns:

true if the data store contains elements that match the given Specification otherwise false.

delete

@Transactional
public long delete(@Nullable
 Specification<T> spec)

Description copied from interface: JpaSpecificationExecutor

Deletes by the Specification and returns the number of rows deleted.

This method uses Criteria API bulk delete that maps directly to database delete operations. The persistence context is not synchronized with the result of the bulk delete.

Please note that CriteriaQuery in, Specification.toPredicate(Root, CriteriaQuery, CriteriaBuilder) will be null because CriteriaBuilder.createCriteriaDelete(Class) does not implement CriteriaQuery.

If no Specification is given all entities matching <T> will be deleted.

Specified by:

delete in interface JpaSpecificationExecutor<T>

Parameters:

spec - the Specification to use for the existence check, can not be null.

Returns:

the number of entities deleted.

findBy

public <S extends T,
R> R findBy(Specification<T> spec,
 Function<? super JpaSpecificationExecutor.SpecificationFluentQuery<S>,R> queryFunction)

Description copied from interface: JpaSpecificationExecutor

Returns entities matching the given Specification applying the queryFunction that defines the query and its result type.

The query object used with queryFunction is only valid inside the findBy(…) method call. This requires the query function to return a query result and not the FluentQuery object itself to ensure the query is executed inside the findBy(…) method.

Specified by:

findBy in interface JpaSpecificationExecutor<T>

Parameters:

spec - must not be null.

queryFunction - the query function defining projection, sorting, and the result type

Returns:

all entities matching the given specification.

findOne

public <S extends T> Optional<S> findOne(Example<S> example)

Specified by:

findOne in interface QueryByExampleExecutor<T>

count

public <S extends T> long count(Example<S> example)

Specified by:

count in interface QueryByExampleExecutor<T>

exists

public <S extends T> boolean exists(Example<S> example)

Specified by:

exists in interface QueryByExampleExecutor<T>

findAll

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

Specified by:

findAll in interface JpaRepository<T,ID>

Specified by:

findAll in interface QueryByExampleExecutor<T>

findAll

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

Specified by:

findAll in interface JpaRepository<T,ID>

Specified by:

findAll in interface QueryByExampleExecutor<T>

findAll

public <S extends T> Page<S> findAll(Example<S> example,
 Pageable pageable)

Specified by:

findAll in interface QueryByExampleExecutor<T>

findBy

public <S extends T,
R> R findBy(Example<S> example,
 Function<FluentQuery.FetchableFluentQuery<S>,R> queryFunction)

Specified by:

findBy in interface QueryByExampleExecutor<T>

count

public long count()

Specified by:

count in interface CrudRepository<T,ID>

count

public long count(@Nullable
 Specification<T> spec)

Description copied from interface: JpaSpecificationExecutor

Returns the number of instances that the given Specification will return.

If no Specification is given all entities matching <T> will be counted.

Specified by:

count in interface JpaSpecificationExecutor<T>

Parameters:

spec - the Specification to count instances for, must not be null.

Returns:

the number of instances.

save

@Transactional
public <S extends T> S save(S entity)

Specified by:

save in interface CrudRepository<T,ID>

saveAndFlush

@Transactional
public <S extends T> S saveAndFlush(S entity)

Description copied from interface: JpaRepository

Saves an entity and flushes changes instantly.

Specified by:

saveAndFlush in interface JpaRepository<T,ID>

Parameters:

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

Returns:

the saved entity

saveAll

@Transactional
public <S extends T> List<S> saveAll(Iterable<S> entities)

Specified by:

saveAll in interface CrudRepository<T,ID>

Specified by:

saveAll in interface ListCrudRepository<T,ID>

saveAllAndFlush

@Transactional
public <S extends T> List<S> saveAllAndFlush(Iterable<S> entities)

Description copied from interface: JpaRepository

Saves all entities and flushes changes instantly.

Specified by:

saveAllAndFlush in interface JpaRepository<T,ID>

Parameters:

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

Returns:

the saved entities

flush

@Transactional
public void flush()

Description copied from interface: JpaRepository

Flushes all pending changes to the database.

Specified by:

flush in interface JpaRepository<T,ID>

readPage

@Deprecated
protected Page<T> readPage(jakarta.persistence.TypedQuery<T> query,
 Pageable pageable,
 @Nullable
 Specification<T> spec)

Deprecated.

use readPage(TypedQuery, Class, Pageable, Specification) instead

Reads the given TypedQuery into a Page applying the given Pageable and Specification.

Parameters:

query - must not be null.

spec - can be null.

pageable - must not be null.

readPage

protected <S extends T> Page<S> readPage(jakarta.persistence.TypedQuery<S> query,
 Class<S> domainClass,
 Pageable pageable,
 @Nullable
 Specification<S> spec)

Reads the given TypedQuery into a Page applying the given Pageable and Specification.

Parameters:

query - must not be null.

domainClass - must not be null.

spec - can be null.

pageable - can be null.

getQuery

protected jakarta.persistence.TypedQuery<T> getQuery(@Nullable
 Specification<T> spec,
 Pageable pageable)

Creates a new TypedQuery from the given Specification.

Parameters:

spec - can be null.

pageable - must not be null.

getQuery

protected <S extends T>
jakarta.persistence.TypedQuery<S> getQuery(@Nullable
 Specification<S> spec,
 Class<S> domainClass,
 Pageable pageable)

Creates a new TypedQuery from the given Specification.

Parameters:

spec - can be null.

domainClass - must not be null.

pageable - must not be null.

getQuery

protected jakarta.persistence.TypedQuery<T> getQuery(@Nullable
 Specification<T> spec,
 Sort sort)

Creates a TypedQuery for the given Specification and Sort.

Parameters:

spec - can be null.

sort - must not be null.

getQuery

protected <S extends T>
jakarta.persistence.TypedQuery<S> getQuery(@Nullable
 Specification<S> spec,
 Class<S> domainClass,
 Sort sort)

Creates a TypedQuery for the given Specification and Sort.

Parameters:

spec - can be null.

domainClass - must not be null.

sort - must not be null.

getCountQuery

@Deprecated
protected jakarta.persistence.TypedQuery<Long> getCountQuery(@Nullable
 Specification<T> spec)

Deprecated.

override getCountQuery(Specification, Class) instead

Creates a new count query for the given Specification.

Parameters:

spec - can be null.

getCountQuery

protected <S extends T>
jakarta.persistence.TypedQuery<Long> getCountQuery(@Nullable
 Specification<S> spec,
 Class<S> domainClass)

Creates a new count query for the given Specification.

Parameters:

spec - can be null.

domainClass - must not be null.

getQueryHints

protected QueryHints getQueryHints()

Returns QueryHints with the query hints based on the current CrudMethodMetadata and potential EntityGraph information.

getQueryHintsForCount

protected QueryHints getQueryHintsForCount()

Returns QueryHints with the query hints on the current CrudMethodMetadata for count queries.