- Type Parameters:
T
- the type of the primary entity class of the repository.K
- the type of the unique identifier attribute of the primary entity.
- All Superinterfaces:
DataRepository<T,
K>
- All Known Subinterfaces:
CrudRepository<T,
K>
A built-in repository supertype for performing basic operations on entities.
The type parameters of BasicRepository<T,K>
capture the primary entity type (T
) for the repository
and the type of the unique identifier attribute (K
) of the primary entity type.
The primary entity type is used for repository methods, such as countBy...
and deleteBy...
, which
do not explicitly specify an entity type.
Example entity:
@Entity
public class Employee {@Id
public int badgeNumber; public String firstName; public String lastName; ... }
Example repository:
@Repository
public interface Employees extends BasicRepository<Employee, Integer>
{ boolean deleteByBadgeNumber(int badgeNum); ... }
Example usage:
@Inject
Employees employees; ... Employee emp = ... emp = employees.save(emp); boolean deleted = employees.deleteByBadgeNumber(emp.badgeNum); PageRequest<Employee>
pageRequest = PageRequest.of(Employee.class).size(25).sortBy(Sort.asc("name")); Page<Employee>
page = people.findAll(pageRequest);
The module Javadoc provides an overview
of Jakarta Data.
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Deletes a given entity.void
Deletes the given entities.void
deleteById
(K id) Deletes the entity with the given Id.findAll()
Retrieves all persistent entities of the specified type from the database.findAll
(PageRequest<T> pageRequest) Returns aPage
of entities according to the page request that is provided as thePageRequest
parameter.Retrieves an entity by its Id.<S extends T>
Ssave
(S entity) Saves a given entity to the database.Saves all given entities to the database.
-
Method Details
-
save
Saves a given entity to the database. If the entity has an Id or key that exists in the database, the method will update the existing record. Otherwise, it will insert a new record.If the entity has a non-null Id, the method will attempt to update the existing record in the database. If the entity does not exist in the database or has a null Id, then this method will insert a new record into the database.
The entity instance that is returned as a result value of this method must be updated with all automatically generated values and incremented values that changed due to the save. After invoking this method, do not continue to use the entity value that is supplied as a parameter. This method makes no guarantees about the state of the entity value that is supplied as a parameter.
If the entity uses optimistic locking and the version differs from the version in the database, an
OptimisticLockingFailureException
will be thrown.- Type Parameters:
S
- Type of the entity to save.- Parameters:
entity
- The entity to be saved. Must not benull
.- Returns:
- The saved entity; never
null
. - Throws:
OptimisticLockingFailureException
- If the entity uses optimistic locking and the version in the database differs from the version in the entity.NullPointerException
- If the provided entity isnull
.
-
saveAll
Saves all given entities to the database. If an entity has a non-null Id that exists in the database, the method will update the existing record. Otherwise, it will insert a new record.If an entity has a non-null Id, this method will attempt to update the existing record in the database. If an entity does not exist in the database or has a null Id, then this method inserts a new record into the database.
The entity instances that are returned as a result of this method must be updated with all automatically generated values and incremented values that changed due to the save. After invoking this method, do not continue to use the entity values that are supplied in the parameter. This method makes no guarantees about the state of the entity values that are supplied in the parameter.
- Type Parameters:
S
- Type of entity to save.- Parameters:
entities
- An iterable of entities.- Returns:
- The saved entities; will never be
null
. - Throws:
OptimisticLockingFailureException
- If an entity has a version for optimistic locking that differs from the version in the database.NullPointerException
- If either the iterable is null or any element is null.
-
findById
Retrieves an entity by its Id.- Parameters:
id
- must not benull
.- Returns:
- the entity with the given Id or
Optional.empty()
if none is found. - Throws:
NullPointerException
- when the Id isnull
.
-
findAll
Retrieves all persistent entities of the specified type from the database.- Returns:
- a stream of all entities; will never be
null
. - Throws:
UnsupportedOperationException
- for Key-Value and Wide-Column databases that are not capable of thefindAll
operation.
-
findAll
Returns aPage
of entities according to the page request that is provided as thePageRequest
parameter.- Parameters:
pageRequest
- the request for a paginated result; must not benull
.- Returns:
- a page of entities; will never be
null
. - Throws:
NullPointerException
- whenpageRequest
isnull
.UnsupportedOperationException
- for Key-Value and Wide-Column databases when thePageRequest.Mode.CURSOR_NEXT
orPageRequest.Mode.CURSOR_PREVIOUS
pagination mode is selected.- See Also:
-
deleteById
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 benull
.- Throws:
NullPointerException
- when the Id isnull
.
-
delete
Deletes a given entity. Deletion is performed by matching the Id, and if the entity is versioned (for example, withjakarta.persistence.Version
), then also the version. Other properties of the entity do not need to match.- Parameters:
entity
- must not benull
.- Throws:
OptimisticLockingFailureException
- if the entity is not found in the database for deletion or has a version for optimistic locking that is inconsistent with the version in the database.NullPointerException
- when the entity is null
-
deleteAll
Deletes the given entities. Deletion of each entity is performed by matching the unique identifier, and if the entity is versioned (for example, withjakarta.persistence.Version
), then also the version. Other properties of the entity do not need to match.- Parameters:
entities
- Must not benull
. Must not containnull
elements.- Throws:
OptimisticLockingFailureException
- If an entity is not found in the database for deletion or has a version for optimistic locking that is inconsistent with the version in the database.NullPointerException
- If the iterable isnull
or containsnull
elements.
-