|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: REQUIRED | OPTIONAL | DETAIL: ELEMENT |
@Target(value={TYPE,METHOD,FIELD}) @Retention(value=RUNTIME) public @interface TableGenerator
The TableGenerator annotation defines a primary key generator that may be referenced by name when a generator element is specified for the GeneratedValue annotation. A table generator may be specified on the entity class or on the primary key field or property. The scope of the generator name is global to the persistence unit (across all generator types).
Required Element Summary | |
---|---|
java.lang.String |
name
(Required) A unique generator name that can be referenced by one or more classes to be the generator for id values. |
Optional Element Summary | |
---|---|
int |
allocationSize
(Optional) The amount to increment by when allocating id numbers from the generator. |
java.lang.String |
catalog
(Optional) The catalog of the table. |
int |
initialValue
(Optional) The value used to initialize the column that stores the last value generated. |
java.lang.String |
pkColumnName
(Optional) Name of the primary key column in the table. |
java.lang.String |
pkColumnValue
(Optional) The primary key value in the generator table that distinguishes this set of generated values from others that may be stored in the table. |
java.lang.String |
schema
(Optional) The schema of the table. |
java.lang.String |
table
(Optional) Name of table that stores the generated id values. |
UniqueConstraint[] |
uniqueConstraints
(Optional) Unique constraints that are to be placed on the table. |
java.lang.String |
valueColumnName
(Optional) Name of the column that stores the last value generated. |
Element Detail |
---|
public abstract java.lang.String name
public abstract java.lang.String table
public abstract java.lang.String catalog
public abstract java.lang.String schema
public abstract java.lang.String pkColumnName
public abstract java.lang.String valueColumnName
public abstract java.lang.String pkColumnValue
public abstract int initialValue
public abstract int allocationSize
public abstract UniqueConstraint[] uniqueConstraints
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: REQUIRED | OPTIONAL | DETAIL: ELEMENT |