Module jakarta.data

Package jakarta.data.repository

package jakarta.data.repository

A repository is an interface annotated with Repository that defines operations on entities. Entities represent data in the persistent store. In Domain-driven design, a repository participates in the domain but abstracts away storage and infrastructure details.

Repository interfaces can optionally inherit from built-in interfaces within this package,

• DataRepository - root of the hierarchy, allows the entity type to be specified as a type parameter.
• BasicRepository - provides common find, delete, and save operations.
• CrudRepository - extends the BasicRepository to add CrudRepository.insert(java.lang.Object) and CrudRepository.update(java.lang.Object) operations.

Repository interfaces can also define their own lifecycle methods using the Insert, Update, Save, and Delete annotations, as well as a variety of other methods following the Query by Method Name pattern, the Parameter-based Conditions pattern, and the Query annotation.

The module Javadoc provides an overview of Jakarta Data.

Related Packages

Package	Description
jakarta.data	Jakarta Data provides an API that simplifies data access.
jakarta.data.exceptions	Common data access exceptions.
jakarta.data.metamodel	A static metamodel for entities that are used in Jakarta Data repositories.
jakarta.data.page	Splits query results into pages.

Class	Description
BasicRepository<T,K>	A built-in repository supertype for performing basic operations on entities.
By	Annotates a parameter of a repository method, specifying a mapping to a persistent field:
CrudRepository<T,K>	A built-in repository supertype for performing Create, Read, Update, and Delete (CRUD) operations.
DataRepository<T,K>	A built-in repository supertype that is the root of all other built-in repository supertype interfaces.
Delete	Lifecycle annotation for repository methods which perform delete operations; alternatively, annotates a repository method as a parameter-based automatic query method which deletes entities.
Find	Annotates a repository method returning entities as a parameter-based automatic query method.
Insert	Lifecycle annotation for repository methods which perform insert operations.
OrderBy	Annotates a repository method to request sorting of results.
OrderBy.List	Enables multiple OrderBy annotations on the method.
Param	Annotates a parameter of a repository method to bind it to a named parameter of a Query.
Query	Annotates a repository method as a query method, specifying a query written in Jakarta Data Query Language (JDQL) or in Jakarta Persistence Query Language (JPQL).
Repository	Annotates a repository interface to be implemented by the container/runtime.
Save	Lifecycle annotation for repository methods which conditionally perform insert or update operations.
Update	Lifecycle annotation for repository methods which perform update operations.