模型定义示例
type User struct {
gorm.Model
Name string
Age sql.NullInt64
Birthday *time.Time
Email string `gorm:"type:varchar(100);unique_index"`
Role string `gorm:"size:255"` // 设置字段大小为255
MemberNumber *string `gorm:"unique;not null"` // 设置会员号(member number)唯一并且不为空
Num int `gorm:"AUTO_INCREMENT"` // 设置 num 为自增类型
Address string `gorm:"index:addr"` // 给address字段创建名为addr的索引
IgnoreMe int `gorm:"-"` // 忽略本字段
}
结构体标记(tags)
使用结构体声明模型时,标记(tags)是可选项。gorm支持以下标记:
结构体标记(Tag) |
描述 |
Column |
指定列名 |
Type |
指定列数据类型 |
Size |
指定列大小, 默认值255 |
PRIMARY_KEY |
将列指定为主键 |
DEFAULT |
指定列默认值 |
PRECISION |
指定列精度 |
NOT NULL |
将列指定为非 NULL |
AUTO_INCREMENT |
指定列是否为自增类型 |
INDEX |
创建具有或不带名称的索引, 如果多个索引同名则创建复合索引 |
UNIQUE_INDEX |
和 INDEX 类似,只不过创建的是唯一索引 |
EMBEDDED |
将结构设置为嵌入 |
EMBEDDED_PREFIX |
设置嵌入结构的前缀 |
- |
忽略此字段 |
UNIQUE |
将列指定为唯一 |
|
|
结构体标记(Tag) |
描述 |
MANY2MANY |
指定连接表 |
FOREIGNKEY |
设置外键 |
ASSOCIATION_FOREIGNKEY |
设置关联外键 |
POLYMORPHIC |
指定多态类型 |
POLYMORPHIC_VALUE |
指定多态值 |
JOINTABLE_FOREIGNKEY |
指定连接表的外键 |
ASSOCIATION_JOINTABLE_FOREIGNKEY |
指定连接表的关联外键 |
SAVE_ASSOCIATIONS |
是否自动完成 save 的相关操作 |
ASSOCIATION_AUTOUPDATE |
是否自动完成 update 的相关操作 |
ASSOCIATION_AUTOCREATE |
是否自动完成 create 的相关操作 |
ASSOCIATION_SAVE_REFERENCE |
是否自动完成引用的 save 的相关操作 |
PRELOAD |
是否自动完成预加载的相关操作 |