Top Description Methods
org.hibernate.annotations

public @Interface RowId

extends Annotation
Annotations
@Target:TYPE
@Retention:RUNTIME
Imports
java.lang.annotation.Retention, .Target
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.

Author
Steve Ebersole
See Also
org.hibernate.dialect.Dialect#rowId

Method Summary

Modifier and TypeMethod and Description
public String
value()

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

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

valueback to summary
public 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 org.hibernate.dialect.Dialect#rowId, and so this member is now usually ignored. The exception is for certain flavors of DB2.