Hibernate
/
hibernate-orm
mirror of https://github.com/hibernate/hibernate-orm
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

HHH-16302 Document all TimeZoneStorageType values in reference documentation

This commit is contained in:
Yoann Rodière 2023-03-14 13:32:55 +01:00
parent 1974abb6dc
commit 5b74011b7d
1 changed files with 15 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
documentation/src/main/asciidoc/userguide/appendices/Configurations.adoc
View File

@ -270,13 +270,23 @@ Assuming `hibernate.globally_quoted_identifiers` is `true`, this allows the glob
Specifies whether to automatically quote any names that are deemed keywords.
==== Time zone storage
`*hibernate.timezone.default_storage*` (e.g. `COLUMN`, `NATIVE`, `AUTO` or `NORMALIZE` (default value))::
`*hibernate.timezone.default_storage*` (e.g. `COLUMN`, `NATIVE`, `NORMALIZE`, `NORMALIZE_UTC`, `AUTO` or `DEFAULT` (default value))::
Global setting for configuring the default storage for the time zone information for time zone based types.
+
`NORMALIZE`::: Does not store the time zone information, and instead normalizes timestamps to UTC
`COLUMN`::: Stores the time zone information in a separate column; works in conjunction with `@TimeZoneColumn`
`NATIVE`::: Stores the time zone information by using the `with time zone` type. Error if `Dialect#getTimeZoneSupport()` is not `NATIVE`
`NORMALIZE`:::
Legacy behavior (Hibernate ORM 5).
+
Does not store the time zone information, and instead:
+
* when persisting to the database, normalizes JDBC timestamps to the
<<jdbc-time-zone,JDBC timezone>> 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.
`NORMALIZE_UTC`::: Does not store the time zone information, and instead normalizes timestamps to UTC.
`COLUMN`::: Stores the time zone information in a separate column; works in conjunction with `@TimeZoneColumn`.
`NATIVE`::: Stores the time zone information by using the `with time zone` type. Error if `Dialect#getTimeZoneSupport()` is not `NATIVE`.
`AUTO`::: Stores the time zone information either with `NATIVE` if `Dialect#getTimeZoneSupport()` is `NATIVE`, otherwise uses the `COLUMN` strategy.
`DEFAULT`::: Stores the time zone information either with `NATIVE` if `Dialect#getTimeZoneSupport()` is `NATIVE`, otherwise uses the `NORMALIZE_UTC` strategy.
+
The default value is given by the {@link org.hibernate.annotations.TimeZoneStorageType#NORMALIZE},
meaning that time zone information is not stored by default, but timestamps are normalized instead.
@ -374,7 +384,7 @@ Enable nationalized character support on all string / clob based attribute ( str
`*hibernate.jdbc.lob.non_contextual_creation*` (e.g. `true` or `false` (default value))::
Should we not use contextual LOB creation (aka based on `java.sql.Connection#createBlob()` et al)? The default value for HANA, H2, and PostgreSQL is `true`.
`*hibernate.jdbc.time_zone*` (e.g. A `java.util.TimeZone`, a `java.time.ZoneId` or a `String` representation of a `ZoneId`)::
[[jdbc-time-zone]]`*hibernate.jdbc.time_zone*` (e.g. A `java.util.TimeZone`, a `java.time.ZoneId` or a `String` representation of a `ZoneId`)::
Unless specified, the JDBC Driver uses the default JVM time zone. If a different time zone is configured via this setting, the JDBC https://docs.oracle.com/javase/8/docs/api/java/sql/PreparedStatement.html#setTimestamp-int-java.sql.Timestamp-java.util.Calendar-[PreparedStatement#setTimestamp] is going to use a `Calendar` instance according to the specified time zone.
`*hibernate.dialect.oracle.prefer_long_raw*` (e.g. `true` or `false` (default value))::