Tag Usage, Class Level (@hibernate)

@hibernate.class (0..1)

Declare a persistent class

Parameter Type Applicability Description Mandatory
table text The name of its database table false
discriminator-value text A value that distiguishes the particular subclass false
mutable text Specifies that instances of the class are (not) mutable
Valid options are:

true

false
false
dynamic-update bool Specifies that only changed columns should appear in the SQL UPDATE false
dynamic-insert bool Specifies that null columns should not appear in the SQL INSERT false
polymorphism text Enable "explicit" polymorphism
Valid options are:

explicit

implicit
false
schema text Override the schema name specified by the root hibernate-mapping element false
proxy text Specifies an interface to use for CGLIB proxies false

@hibernate.subclass (0..1)

Declare the current class as subclass

Parameter Type Applicability Description Mandatory
discriminator-value text A value that distiguishes the particular subclass false
proxy text Specifies an interface to use for CGLIB proxies false
dynamic-update bool Specifies that only changed columns should appear in the SQL UPDATE false
dynamic-insert bool Specifies that null columns should not appear in the SQL INSERT false

@hibernate.discriminator (0..1)

Defines a discriminator

Parameter Type Applicability Description Mandatory
column text The name of the mapped database table column true
type text The Hibernate type false
length text The length of the mapped database table column false

@hibernate.joined-subclass (0..1)

Declare the current class as joined subclass

Parameter Type Applicability Description Mandatory
proxy text Specifies an interface to use for CGLIB proxies false
dynamic-update bool Specifies that only changed columns should appear in the SQL UPDATE false
dynamic-insert bool Specifies that null columns should not appear in the SQL INSERT false
schema text Override the schema name specified by the root hibernate-mapping element false
proxy text Specifies an interface to use for CGLIB proxies false

@hibernate.joined-subclass-key (0..1)

Declares a joined-subclass key

Parameter Type Applicability Description Mandatory
column text The name of the mapped database table column true

@hibernate.jcs-cache (0..1)

Enables caching

Parameter Type Applicability Description Mandatory
usage text Defines the cache semantics
Valid options are:

read-write

nonstrict-read-write

read-only
true

@hibernate.query (0..*)

Declare a named query for class

Parameter Type Applicability Description Mandatory
name text Name of this query true
query text Query contents true

Tag Usage, Method Level (@hibernate)

@hibernate.id (0..1)

Declares an identifier property

Parameter Type Applicability Description Mandatory
column text The name of the mapped database table column false
type text The Hibernate type false
length text The length of the mapped database table column false
unsaved-value text A value that distinguishes transient instances with existing persistent state from new transient instances false
generator-class text The key generator class
Valid options are:

uuid.hex

uuid.string

increment

assigned

native

identity

sequence

hilo

seqhilo

foreign
true

@hibernate.generator-param (0..*)

Specifies an id generator parameter value

Parameter Type Applicability Description Mandatory
name text The name of the parameter true
value text The parameter value true

@hibernate.property (0..1)

Defines a property

Parameter Type Applicability Description Mandatory
column text The name of the mapped database table column false
type text The Hibernate type false
length text The length of the mapped database table column false
not-null bool If the column is not nullable false
unique bool If the column is unique false
insert bool Should the column appear in the SQL INSERT false
update bool Should the column appear in the SQL UPDATE false

@hibernate.component (0..1)

Declares a component

Parameter Type Applicability Description Mandatory
class text A fully qualified class name false

@hibernate.version (0..1)

Declares a version property

Parameter Type Applicability Description Mandatory
column text The name of a column holding the version number false
type text The Hibernate type
Valid options are:

integer

short

long

timestamp

calendar
false

@hibernate.timestamp (0..1)

Declares a timestamp property

Parameter Type Applicability Description Mandatory
column text The name of an column holding the timestamp false

@hibernate.many-to-one (0..1)

Declares a many-to-one association

Parameter Type Applicability Description Mandatory
column text The name of the mapped database table column false
class text The name of the associated class false
cascade text Specifies which operations should be cascaded from the parent object to the associated object
Valid options are:

all

none

save-update

delete
false
not-null bool If the column is not nullable false
unique bool If the column is unique false
outer-join text Enable outer-join fetching
Valid options are:

true

false

auto
false
insert bool Should the column appear in the SQL INSERT false
update bool Should the column appear in the SQL UPDATE false

@hibernate.one-to-one (0..1)

Declares a one-to-one association

Parameter Type Applicability Description Mandatory
class text The name of the associated class false
constrained bool Is there a foreign key constraint false
cascade text Specifies which operations should be cascaded from the parent object to the associated object
Valid options are:

