Jakarta EE 11.0.0 · jakarta.persistence.Column · APIdia, the JavaDoc alternative

Specifies the column mapped by the annotated persistent property or field.

If no Column annotation is explicitly specified, the default values apply.

Example 1:

@Column(name = "DESC", nullable = false, length = 512)
public String getDescription() { return description; }

Example 2:

@Column(name = "DESC",
        columnDefinition = "CLOB NOT NULL",
        table = "EMP_DETAIL")
@Lob
public String getDescription() { return description; }

Example 3:

@Column(name = "ORDER_COST", updatable = false, precision = 12, scale = 2)
public BigDecimal getCost() { return cost; }

Portable applications which make use of schema generation should explicitly specify the precision and scale of columns of type numeric or decimal.

Method Summary

Modifier and Type	Method and Description
public CheckConstraint[]	check() (Optional) Check constraints to be applied to the column.
public String	columnDefinition() (Optional) The SQL fragment that is used when generating the DDL for the column.
public String	comment() (Optional) A comment to be applied to the column.
public boolean	insertable() (Optional) Whether the column is included in SQL INSERT statements generated by the persistence provider.
public int	length() (Optional) The column length.
public String	name() (Optional) The name of the column.
public boolean	nullable() (Optional) Whether the database column is nullable.
public String	options() (Optional) A SQL fragment appended to the generated DDL which declares this column.
public int	precision() (Optional) The precision for a column of SQL type `decimal` or `numeric`, or of similar database-native type.
public int	scale() (Optional) The scale for a column of SQL type `decimal` or `numeric`, or of similar database-native type.
public int	secondPrecision() (Optional) The number of decimal digits to use for storing fractional seconds in a SQL `time` or `timestamp` column.
public String	table() (Optional) The name of the table that contains the column.
public boolean	unique() (Optional) Whether the column is a unique key.
public boolean	updatable() (Optional) Whether the column is included in SQL UPDATE statements generated by the persistence provider.

Inherited from java.lang.annotation.Annotation:: annotationType equals hashCode toString

Method Detail

check	back to summary
public CheckConstraint[] check() (Optional) Check constraints to be applied to the column. These are only used if table generation is in effect. Since 3.2

check

back to summary

public CheckConstraint[] check()

(Optional) Check constraints to be applied to the column. These are only used if table generation is in effect.

Since: 3.2

columnDefinition	back to summary
public String columnDefinition() (Optional) The SQL fragment that is used when generating the DDL for the column. Defaults to the generated SQL to create a column of the inferred type. The specified DDL must be written in the native SQL dialect of the target database, and is not portable across databases.

columnDefinition

back to summary

public String columnDefinition()

(Optional) The SQL fragment that is used when generating the DDL for the column.

Defaults to the generated SQL to create a column of the inferred type.

The specified DDL must be written in the native SQL dialect of the target database, and is not portable across databases.

comment	back to summary
public String comment() (Optional) A comment to be applied to the column. This is only used if table generation is in effect. Since 3.2

comment

back to summary

public String comment()

(Optional) A comment to be applied to the column. This is only used if table generation is in effect.

Since: 3.2

insertable	back to summary
public boolean insertable() (Optional) Whether the column is included in SQL INSERT statements generated by the persistence provider.

length back to summary

length	back to summary
public int length() (Optional) The column length. Applies only to columns whose type is parameterized by length, for example, `varchar` or `varbinary` types.

public int length()

(Optional) The column length.

Applies only to columns whose type is parameterized by length, for example, varchar or varbinary types.

name	back to summary
public String name() (Optional) The name of the column. Defaults to the property or field name.

nullable	back to summary
public boolean nullable() (Optional) Whether the database column is nullable.

options back to summary

options	back to summary
public String options() (Optional) A SQL fragment appended to the generated DDL which declares this column. May not be used in conjunction with `columnDefinition()`. The specified DDL must be written in the native SQL dialect of the target database, and is not portable across databases. Since 3.2

public String options()

(Optional) A SQL fragment appended to the generated DDL which declares this column. May not be used in conjunction with columnDefinition().

The specified DDL must be written in the native SQL dialect of the target database, and is not portable across databases.

Since: 3.2

precision back to summary

precision	back to summary
public int precision() (Optional) The precision for a column of SQL type `decimal` or `numeric`, or of similar database-native type. Applies only to columns of exact numeric type. The default value `0` indicates that a provider-determined precision should be inferred.

public int precision()

(Optional) The precision for a column of SQL type decimal or numeric, or of similar database-native type.

Applies only to columns of exact numeric type.

The default value 0 indicates that a provider-determined precision should be inferred.

scale back to summary

scale	back to summary
public int scale() (Optional) The scale for a column of SQL type `decimal` or `numeric`, or of similar database-native type. Applies only to columns of exact numeric type. The default value `0` indicates that a provider-determined scale should be inferred.

public int scale()

(Optional) The scale for a column of SQL type decimal or numeric, or of similar database-native type.

Applies only to columns of exact numeric type.

The default value 0 indicates that a provider-determined scale should be inferred.

secondPrecision back to summary

secondPrecision	back to summary
public int secondPrecision() (Optional) The number of decimal digits to use for storing fractional seconds in a SQL `time` or `timestamp` column. Applies only to columns of time or timestamp type. The default value `-1` indicates that fractional seconds should not be stored in a `time` column, or that the maximum number of digits supported by the database and JDBC driver should be stored in a `timestamp` column. Since 3.2

public int secondPrecision()

(Optional) The number of decimal digits to use for storing fractional seconds in a SQL time or timestamp column.

Applies only to columns of time or timestamp type.

The default value -1 indicates that fractional seconds should not be stored in a time column, or that the maximum number of digits supported by the database and JDBC driver should be stored in a timestamp column.

Since: 3.2

table	back to summary
public String table() (Optional) The name of the table that contains the column. If absent the column is assumed to be in the primary table.

unique	back to summary
public boolean unique() (Optional) Whether the column is a unique key. This is a shortcut for the `UniqueConstraint` annotation at the table level and is useful for when the unique key constraint corresponds to only a single column. This constraint applies in addition to any constraint entailed by the primary key mapping and to constraints specified at the table level.

updatable	back to summary
public boolean updatable() (Optional) Whether the column is included in SQL UPDATE statements generated by the persistence provider.

public @Interface Column

Method Summary

Method Detail