Enum TimeZoneStorageType
- java.lang.Object
-
- java.lang.Enum<TimeZoneStorageType>
-
- org.hibernate.annotations.TimeZoneStorageType
-
- All Implemented Interfaces:
Serializable
,Comparable<TimeZoneStorageType>
@Incubating public enum TimeZoneStorageType extends Enum<TimeZoneStorageType>
Describes the storage of timezone information for zoned datetime types, in particular, for the typesOffsetDateTime
andZonedDateTime
.A default
TimeZoneStorageType
may be configured explicitly using "hibernate.timezone.default_storage". Otherwise, the storage type may be overridden for a given field or property of an entity using theTimeZoneStorage
annotation.In choosing a
TimeZoneStorageType
we must consider whether a round trip to the database, writing and then reading a zoned datetime, preserves:- the instant represented by the zoned datetime, and/or
- the offset or zone in which the instant is represented.
We must also consider the physical representation of the zoned datetime in the database table.
The default strategy guarantees that a round trip preserves the instant. Whether the zone or offset is preserved depends on whether the underlying database has a
timestamp with time zone
type which preserves offsets:- if the database does indeed have such an ANSI-compliant type, then both instant and zone or offset are preserved by round trips, but
- if not, it's guaranteed that the physical representation is in UTC, so that datetimes retrieved from the database will be represented in UTC.
When this default strategy is not appropriate, recommended alternatives are:
AUTO
orCOLUMN
, which each guarantee that both instant and zone or offset are preserved by round trips on every platform, orNORMALIZE_UTC
, which guarantees that only the instant is preserved, and that datetimes retrieved from the database will always be represented in UTC.
- Since:
- 6.0
- See Also:
TimeZoneStorage
,TimeZoneStorageStrategy
-
-
Enum Constant Summary
Enum Constants Enum Constant Description AUTO
Stores the time zone either withNATIVE
ifDialect.getTimeZoneSupport()
isTimeZoneSupport.NATIVE
, otherwise uses theCOLUMN
strategy.COLUMN
Stores the time zone in a separate column; works in conjunction withTimeZoneColumn
.DEFAULT
Stores the time zone either withNATIVE
ifDialect.getTimeZoneSupport()
isTimeZoneSupport.NATIVE
, otherwise uses theNORMALIZE_UTC
strategy.NATIVE
Stores the timezone by using thewith time zone
SQL column type.NORMALIZE
Does not store the time zone, and instead: when persisting to the database, normalizes JDBC timestamps to the AvailableSettings.JDBC_TIME_ZONE or to the JVM default time zone if not set.NORMALIZE_UTC
Does not preserve the time zone, and instead normalizes timestamps to UTC.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static TimeZoneStorageType
valueOf(String name)
Returns the enum constant of this type with the specified name.static TimeZoneStorageType[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
NATIVE
public static final TimeZoneStorageType NATIVE
Stores the timezone by using thewith time zone
SQL column type.Error if
Dialect.getTimeZoneSupport()
is notTimeZoneSupport.NATIVE
.
-
NORMALIZE
public static final TimeZoneStorageType NORMALIZE
Does not store the time zone, and instead:- when persisting to the database, normalizes JDBC timestamps to the AvailableSettings.JDBC_TIME_ZONE or to the JVM default time zone if not set.
- when reading back from the database, sets the offset or zone
of
OffsetDateTime
/ZonedDateTime
values to the JVM default time zone.
Provided partly for backward compatibility with older versions of Hibernate.
-
NORMALIZE_UTC
public static final TimeZoneStorageType NORMALIZE_UTC
Does not preserve the time zone, and instead normalizes timestamps to UTC.The DDL column type depends on the setting "hibernate.type.preferred_instant_jdbc_type".
-
COLUMN
public static final TimeZoneStorageType COLUMN
Stores the time zone in a separate column; works in conjunction withTimeZoneColumn
.
-
AUTO
public static final TimeZoneStorageType AUTO
Stores the time zone either withNATIVE
ifDialect.getTimeZoneSupport()
isTimeZoneSupport.NATIVE
, otherwise uses theCOLUMN
strategy.This option automatically picks an appropriate strategy for the database dialect which preserves both the instant represented by a zoned datetime type, and the offset or timezone.
-
DEFAULT
public static final TimeZoneStorageType DEFAULT
Stores the time zone either withNATIVE
ifDialect.getTimeZoneSupport()
isTimeZoneSupport.NATIVE
, otherwise uses theNORMALIZE_UTC
strategy.This option automatically picks an appropriate strategy for the database dialect which preserves the instant represented by a zoned datetime type. It does not promise that the offset or timezone is preserved by a round trip to the database.
- Since:
- 6.2
-
-
Method Detail
-
values
public static TimeZoneStorageType[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (TimeZoneStorageType c : TimeZoneStorageType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static TimeZoneStorageType valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
-