模型定义

复杂的模型定义不是必须的,此功能用作数据库数据转换和自动建表

默认的表名规则,使用驼峰转蛇形:

  1. AuthUser-> auth_user
  2. Auth_User-> auth__user
  3. DB_AuthUser -> d_b__auth_user

除了开头的大写字母以外,遇到大写会增加 _,原名称中的下划线保留。

自定义表名

  1. type Userstruct{
  2. Idint
  3. Namestring
  4. }
  5. func (u *User)TableName()string{
  6. return"auth_user"
  7. }

如果前缀设置prefix_ 那么表名为:prefix_auth_user

自定义索引

为单个或多个字段增加索引

  1. type Userstruct{
  2. Idint
  3. Namestring
  4. Emailstring
  5. }
  6. // 多字段索引
  7. func (u *User)TableIndex()[][]string{
  8. return[][]string{
  9. []string{"Id","Name"},
  10. }
  11. }
  12. // 多字段唯一键
  13. func (u *User)TableUnique()[][]string{
  14. return[][]string{
  15. []string{"Name","Email"},
  16. }
  17. }

自定义引擎

仅支持 MySQL

默认使用的引擎,为当前数据库的默认引擎,这个是由你的 mysql 配置参数决定的。

你可以在模型里设置 TableEngine 函数,指定使用的引擎

  1. type Userstruct{
  2. Idint
  3. Namestring
  4. Emailstring
  5. }
  6. // 设置引擎为 INNODB
  7. func (u *User)TableEngine()string{
  8. return"INNODB"
  9. }

设置参数

  1. orm:"null;rel(fk)"

多个设置间使用 ; 分隔,设置的值如果是多个,使用 , 分隔。

忽略字段

设置 - 即可忽略 struct 中的字段

  1. type Userstruct{
  2. ...
  3. AnyFieldstring`orm:"-"`
  4. ...
  5. }

auto

当 Field 类型为 int, int32, int64, uint, uint32, uint64 时,可以设置字段为自增健

  • 当模型定义里没有主键时,符合上述类型且名称为 Id 的 Field 将被视为自增健。

鉴于 go 目前的设计,即使使用了 uint64,但你也不能存储到他的最大值。依然会作为 int64 处理。

参见 issue 6113

pk

设置为主键,适用于自定义其他类型为主键

null

数据库表默认为 NOT NULL,设置 null 代表 ALLOW NULL

  1. Namestring`orm:"null"`

index

为单个字段增加索引

unique

为单个字段增加 unique 键

  1. Namestring`orm:"unique"`

column

为字段设置 db 字段的名称

  1. Namestring`orm:"column(user_name)"`

size

string 类型字段默认为 varchar(255)

设置 size 以后,db type 将使用 varchar(size)

  1. Titlestring`orm:"size(60)"`

digits / decimals

设置 float32, float64 类型的浮点精度

  1. Money float64 `orm:"digits(12);decimals(4)"`

总长度 12 小数点后 4 位 eg: 99999999.9999

auto_now / auto_now_add

  1. Created time.Time`orm:"auto_now_add;type(datetime)"`
  2. Updated time.Time`orm:"auto_now;type(datetime)"`
  • auto_now 每次 model 保存时都会对时间自动更新
  • auto_now_add 第一次保存时才设置时间

对于批量的 update 此设置是不生效的

type

设置为 date 时,time.Time 字段的对应 db 类型使用 date

  1. Created time.Time`orm:"auto_now_add;type(date)"`

设置为 datetime 时,time.Time 字段的对应 db 类型使用 datetime

  1. Created time.Time`orm:"auto_now_add;type(datetime)"`

default

为字段设置默认值,类型必须符合(目前仅用于级联删除时的默认值)

  1. type Userstruct{
  2. ...
  3. Statusint`orm:"default(1)"`
  4. ...
  5. }

表关系设置

rel / reverse

RelOneToOne:

  1. type Userstruct{
  2. ...
  3. Profile*Profile`orm:"null;rel(one);on_delete(set_null)"`
  4. ...
  5. }

对应的反向关系 RelReverseOne:

  1. type Profilestruct{
  2. ...
  3. User*User`orm:"reverse(one)"`
  4. ...
  5. }

RelForeignKey:

  1. type Poststruct{
  2. ...
  3. User*User`orm:"rel(fk)"`// RelForeignKey relation
  4. ...
  5. }

对应的反向关系 RelReverseMany:

  1. type Userstruct{
  2. ...
  3. Posts[]*Post`orm:"reverse(many)"`// fk 的反向关系
  4. ...
  5. }

RelManyToMany:

  1. type Poststruct{
  2. ...
  3. Tags[]*Tag`orm:"rel(m2m)"`// ManyToMany relation
  4. ...
  5. }

对应的反向关系 RelReverseMany:

  1. type Tagstruct{
  2. ...
  3. Posts[]*Post`orm:"reverse(many)"`
  4. ...
  5. }

rel_table / rel_through

