Annotation Type RowId


  • @Target(TYPE)
    @Retention(RUNTIME)
    public @interface RowId
    Specifies that a rowid-like column or pseudo-column should be used as the row locator in CRUD operations for an entity, instead of the primary key of the table.

    If the SQL dialect does not support some sort of rowid-like column or pseudo-column, then this annotation is ignored, and the primary key is used as the row locator.

    See Also:
    Dialect.rowId(java.lang.String)
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      String value
      Specifies the name of the rowid-like column for databases where the column is declared explicitly in DDL.
    • Element Detail

      • value

        String value
        Specifies the name of the rowid-like column for databases where the column is declared explicitly in DDL.

        It is not necessary to specify the name for databases where the rowid-like value is an implicitly-existing pseudo-column, and on those databases, this annotation member is ignored.

        API Note:
        Previously, this annotation member was required. But the name of the column it is now usually determined by calling Dialect.rowId(java.lang.String), and so this member is now usually ignored. The exception is for certain flavors of DB2.
        Default:
        ""