Top Description Methods
javax.persistence

public @Interface Column

extends Annotation
Annotations
@Target:METHOD, FIELD
@Retention:RUNTIME
Imports
java.lang.annotation.Target, .Retention
Specifies the mapped column for a persistent property or field. If no Column annotation is 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; }
Since
Java Persistence 1.0

Method Summary

Modifier and TypeMethod and Description
public String
columnDefinition()

(Optional) The SQL fragment that is used when generating the DDL for 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 int
precision()

(Optional) The precision for a decimal (exact numeric) column.

public int
scale()

(Optional) The scale for a decimal (exact numeric) 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:
annotationTypeequalshashCodetoString

Method Detail

columnDefinitionback 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.

insertableback to summary
public boolean insertable()

(Optional) Whether the column is included in SQL INSERT statements generated by the persistence provider.

lengthback to summary
public int length()

(Optional) The column length. (Applies only if a string-valued column is used.)

nameback to summary
public String name()

(Optional) The name of the column. Defaults to the property or field name.

nullableback to summary
public boolean nullable()

(Optional) Whether the database column is nullable.

precisionback to summary
public int precision()

(Optional) The precision for a decimal (exact numeric) column. (Applies only if a decimal column is used.) Value must be set by developer if used when generating the DDL for the column.

scaleback to summary
public int scale()

(Optional) The scale for a decimal (exact numeric) column. (Applies only if a decimal column is used.)

tableback 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.

uniqueback 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 primary key mapping and to constraints specified at the table level.

updatableback to summary
public boolean updatable()

(Optional) Whether the column is included in SQL UPDATE statements generated by the persistence provider.