Hibernate mapping between PostgreSQL enum and Java enum

by

You can simply get these types via Maven Central using the Hypersistence Util dependency:

<dependency>
    <groupId>io.hypersistence</groupId>
    <artifactId>hypersistence-utils-hibernate-55</artifactId>
    <version>${hibernate-types.version}</version>
</dependency>

If you easily map Java Enum to a PostgreSQL Enum column type using the following custom Type:

public class PostgreSQLEnumType extends org.hibernate.type.EnumType {
     
    public void nullSafeSet(
            PreparedStatement st, 
            Object value, 
            int index, 
            SharedSessionContractImplementor session) 
        throws HibernateException, SQLException {
        if(value == null) {
            st.setNull( index, Types.OTHER );
        }
        else {
            st.setObject( 
                index, 
                value.toString(), 
                Types.OTHER 
            );
        }
    }
}

To use it, you need to annotate the field with the Hibernate @Type annotation as illustrated in the following example:

@Entity(name = "Post")
@Table(name = "post")
@TypeDef(
    name = "pgsql_enum",
    typeClass = PostgreSQLEnumType.class
)
public static class Post {
 
    @Id
    private Long id;
 
    private String title;
 
    @Enumerated(EnumType.STRING)
    @Column(columnDefinition = "post_status_info")
    @Type( type = "pgsql_enum" )
    private PostStatus status;
 
    //Getters and setters omitted for brevity
}

This mapping assumes you have the post_status_info enum type in PostgreSQL:

CREATE TYPE post_status_info AS ENUM (
    'PENDING', 
    'APPROVED', 
    'SPAM'
)

That’s it. Here’s a test on GitHub that proves it.

More Related Contents:

  1. Postgresql UUID supported by Hibernate?
  2. How to supply Enum value to an annotation from a Constant in Java
  3. Hibernate use of PostgreSQL sequence does not affect sequence table
  4. Use Enum type as a value parameter for @RolesAllowed-Annotation
  5. Java String validation using enum values and annotation
  6. Does Spring @Transactional attribute work on a private method?
  7. How to supply value to an annotation from a Constant java
  8. Why is it not possible to extend annotations in Java?
  9. @Resource vs @Autowired
  10. Can someone explain mappedBy in JPA and Hibernate?
  11. Why does JPA have a @Transient annotation?
  12. annotation to make a private method public only for test classes [duplicate]
  13. What is the most recommended way to store time in PostgreSQL using Java?
  14. Hibernate table not mapped error in HQL query
  15. Why would an Enum implement an Interface?
  16. How to read all rows from huge table?
  17. Java Generics and Enum, loss of template parameters
  18. Java enum – why use toString instead of name
  19. Why can’t enums be declared locally in a method?
  20. Can I set enum start value in Java?
  21. Override valueof() and toString() in Java enum
  22. Pick a random value from an enum?
  23. XML data to PostgreSQL database [closed]
  24. how to copy data from file to PostgreSQL using JDBC?
  25. Why can’t enum constructors be protected or public in Java?
  26. Spring annotation-based DI vs xml configuration?
  27. No operator matches the given name and argument type(s). You might need to add explicit type casts. — Netbeans, Postgresql 8.4 and Glassfish
  28. Postgres Interval not working with native spring data JPA query
  29. How to enable enum inheritance
  30. How to use Postgres JSONB datatype with JPA?

Leave a Comment