Hibernate is an Object Relational Mapper (ORM). It provides a framework for mapping an object-oriented domain model to a relational database.


This module adds support for the Transactional annotation as well as setting up an EntityManager provider pre-configured with all the data sources configured via the datasource module. There is no special configuration to apply, just add the voidframework-persistence-hibernate module to the pom.xml file of your project.



The following configuration key can be used in the configuration file of your application.

  • voidframework.persistence.modelsJarUrlPattern Pattern to select Jar to scan to find models. For more information, see below the section “Speed-up PersistenceEntityFactory initialization time”. Default value is auto.
  • voidframework.datasource.default.dialect the Redis server host. Default value is null.

Working with transaction manually

final EntityManager entityManager = this.entityManagerProvider.get();
final EntityTransaction transaction = entityManager.getTransaction();

/* insert/update/delete operations */

Identifier generator

Identifier typeAssignable toIdentifier generator annotation
CUIDCUID, String, byte[]@CuidGenerator
UUIDUUID, String, byte[]@UuidGenerator


@Table(name = "NEWS")
public class NewsModel extends Model {

    @Column(name = "ID", updatable = false, nullable = false)
    private UUID id;

    @Column(name = "TITLE", nullable = false)
    private String title;

    @Column(name = "CONTENT", nullable = false)
    private String content;

    @Column(name = "PUBLISHED_AT", columnDefinition = "TIMESTAMP", updatable = false, nullable = false)
    private LocalDateTime publishedAt;

    public String toString() {
        return this.getClass().getName() + "[id=" + this.id + "]";

    public String getTitle() {
        return title;

    public void setTitle(final String title) {
        this.title = title;

    public String getContent() {
        return content;

    public void setContent(final String content) {
        this.content = content;

    public LocalDateTime getPublishedAt() {
        return publishedAt;

    public void setPublishedAt(final LocalDateTime publishedAt) {
        this.publishedAt = publishedAt;
public class NewsRepositoryImpl implements NewsRepository {

    private final Conversion conversion;
    private final Provider<EntityManager> entityManagerProvider;

    public NewsRepositoryImpl(final Conversion conversion,
                              final Provider<EntityManager> entityManagerProvider) {
        this.conversion = conversion;
        this.entityManagerProvider = entityManagerProvider;

    public List<News> findTop10ByPublishedAtBeforeNowOrderByPublishedAtDesc() {
        final List<NewsModel> newsModelList = entityManagerProvider.get()
                .createQuery("SELECT x FROM NewsModel x WHERE x.publishedAt <= CURRENT_TIMESTAMP ORDER BY x.publishedAt DESC, x.id ASC", NewsModel.class)

        return conversion.convert(newsModelList, NewsModel.class, News.class);

Speed-up PersistenceEntityFactory initialization time

By default, Void Framework tells the PersistenceEntityFactory to scan all JARs of the application’s and dependencies. This scan is necessary to detect models. If you want to greatly improve this initialization time, it is advisable to set the voidframework.persistence.modelsJarUrlPattern configuration key to indicate which JARs to keep. The could be null, a regular expression, or auto (default value).

If the configuration is set to null, only the current JAR / classpath (when started in IDE) will be used. auto is like using the regular expression (.*).