此设置针对 orm:"rel(m2m)" 的关系字段

  1. rel_table 设置自动生成的 m2m 关系表的名称
  2. rel_through 如果要在 m2m 关系中使用自定义的 m2m 关系表
  3. 通过这个设置其名称,格式为 pkg.path.ModelName
  4. eg: app.models.PostTagRel
  5. PostTagRel表需要有到PostTag的关系

当设置 rel_table 时会忽略 rel_through

设置方法:

orm:"rel(m2m);rel_table(the_table_name)"

orm:"rel(m2m);rel_through(pkg.path.ModelName)"

on_delete

设置对应的 rel 关系删除时,如何处理关系字段。

  1. cascade 级联删除(默认值)
  2. set_null 设置为 NULL,需要设置null=true
  3. set_default 设置为默认值,需要设置default
  4. do_nothing 什么也不做,忽略
  1. type Userstruct{
  2. ...
  3. Profile*Profile`orm:"null;rel(one);on_delete(set_null)"`
  4. ...
  5. }
  6. type Profilestruct{
  7. ...
  8. User*User`orm:"reverse(one)"`
  9. ...
  10. }
  11. // 删除 Profile 时将设置 User.Profile 的数据库字段为 NULL

关于 on_delete 的相关例子

  1. type Userstruct{
  2. Idint
  3. Namestring
  4. }
  5. type Poststruct{
  6. Idint
  7. Titlestring
  8. User*User`orm:"rel(fk)"`
  9. }

假设 Post -> User 是 ManyToOne 的关系,也就是外键。

  1. o.Filter("Id",1).Delete()

这个时候即会删除 Id 为 1 的 User 也会删除其发布的 Post

不想删除的话,需要设置 set_null

  1. type Poststruct{
  2. Idint
  3. Titlestring
  4. User*User`orm:"rel(fk);null;on_delete(set_null)"`
  5. }

那这个时候,删除 User 只会把对应的 Post.user_id 设置为 NULL

当然有时候为了高性能的需要,多存点数据无所谓啊,造成批量删除才是问题。

  1. type Poststruct{
  2. Idint
  3. Titlestring
  4. User*User`orm:"rel(fk);null;on_delete(do_nothing)"`
  5. }

那么只要删除的时候,不操作 Post 就可以了。

模型字段与数据库类型的对应

在此列出 ORM 推荐的对应数据库类型,自动建表功能也会以此为标准。

默认所有的字段都是 NOT NULL

MySQL

gomysql
int, int32 - 设置 auto 或者名称为 Idinteger AUTO_INCREMENT
int64 - 设置 auto 或者名称为 Idbigint AUTO_INCREMENT
uint, uint32 - 设置 auto 或者名称为 Idinteger unsigned AUTO_INCREMENT
uint64 - 设置 auto 或者名称为 Idbigint unsigned AUTO_INCREMENT
boolbool
string - 默认为 size 255varchar(size)
string - 设置 type(text) 时longtext
time.Time - 设置 type 为 date 时date
time.Timedatetime
bytetinyint unsigned
runeinteger
intinteger
int8tinyint
int16smallint
int32integer
int64bigint
uintinteger unsigned
uint8tinyint unsigned
uint16smallint unsigned
uint32integer unsigned
uint64bigint unsigned
float32double precision
float64double precision
float64 - 设置 digits, decimals 时numeric(digits, decimals)

Sqlite3

gosqlite3
int, int32, int64, uint, uint32, uint64 - 设置 auto 或者名称为 Idinteger AUTOINCREMENT
boolbool
string - 默认为 size 255varchar(size)
string - 设置 type(text) 时text
time.Time - 设置 type 为 date 时date
time.Timedatetime
bytetinyint unsigned
runeinteger
intinteger
int8tinyint
int16smallint
int32integer
int64bigint
uintinteger unsigned
uint8tinyint unsigned
uint16smallint unsigned
uint32integer unsigned
uint64bigint unsigned
float32real
float64real
float64 - 设置 digits, decimals 时decimal

PostgreSQL

gopostgres
int, int32, int64, uint, uint32, uint64 - 设置 auto 或者名称为 Idserial
boolbool
string - 若没有指定 size 默认为 textvarchar(size)
string - 设置 type(text) 时text
string - 设置 type(json) 时json
string - 设置 type(jsonb) 时jsonb
time.Time - 设置 type 为 date 时date
time.Timetimestamp with time zone
bytesmallint CHECK(“column” >= 0 AND “column” <= 255)
runeinteger
intinteger
int8smallint CHECK(“column” >= -127 AND “column” <= 128)
int16smallint
int32integer
int64bigint
uintbigint CHECK(“column” >= 0)
uint8smallint CHECK(“column” >= 0 AND “column” <= 255)
uint16integer CHECK(“column” >= 0)
uint32bigint CHECK(“column” >= 0)
uint64bigint CHECK(“column” >= 0)
float32double precision
float64double precision
float64 - 设置 digits, decimals 时numeric(digits, decimals)

关系型字段

其字段类型取决于对应的主键。

  • RelForeignKey
  • RelOneToOne
  • RelManyToMany
  • RelReverseOne
  • RelReverseMany