all

none

save-update

delete
false
outer-join bool Enable outer-join fetching for this association when hibernate.use_outer_join is set
Valid options are:

true

false

auto
false

@hibernate.column (0..*)

Customize column mapping

Parameter Type Applicability Description Mandatory
name text The column name true
length text The column length false
unique bool Is the column unique false
not-null bool Is the column nullable false
index text The name of an index false
unique-key text The name of a unique constraint false
sql-type text The SQL column type false

@hibernate.set (0..1)

Defines a set

Parameter Type Applicability Description Mandatory
inverse bool If inverse collection false
table text Defaults to role name: the name of the collection table (not used for one-to-many associations) false
schema text The name of a table schema to override the schema declared false
lazy bool Enable lazy initialization false
cascade text Specifies which operations should be cascaded from the parent object to the associated object
Valid options are:

all

none

save-update

delete
false
sort text Specify a sorted collection with natural sort order or a given comparator class false
order-by text Specify table columns that define the iteration order false
where text An SQL WHERE condition false

@hibernate.bag (0..1)

Defines a bag

Parameter Type Applicability Description Mandatory
inverse bool If inverse collection false
table text The name of the collection table (not used for one-to-many associations) false
schema text The name of a table schema to override the schema declared false
lazy bool Enable lazy initialization false
cascade text Specifies, which operations should be cascaded from the parent object to the associated object
Valid options are:

all

none

save-update

delete
false
order-by text Specify table columns that define the iteration order false
where text An SQL WHERE condition false

@hibernate.list (0..1)

Defines a List

Parameter Type Applicability Description Mandatory
table text The name of the collection table (not used for one-to-many associations) false
schema text The name of a table schema to override the schema declared false
lazy bool Enable lazy initialization false
cascade text Specifies which operations should be cascaded from the parent object to the associated objects
Valid options are:

all

none

save-update

delete
false
where text An SQL WHERE condition false

@hibernate.map (0..1)

Defines a map

Parameter Type Applicability Description Mandatory
table text The name of the collection table (not used for one-to-many associations) false
schema text The name of a table schema to override the schema declared false
lazy bool Enable lazy initialization false
cascade text Specifies which operations should be cascaded from the parent object to the associated object
Valid options are:

all

save-update

delete

none
false
sort text Specify a sorted collection with natural sort order or a given comparator class false
order-by text Specify table columns that define the iteration order false
where text An SQL WHERE condition false

@hibernate.array (0..1)

Defines an array

Parameter Type Applicability Description Mandatory
table text The name of the collection table (not used for one-to-many associations) false
schema text The name of a table schema to override the schema declared false
cascade text Specifies which operations should be cascaded from the parent object to the associated object
Valid options are:

all

none

save-update

delete
false
where text An SQL WHERE condition false

@hibernate.primitive-array (0..1)

Defines a primitive-array

Parameter Type Applicability Description Mandatory
table text The name of the collection table (not used for one-to-many associations) false
schema text The name of a table schema to override the schema declared false
cascade text Specifies which operations should be cascaded from the parent object to the associated object
Valid options are:

all

none

save-update

delete
false
where text An SQL WHERE condition false

@hibernate.collection-key (0..1)

Declares a collection key

Parameter Type Applicability Description Mandatory
column text The name of the mapped database table column true

@hibernate.collection-index (0..1)

Declares a collection index

Parameter Type Applicability Description Mandatory
column text The name of the mapped database table column true
type text The Hibernate type false
length text The length of the mapped database table column false

@hibernate.collection-element (0..1)

Declares a collection element

Parameter Type Applicability Description Mandatory
column text The name of the mapped database table column true
type text The Hibernate type true
length text The length of the mapped database table column false
not-null bool Is the column nullable false
unique bool Is the column unique false

@hibernate.composite-element (0..1)

Declares a composite collection element

Parameter Type Applicability Description Mandatory
class text The name of the element class true

@hibernate.collection-many-to-many (0..1)

Declares a many-to-many relationship

Parameter Type Applicability Description Mandatory
column text The name of the mapped database table column true
class text Fully qualified class name false
outer-join text Enable outer-join fetching
Valid options are:

true

false

auto
false

@hibernate.collection-one-to-many (0..1)

Declares a one-to-many relationship

Parameter Type Applicability Description Mandatory
class text Fully qualified class name of the associated class false

@hibernate.collection-jcs-cache (0..1)

Enables caching

Parameter Type Applicability Description Mandatory
usage text Defines the cache semantics
Valid options are:

read-write

nonstrict-read-write

read-only
true