Registering a SQL function with JPA and Hibernate

by

You might read articles telling you to register the SQL function by extending the Hibernate Dialect, but that’s a naive solution.

Since Hibernate ORM 5.2.18 and 5.3.1, the best way to register a SQL function is to supply a MetadataBuilderContributor like this:

public class SqlFunctionsMetadataBuilderContributor 
        implements MetadataBuilderContributor {
         
    @Override
    public void contribute(MetadataBuilder metadataBuilder) {
        metadataBuilder.applySqlFunction(
            "group_concat",
            new StandardSQLFunction(
                "group_concat", 
                StandardBasicTypes.STRING
            )
        );
    }
}

Which you can pass to Hibernate via the hibernate.metadata_builder_contributor configuration property:

<property>
    name="hibernate.metadata_builder_contributor" 
    value="com.vladmihalcea.book.hpjp.hibernate.query.function.SqlFunctionsMetadataBuilderContributor"
</property>

Or, if you bootstrap Hibernate natively, you can just apply the SQL function to the MetadataBuilder during bootstrap.

More Related Contents:

  1. java.lang.ClassCastException: java.lang.String cannot be cast to
  2. How to solve the “failed to lazily initialize a collection of role” Hibernate exception
  3. What is the proper way to re-attach detached objects in Hibernate?
  4. No Dialect mapping for JDBC type: 1111
  5. Annotation @Transactional. How to rollback?
  6. How to set up default schema name in JPA configuration?
  7. Transaction marked as rollback only: How do I find the cause
  8. Transactional saves without calling update method
  9. Spring data JPA and hibernate detached entity passed to persist on ManyToMany relationship
  10. Hibernate could not fetch the SequenceInformation from the database
  11. Need to reset the value of sequence in Oracle
  12. Do you need a database transaction for reading data?
  13. Java / Hibernate – Write operations are not allowed in read-only mode
  14. When are connections returned to the connection pool with Spring JPA (Hibernate) Entity Manager?
  15. Manually call Spring Annotation Validation
  16. Difference between save and saveAndFlush in Spring data jpa
  17. The onFlushDirty Hibernate Interceptor method is never called
  18. spring data jpa @query and pageable
  19. compatibility of spring 4.0.0 with hibernate 4.30 [duplicate]
  20. Hibernate, spring, JPS & isolation – custom isolation not supported
  21. Why HibernateTemplate isn’t recommended? [duplicate]
  22. HibernateException: Couldn’t obtain transaction-synchronized Session for current thread
  23. Error creating bean with name ‘entityManagerFactory
  24. Hibernate: CRUD Generic DAO
  25. Mapping JPA or Hibernate projection query to DTO (Data Transfer Object)
  26. java.lang.IllegalStateException: No transactional EntityManager available
  27. FetchMode join makes no difference for ManyToMany relations in spring JPA repositories
  28. org.dbunit.dataset.NoSuchTableException: Did not find table ‘xxx’ in schema ‘null’
  29. Autowired Repository is Null in Custom Constraint Validator
  30. How to find distinct rows with field in list using JPA and Spring?

Leave a Comment