com.github.drinkjava2.jdialects.annotation.jdia

Annotation Type COLUMN

@Target(value=FIELD)
 @Retention(value=RUNTIME)
public @interface COLUMN

Similar like JPA's @Column annotation, but enhenced with extra fields like tail, comment, createTimestamp, UpdateTimestamp, createdBy, LastModifiedBy

Since:

4.0.2

Author:

Yong Zhu

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	columnDefinition (Optional) The SQL fragment that is used when generating the DDL for the column.
String	comment (Optional)The comment String, usage: @Column(comment="abc");
boolean	createdBy (Optional)When insert bean will write current userId, usage:
boolean	createTimestamp (Optional)When insert bean will write current timestamp value
boolean	insertable (Optional) Whether the column is included in SQL INSERT statements generated by the persistence provider.
boolean	lastModifiedBy (Optional)When update bean will write current userId, usage see createdBy
int	length (Optional) The column length.
String	name (Optional) The name of the column.
boolean	nullable (Optional) Whether the database column is nullable.
int	precision (Optional) The precision for a decimal (exact numeric) column.
int	scale (Optional) The scale for a decimal (exact numeric) column.
String	table (Optional) The name of the table that contains the column.
String	tail (Optional)The Tail String, usage: @Column(tail="default now()");
boolean	unique (Optional) Whether the column is a unique key.
boolean	updatable (Optional) Whether the column is included in SQL UPDATE statements generated by the persistence provider.
boolean	updateTimestamp (Optional)When update bean will update current timestamp value

Element Detail

name

public abstract String name

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

Default:

""

unique

public abstract 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.

Default:

false

nullable

public abstract boolean nullable

(Optional) Whether the database column is nullable.

Default:

true

insertable

public abstract boolean insertable

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

Default:

true

updatable

public abstract boolean updatable

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

Default:

true

columnDefinition

public abstract 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.

Default:

""

table

public abstract String table

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

Default:

""

length

public abstract int length

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

Default:

255

precision

public abstract 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.

Default:

0

scale

public abstract int scale

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

Default:

0

comment

public abstract String comment

(Optional)The comment String, usage: @Column(comment="abc");

Default:

""

tail

public abstract String tail

(Optional)The Tail String, usage: @Column(tail="default now()");

Default:

""

createTimestamp

public abstract boolean createTimestamp

(Optional)When insert bean will write current timestamp value

Default:

false

updateTimestamp

public abstract boolean updateTimestamp

(Optional)When update bean will update current timestamp value

Default:

false

createdBy

public abstract boolean createdBy

(Optional)When insert bean will write current userId, usage:

 1. Write a class which have a getCurrentAuditor method
 2. Call JBEANBOX.bind("AuditorAware", XxxClass.class) to bind it
 
 For example: 
 public class XxxxUserAuditor{
        public Object getCurrentAuditor() { 
     return XxxxSecurityTool.getUserXxxxId();
        }
 }
 
 JBEANBOX.bind("AuditorAware", XxxxUserAuditor.class);
 

Default:

false

lastModifiedBy

public abstract boolean lastModifiedBy

(Optional)When update bean will write current userId, usage see createdBy

Default:

false