com.mybatisflex.annotation

Annotation Type Column

@Inherited
 @Retention(value=RUNTIME)
 @Target(value=FIELD)
public @interface Column

数据库表中的列信息注解。

Author:

开源海哥

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	comment 数据字段注释，在 AI 时代，注释的内容往往可用于 AI 辅助对话
boolean	ignore 是否忽略该字段，可能只是业务字段，而非数据库对应字段。
boolean	isLarge 是否是大字段，大字段 APT 不会生成到 DEFAULT_COLUMNS 里。
boolean	isLogicDelete 是否是逻辑删除字段，一张表中只能存在 1 一个逻辑删除字段。
org.apache.ibatis.type.JdbcType	jdbcType 配置的 jdbcType。
String	onInsertValue insert 的时候默认值，这个值会直接被拼接到 sql 而不通过参数设置。
String	onUpdateValue update 的时候自动赋值，这个值会直接被拼接到 sql 而不通过参数设置。
boolean	tenantId 是否是租户 ID。
Class<? extends org.apache.ibatis.type.TypeHandler>	typeHandler 自定义 TypeHandler。
String	value 字段名称。
boolean	version 是否为乐观锁字段。

Element Detail

value

public abstract String value

字段名称。

Default:

""

ignore

public abstract boolean ignore

是否忽略该字段，可能只是业务字段，而非数据库对应字段。

Default:

false

onInsertValue

public abstract String onInsertValue

insert 的时候默认值，这个值会直接被拼接到 sql 而不通过参数设置。

Default:

""

onUpdateValue

public abstract String onUpdateValue

update 的时候自动赋值，这个值会直接被拼接到 sql 而不通过参数设置。

Default:

""

isLarge

public abstract boolean isLarge

是否是大字段，大字段 APT 不会生成到 DEFAULT_COLUMNS 里。

Default:

false

isLogicDelete

public abstract boolean isLogicDelete

是否是逻辑删除字段，一张表中只能存在 1 一个逻辑删除字段。

逻辑删除的字段，被删除时，会设置为 1，正常状态为 0，可以通过 FlexGlobalConfig 配置来修改 1 和 0 为其他值。

Default:

false

version

public abstract boolean version

是否为乐观锁字段。

若是乐观锁字段的话，数据更新的时候会去检测当前版本号，若更新成功的话会设置当前版本号 +1 只能用于数值的字段。

Default:

false

tenantId

public abstract boolean tenantId

是否是租户 ID。

Default:

false

jdbcType

public abstract org.apache.ibatis.type.JdbcType jdbcType

配置的 jdbcType。

Default:

org.apache.ibatis.type.JdbcType.UNDEFINED

typeHandler

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

自定义 TypeHandler。

Default:

org.apache.ibatis.type.UnknownTypeHandler.class

comment

public abstract String comment

数据字段注释，在 AI 时代，注释的内容往往可用于 AI 辅助对话

Default:

""