JPA attribute converters for JSR-310 dates and times
Java Shell
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

ThreeTen JPA Maven Central Build Status

JPA attribute converters for JSR-310 (Java 8) dates and times.

This project was stop gap measure until JPA_SPEC-63 was fixed in JPA 2.2. However JSR-310 support in JPA is not ready for prime time. The project serves the following purposes:

  1. provide JSR-310 support for users on JPA 2.1
  2. provide support for additional JSR-310 data types not specified by JPA 2.2
  3. provide workarounds for driver bugs and missing driver features
  4. provide workarounds for JPA implementation bugs

We take inspiration from the JDBC 4.2 and currently support the following conversions:

ANSI SQL Java SE 8
DATE LocalDate
TIME LocalTime
TIMESTAMP LocalDateTime
TIMESTAMP WITH TIMEZONE OffsetTime (*)
TIMESTAMP WITH TIMEZONE ZonedDateTime (*)
INTERVAL YEAR TO MONTH Period (*)
INTERVAL DAY TO SECOND Duration (*)

(*) requires special extensions, see below

Not supported is converting TIME WITH TIMEZONE to OffsetTime because it seems not very useful.

This project requires Java SE 8 (for the date and time classes) and JPA 2.1 (for the attribute converters). Java SE 9 is supported as well.

This project is very similar to montanajava/jpaattributeconverters or perceptron8/datetime-jpa and can be used in much the same way.

Usage

<dependency>
    <groupId>com.github.marschall</groupId>
    <artifactId>threeten-jpa</artifactId>
    <version>1.11.0</version>
</dependency>
<persistence-unit>
    …
    <class>com.github.marschall.threeten.jpa.LocalTimeConverter</class>
    <class>com.github.marschall.threeten.jpa.LocalDateConverter</class>
    <class>com.github.marschall.threeten.jpa.LocalDateTimeConverter</class>
    …
</persistence-unit>
@Entity
public class SampleEntity {

  @Column
  private LocalDate localDate;

  @Column
  private LocalTime localTime;

  @Column
  private LocalDateTime localDateTime;
  
}

All the converters have set Converter#autoApply() to true so they're automatically applied to all entities in the same persistence unit.

Converters

You can find a complete list of all converters in the Javadoc

Time Zone Support

Time Zone Support is documented on the wiki.

Interval Support

Oracle Interval Support is documented on the wiki.

Hibernate 5.x

If you are on Hibernate 5.x and JDBC driver properly supports JDBC 4.2 we strongly recommend using the UserTypes from the threeten-jpa-jdbc42-hibernate subproject.

If your driver does not support JDBC 4.2 the hibernate-java8 module introduced in Hibernate 5.0.0 (no longer needed for Hibernate 5.2.0) provides functionality that is equivalent to threeten-jpa and we recommend you use the Hibernate support instead.

Project Structure

The project includes the following submodule:

  • threeten-jpa contains portable converters.
  • threeten-jpa-oracle-eclipselink contains extensions that work only with Oracle in combination with EclipseLink to map TIMESTAMP WITH TIMEZONE to ZonedDateTime or OffsetDateTime.
  • threeten-jpa-h2-eclipselink contains extensions that work only with H2 in combination with EclipseLink to map TIMESTAMP WITH TIMEZONE to OffsetDateTime.
  • threeten-jpa-mssql-eclipselink contains extensions that work only with SQL Server in combination with EclipseLink to map DATETIMEOFFSET to OffsetDateTime.
  • threeten-jpa-mssql-hibernate contains extensions that work only with SQL Server in combination with Hibernate to map DATETIMEOFFSET to OffsetDateTime.
  • threeten-jpa-oracle-hibernate contains extensions that work only with Oracle in combination with Hibernate to map TIMESTAMP WITH TIMEZONE to ZonedDateTime to OffsetDateTime.
  • threeten-jpa-jdbc42-hibernate contains extensions that work with any JDBC 4.2 compliant driver in combination with Hibernate. They map
  • TIMESTAMP WITH TIMEZONE to ZonedDateTime or OffsetDateTime
  • TIMESTAMP [ WITHOUT TIME ZONE ] to LocalDateTime
  • TIME to LocalTime
  • threeten-jpa-oracle-api contains stub Oracle classes. These are only used for compilation and not present at runtime.
  • threeten-jpa-oracle-impl contains the type conversion code from Oracle types to Java 8 types.
  • threeten-jpa-zoned-hibernate contains composite user types to support ZonedDateTime.

Tested with following JPA providers:

  • EclipseLink
  • Hibernate

OpenJPA does currently not yet support JPA 2.1.

Tested with the following databases:

  • Derby
  • Firebird
  • H2
  • HSQL
  • MariaDB
  • MySQL
  • Oracle
  • PostgreS
  • SQL Server

License

This project is licensed under the MIT license.