app.myoss.cloud.mybatis.table.annotation

Annotation Type Column

@Target(value={METHOD,FIELD})
 @Retention(value=RUNTIME)
 @Documented
public @interface Column

Is used to specify a mapped column for a persistent property or field. If no Column annotation is specified, the default values are applied.

Examples:

 Example 1:
 @Column(name="DESC", nullable=false)
 private String description;

 Example 2:
 @Column(name="id", primaryKey=true)
 public String getId() { return id; }

 Example 3:
 @Column(name="ORDER_COST", insertable=false, updatable=false)
 private String cost;
 

Since:

2018年4月26日 上午11:57:24

Author:

Jerry.Chen

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	escapedName (Optional) 编码之后的字段名，比如：字段名是关键字、有空格
FillRule[]	fillRule 用于 SQL 语句在 INSERT/UPDATE 的时候，字段是否需要进行填充，参考 FillRule 的详细说明
boolean	insertable 字段是否包含在 SQL INSERT statements，某些字段不想被保存
boolean	isTransient 标记字段为普通字段，不是数据库字段
boolean	logicDelete 逻辑删除数据，软删除，用字段标记数据被删除了，不做物理删除
String	logicDeleteValue 数据标记为"逻辑删除"的值
String	logicUnDeleteValue 数据标记为"逻辑未删除"的值
String	name (Optional) The name of the column.
boolean	nullable (Optional) Whether the database column is nullable.
boolean	primaryKey 是否为主键字段
boolean	selectable 字段是否包含在 SQL SELECT statements，某些字段不想被查询出来
Class<? extends org.apache.ibatis.type.TypeHandler<?>>	typeHandler 数据库字段类型转换为Java类型处理器
boolean	updatable 字段是否包含在 SQL UPDATE statements，某些字段不想被更新

Element Detail

name

public abstract String name

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

Returns:

字段名

Default:

""

escapedName

public abstract String escapedName

(Optional) 编码之后的字段名，比如：字段名是关键字、有空格

Returns:

编码之后的字段名

Default:

""

nullable

public abstract boolean nullable

(Optional) Whether the database column is nullable.

Returns:

字段是否允许为 null

Default:

true

insertable

public abstract boolean insertable

字段是否包含在 SQL INSERT statements，某些字段不想被保存

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

Returns:

字段是否在 INSERT 中使用

Default:

true

updatable

public abstract boolean updatable

字段是否包含在 SQL UPDATE statements，某些字段不想被更新

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

Returns:

字段是否在 UPDATE 中使用

Default:

true

selectable

public abstract boolean selectable

字段是否包含在 SQL SELECT statements，某些字段不想被查询出来

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

Returns:

字段是否在 SELECT 中使用

Default:

true

fillRule

public abstract FillRule[] fillRule

用于 SQL 语句在 INSERT/UPDATE 的时候，字段是否需要进行填充，参考 FillRule 的详细说明

Returns:

字段填充规则，支持设置多种规则

Default:

app.myoss.cloud.mybatis.table.annotation.FillRule.NONE

primaryKey

public abstract boolean primaryKey

是否为主键字段

Returns:

字段是否为主键

Default:

false

logicDelete

public abstract boolean logicDelete

逻辑删除数据，软删除，用字段标记数据被删除了，不做物理删除

Returns:

字段是否支持逻辑删除

Default:

false

logicDeleteValue

public abstract String logicDeleteValue

数据标记为"逻辑删除"的值

Returns:

逻辑删除的值

Default:

""

logicUnDeleteValue

public abstract String logicUnDeleteValue

数据标记为"逻辑未删除"的值

Returns:

逻辑未删除的值

Default:

""

typeHandler

public abstract Class<? extends org.apache.ibatis.type.TypeHandler<?>> typeHandler

数据库字段类型转换为Java类型处理器

Returns:

Java类型处理器

Default:

app.myoss.cloud.mybatis.type.UnsupportedTypeHandler.class

isTransient

public abstract boolean isTransient

标记字段为普通字段，不是数据库字段

Returns:

true: 普通字段; false: 数据库字段

Default:

false