Package io.helidon.data

package io.helidon.data

Helidon Data Repository.

Helidon Data provides a unified repository API for database operations. Repository interfaces are translated into implementing classes at compile time.

A repository interface can extend Data.GenericRepository to identify its entity and identifier types. A persistence provider may also support repository interfaces annotated with Data.Repository that do not declare these types at the repository level.

Depending on the persistence provider, repository operations can be defined in three ways:

• annotating a method with Data.Query
• deriving a query from the method name
• extending a standard repository interface that provides common operations or capabilities:
  • Data.BasicRepository for a basic set of entity operations
  • Data.CrudRepository for entity CRUD operations
  • Data.PageableRepository for pageable alternatives to Data.BasicRepository.findAll()
  • Data.SessionRepository for access to a persistence provider session, such as jakarta.persistence.EntityManager

This is a preview feature of Helidon - it is ready for production use, but we reserve the rights to change APIs without the usual deprecation process. This feature will be backward compatible within a major version of Helidon.

Related Packages

Module	Package	Description
io.helidon	io.helidon	Startup of Helidon applications.
io.helidon.data.codegen	io.helidon.data.codegen	Code processing and generation with Helidon Data API.
io.helidon.data.jdbc	io.helidon.data.jdbc	Runs imperative applications and declarative Helidon Data repositories with JDBC.

Class	Description
Data	Helidon Data Repository annotations and interfaces.
Data.BasicRepository<E,ID>	Data repository interface for basic entity operations.
Data.CrudRepository<E,ID>	Data repository interface for CRUD entity operations.
Data.GenericRepository<E,ID>	Marker interface for a data repository that declares an entity type and its identifier type.
Data.PageableRepository<E,ID>	A Data.GenericRepository that supports pagination.
Data.PersistenceUnit	Repository persistence unit name.
Data.Provider	Provider used to implement the repository.
Data.ProviderType	Qualifier used in generated code to reference which provider type to use when creating instances of repositories, such as eclipselink, jakarta, sql.
Data.Query	User supplied query.
Data.Repository	Repository interface.
Data.SessionRepository<S>	Data repository interface with persistence provider session support.
DataException	A RuntimeException that indicates an operation on a data repository has failed.
EntityExistsException	Thrown when persistence entity being inserted already exists.
EntityNotFoundException	Thrown when requested persistence entity cannot be found.
NonUniqueResultException	Thrown when a query was expected to produce exactly one record but produced many instead.
NoResultException	Thrown when a query was expected to produce a result, but did not.
OptimisticLockException	Thrown when an optimistic locking conflict occurs.
Order	Single rule of the dynamic ordering of the query result.
Order.Builder	Fluent API builder for Order.
Order.BuilderBase<BUILDER extends Order.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends Order>	Fluent API builder base for Order.
Order.BuilderBase.OrderImpl	Generated implementation of the prototype, can be extended by descendant prototype implementations.
OrderDirection	Direction of the query result ordering.
Page<T>	Pageable query result as pages with total size of the result.
PageRequest	Request pageable query result as page with page number and size.
PageRequest.Builder	Fluent API builder for PageRequest.
PageRequest.BuilderBase<BUILDER extends PageRequest.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends PageRequest>	Fluent API builder base for PageRequest.
PageRequest.BuilderBase.PageRequestImpl	Generated implementation of the prototype, can be extended by descendant prototype implementations.
Slice<T>	Pageable query result as pages without total size of the result.
Sort	Dynamic ordering of the query result.
Sort.Builder	Fluent API builder for Sort.
Sort.BuilderBase<BUILDER extends Sort.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends Sort>	Fluent API builder base for Sort.
Sort.BuilderBase.SortImpl	Generated implementation of the prototype, can be extended by descendant prototype implementations.