Package org.hibernate.annotations

Annotation Type Table

@Target(TYPE)
@Retention(RUNTIME)
@Repeatable(Tables.class)
public @interface Table

Complementary information for a table declared using the Table, or SecondaryTable annotation. Usually used only for secondary tables.

See Also:

Table, SecondaryTable

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
String	appliesTo	The name of the targeted table.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	checkConstraint	A check constraint, written in native SQL.
String	comment	Specifies comment to add to the generated DDL for the table.
FetchMode	fetch	Deprecated. This setting has no effect in Hibernate 6
ForeignKey	foreignKey	Deprecated. use SecondaryTable.foreignKey()
Index[]	indexes	Deprecated. use Table.indexes() or SecondaryTable.indexes()
boolean	inverse	Deprecated. use SecondaryRow.owned()
boolean	optional	Deprecated. use SecondaryRow.optional()
SQLDelete	sqlDelete	Deprecated. use SQLInsert.table() to specify the secondary table
SQLInsert	sqlInsert	Deprecated. use SQLInsert.table() to specify the secondary table
SQLUpdate	sqlUpdate	Deprecated. use SQLInsert.table() to specify the secondary table

Element Detail

appliesTo

String appliesTo

The name of the targeted table.

indexes

@Deprecated(since="6.0")
Index[] indexes

Deprecated.

use Table.indexes() or SecondaryTable.indexes()

Indexes.

Default:

{}

checkConstraint

String checkConstraint

A check constraint, written in native SQL.

Useful for secondary tables, otherwise use Check.

See Also:

Check

Default:

""

comment

String comment

Specifies comment to add to the generated DDL for the table.

Useful for secondary tables, otherwise use Comment.

See Also:

Comment

Default:

""

foreignKey

@Deprecated(since="6.0")
ForeignKey foreignKey

Deprecated.

use SecondaryTable.foreignKey()

Specifies a foreign key of a secondary table, which points back to the primary table.

Default:

@org.hibernate.annotations.ForeignKey(name="")

fetch

@Deprecated(since="6.2")
FetchMode fetch

Deprecated.

This setting has no effect in Hibernate 6

Default:

org.hibernate.annotations.FetchMode.JOIN

inverse

@Deprecated(since="6.2")
boolean inverse

Deprecated.

use SecondaryRow.owned()

If enabled, Hibernate will never insert or update the columns of the secondary table.

Only applies to secondary tables.

Default:

false

optional

@Deprecated(since="6.2")
boolean optional

Deprecated.

use SecondaryRow.optional()

If enabled, Hibernate will insert a row only if the columns of the secondary table would not all be null, and will always use an outer join to read the columns. Thus, by default, Hibernate avoids creating a row of null values.

"API Note:"

Only relevant for secondary tables

Default:

true

sqlInsert

@Deprecated(since="6.2")
SQLInsert sqlInsert

Deprecated.

use SQLInsert.table() to specify the secondary table

Defines a custom SQL insert statement.

Only applies to secondary tables.

Default:

@org.hibernate.annotations.SQLInsert(sql="")

sqlUpdate

@Deprecated(since="6.2")
SQLUpdate sqlUpdate

Deprecated.

use SQLInsert.table() to specify the secondary table

Defines a custom SQL update statement.

Only applies to secondary tables.

Default:

@org.hibernate.annotations.SQLUpdate(sql="")

sqlDelete

@Deprecated(since="6.2")
SQLDelete sqlDelete

Deprecated.

use SQLInsert.table() to specify the secondary table

Defines a custom SQL delete statement.

Only applies to secondary tables.

Default:

@org.hibernate.annotations.SQLDelete(sql="")