Package org.hibernate.annotations

Annotation Interface TimeZoneColumn

@Incubating @Retention(RUNTIME) @Target({FIELD,METHOD}) public @interface TimeZoneColumn
Specifies the mapped column for storing the time zone information, for use in conjunction with TimeZoneStorageType.COLUMN or TimeZoneStorageType.AUTO. The column is simply ignored if AUTO is used and the database supports native time zone storage.
Since:
6.0
See Also:

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    columnDefinition
    (Optional) The SQL fragment that is used when generating the DDL for the column.
    String
    comment
    (Optional) A comment to be applied to the column.
    boolean
    insertable
    (Optional) Whether the column is included in SQL INSERT statements generated by the persistence provider.
    String
    name
    (Optional) The name of the column.
    String
    options
    (Optional) The SQL fragment that is used when generating the DDL for the column.
    String
    table
    (Optional) The name of the table that contains the column.
    boolean
    updatable
    (Optional) Whether the column is included in SQL UPDATE statements generated by the persistence provider.

  • Element Details

    • name

      String name
      (Optional) The name of the column. Defaults to the property or field name, suffixed by _tz.
      Default:
      ""

    • insertable

      boolean insertable
      (Optional) Whether the column is included in SQL INSERT statements generated by the persistence provider.
      Default:
      true

    • updatable

      boolean updatable
      (Optional) Whether the column is included in SQL UPDATE statements generated by the persistence provider.
      Default:
      true

    • columnDefinition

      String columnDefinition
      (Optional) The SQL fragment that is used when generating the DDL for the column.

      Defaults to the generated SQL to create a column of the inferred type.

      Default:
      ""

    • table

      String table
      (Optional) The name of the table that contains the column. If absent the column is assumed to be in the primary table.
      Default:
      ""

    • options

      String options
      (Optional) The SQL fragment that is used when generating the DDL for the column.

      The DDL must be written in the native SQL dialect of the target database (it is not portable across databases).

      Since:
      7.0
      Default:
      ""

    • comment

      String comment
      (Optional) A comment to be applied to the column.
      Since:
      7.0
      Default:
      ""