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).
Example 1:
@Entity public class Employee {
...
@TableGenerator(
name="empGen",
table="ID_GEN",
pkColumnName="GEN_KEY",
valueColumnName="GEN_VALUE",
pkColumnValue="EMP_ID",
allocationSize=1)
@Id
@GeneratedValue(strategy=TABLE, generator="empGen")
int id;
...
}
Example 2:
@Entity public class Address {
...
@TableGenerator(
name="addressGen",
table="ID_GEN",
pkColumnName="GEN_KEY",
valueColumnName="GEN_VALUE",
pkColumnValue="ADDR_ID")
@Id
@GeneratedValue(strategy=TABLE, generator="addressGen")
int id;
...
}
GeneratedValue
| Modifier and Type | Method and Description |
|---|---|
| public int | allocationSize()
(Optional) The amount to increment by when allocating id numbers from the generator. |
| public String | |
| public Index[] | |
| public int | initialValue()
(Optional) The initial value to be used to initialize the column that stores the last value generated. |
| public String | name()
(Required) A unique generator name that can be referenced by one or more classes to be the generator for id values. |
| public String | |
| public 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. |
| public String | |
| public String | |
| public UniqueConstraint[] | |
| public String |
| allocationSize | back to summary |
|---|---|
| public int allocationSize() (Optional) The amount to increment by when allocating id numbers from the generator. | |
| catalog | back to summary |
|---|---|
| public String catalog() (Optional) The catalog of the table. Defaults to the default catalog. | |
| indexes | back to summary |
|---|---|
| public Index[] indexes() (Optional) Indexes for the table. These are only used if table generation is in effect. Note that it is not necessary to specify an index for a primary key, as the primary key index will be created automatically.
| |
| initialValue | back to summary |
|---|---|
| public int initialValue() (Optional) The initial value to be used to initialize the column that stores the last value generated. | |
| name | back to summary |
|---|---|
| public String name() (Required) A unique generator name that can be referenced by one or more classes to be the generator for id values. | |
| pkColumnName | back to summary |
|---|---|
| public String pkColumnName() (Optional) Name of the primary key column in the table. Defaults to a provider-chosen name. | |
| pkColumnValue | back to summary |
|---|---|
| public 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. Defaults to a provider-chosen value to store in the primary key column of the generator table | |
| schema | back to summary |
|---|---|
| public String schema() (Optional) The schema of the table. Defaults to the default schema for user. | |
| table | back to summary |
|---|---|
| public String table() (Optional) Name of table that stores the generated id values. Defaults to a name chosen by persistence provider. | |
| uniqueConstraints | back to summary |
|---|---|
| public UniqueConstraint[] uniqueConstraints() (Optional) Unique constraints that are to be placed on the table. These are only used if table generation is in effect. These constraints apply in addition to primary key constraints. Defaults to no additional constraints. | |
| valueColumnName | back to summary |
|---|---|
| public String valueColumnName() (Optional) Name of the column that stores the last value generated. Defaults to a provider-chosen name. | |