物件的 CRUD 操作

如果已知主鍵的值，那麼可以使用這些方法進行 CRUD 操作

對 object 操作的四個方法 Read / Insert / Update / Delete

o := orm.NewOrm()
user := new(User)
user.Name = "slene"fmt.Println(o.Insert(user))

user.Name = "Your"fmt.Println(o.Update(user))
fmt.Println(o.Read(user))
fmt.Println(o.Delete(user))

如果需要透過條件查詢獲取物件，請參見

Read

o := orm.NewOrm()
user := User{Id: 1}

err := o.Read(&user)if err == orm.ErrNoRows {
    fmt.Println("查詢不到")
} else if err == orm.ErrMissPK {
    fmt.Println("找不到主鍵")
} else {
    fmt.Println(user.Id, user.Name)
}

Read 預設透過查詢主鍵賦值，可以使用指定的欄位進行查詢：

user := User{Name: "slene"}
err = o.Read(&user, "Name")
...

物件的其他欄位值將會是對應型別的預設值

複雜的單個物件查詢參見

ReadOrCreate

嘗試從資料庫讀取，不存在的話就建立一個

預設必須傳入一個引數作為條件欄位，同時也支援多個引數多個條件欄位

o := orm.NewOrm()
user := User{Name: "slene"}// 三個返回引數依次為：是否新建立的，物件 Id 值，錯誤if created, id, err := o.ReadOrCreate(&user, "Name"); err == nil {    if created {
        fmt.Println("New Insert an object. Id:", id)
    } else {
        fmt.Println("Get an object. Id:", id)
    }
}

Insert

第一個返回值為自增健 Id 的值

o := orm.NewOrm()
var user User
user.Name = "slene"user.IsActive = trueid, err := o.Insert(&user)if err == nil {
    fmt.Println(id)
}

建立後會自動對 auto 的 field 賦值

InsertMulti

同時插入多個物件

類似sql語句

insert into table (name, age) values("slene", 28),("astaxie", 30),("unknown", 20)

第一個引數 bulk 為並列插入的數量，第二個為物件的slice

返回值為成功插入的數量

users := []User{
    {Name: "slene"},
    {Name: "astaxie"},
    {Name: "unknown"},
    ...
}
successNums, err := o.InsertMulti(100, users)

bulk 為 1 時，將會順序插入 slice 中的資料

Update

第一個返回值為影響的行數

o := orm.NewOrm()
user := User{Id: 1}if o.Read(&user) == nil {
    user.Name = "MyName"
    if num, err := o.Update(&user); err == nil {
        fmt.Println(num)
    }
}

Update 預設更新所有的欄位，可以更新指定的欄位：

// 只更新 Nameo.Update(&user, "Name")// 指定多個欄位// o.Update(&user, "Field1", "Field2", ...)...

根據複雜條件更新欄位值參見

Delete

第一個返回值為影響的行數

o := orm.NewOrm()if num, err := o.Delete(&User{Id: 1}); err == nil {
    fmt.Println(num)
}

Delete 操作會對反向關係進行操作，此例中 Post 擁有一個到 User 的外來鍵。刪除 User 的時候。如果 on_delete 設定為預設的級聯操作，將刪除對應的 Post

Changed in 1.0.3 刪除以後不會刪除 auto field 的值

高階查詢

ORM 以 QuerySeter 來組織查詢，每個返回 QuerySeter 的方法都會獲得一個新的 QuerySeter 物件。

基本使用方法:

o := orm.NewOrm()// 獲取 QuerySeter 物件，user 為表名qs := o.QueryTable("user")// 也可以直接使用物件作為表名user := new(User)
qs = o.QueryTable(user) // 返回 QuerySeter

expr

QuerySeter 中用於描述欄位和 sql 運算子，使用簡單的 expr 查詢方法

欄位組合的前後順序依照表的關係，比如 User 表擁有 Profile 的外來鍵，那麼對 User 表查詢對應的 Profile.Age 為條件，則使用 Profile__Age 注意，欄位的分隔符號使用雙下劃線 __，除了描述欄位， expr 的尾部可以增加運算子以執行對應的 sql 操作。比如 Profile__Age__gt 代表 Profile.Age > 18 的條件查詢。

註釋後面將描述對應的 sql 語句，僅僅是描述 expr 的類似結果，並不代表實際生成的語句。

qs.Filter("id", 1) // WHERE id = 1qs.Filter("profile__age", 18) // WHERE profile.age = 18qs.Filter("Profile__Age", 18) // 使用欄位名和 Field 名都是允許的qs.Filter("profile__age", 18) // WHERE profile.age = 18qs.Filter("profile__age__gt", 18) // WHERE profile.age > 18qs.Filter("profile__age__gte", 18) // WHERE profile.age >= 18qs.Filter("profile__age__in", 18, 20) // WHERE profile.age IN (18, 20)qs.Filter("profile__age__in", 18, 20).Exclude("profile__lt", 1000)// WHERE profile.age IN (18, 20) AND NOT profile_id Operators
當前支援的運算子號：

/ 等於
/ 包含
大於 / 大於等於
小於 / 小於等於
/ 以…起始
/ 以…結束

後面以 i 開頭的表示：大小寫不敏感

exact

Filter / Exclude / Condition expr 的預設值

qs.Filter("name", "slene") // WHERE name = 'slene'qs.Filter("name__exact", "slene") // WHERE name = 'slene'// 使用 = 匹配，大小寫是否敏感取決於資料表使用的 collationqs.Filter("profile_id", nil) // WHERE profile_id IS NULL

iexact

qs.Filter("name__iexact", "slene")
// WHERE name LIKE 'slene'// 大小寫不敏感，匹配任意 'Slene' 'sLENE'

contains

qs.Filter("name__contains", "slene")// WHERE name LIKE BINARY '%slene%'// 大小寫敏感, 匹配包含 slene 的字元

icontains

qs.Filter("name__icontains", "slene")
// WHERE name LIKE '%slene%'// 大小寫不敏感, 匹配任意 'im Slene', 'im sLENE'

in

qs.Filter("profile__age__in", 17, 18, 19, 20)// WHERE profile.age IN (17, 18, 19, 20)ids:=[]int{17,18,19,20}
qs.Filter("profile__age__in", ids)// WHERE profile.age IN (17, 18, 19, 20)// 同上效果

gt / gte

qs.Filter("profile__age__gt", 17)// WHERE profile.age > 17qs.Filter("profile__age__gte", 18)// WHERE profile.age >= 18

lt / lte

qs.Filter("profile__age__lt", 17)// WHERE profile.age

startswith

qs.Filter("name__startswith", "slene")
// WHERE name LIKE BINARY 'slene%'// 大小寫敏感, 匹配以 'slene' 起始的字串

istartswith

qs.Filter("name__istartswith", "slene")
// WHERE name LIKE 'slene%'// 大小寫不敏感, 匹配任意以 'slene', 'Slene' 起始的字串

endswith

qs.Filter("name__endswith", "slene")
// WHERE name LIKE BINARY '%slene'// 大小寫敏感, 匹配以 'slene' 結束的字串

iendswith

qs.Filter("name__iendswithi", "slene")
// WHERE name LIKE '%slene'// 大小寫不敏感, 匹配任意以 'slene', 'Slene' 結束的字串

isnull

qs.Filter("profile__isnull", true)
qs.Filter("profile_id__isnull", true)// WHERE profile_id IS NULLqs.Filter("profile__isnull", false)// WHERE profile_id IS NOT NULL

高階查詢介面使用

QuerySeter 是高階查詢使用的介面，我們來熟悉下他的介面方法

type QuerySeter interface {

}

每個返回 QuerySeter 的 api 呼叫時都會新建一個 QuerySeter，不影響之前建立的。
高階查詢使用 Filter 和 Exclude 來做常用的條件查詢。囊括兩種清晰的過濾規則：包含，排除

Filter

用來過濾查詢結果，起到 包含條件 的作用

多個 Filter 之間使用 AND 連線

qs.Filter("profile__isnull", true).Filter("name", "slene")
// WHERE profile_id IS NULL AND name = 'slene'

Exclude

用來過濾查詢結果，起到 排除條件 的作用

使用 NOT 排除條件

多個 Exclude 之間使用 AND 連線

qs.Exclude("profile__isnull", true).Filter("name", "slene")
// WHERE NOT profile_id IS NULL AND name = 'slene'

SetCond

自定義條件表示式

cond := orm.NewCondition()
cond1 := cond.And("profile__isnull", false).AndNot("status__in", 1).Or("profile__age__gt", 2000)

qs := orm.QueryTable("user")
qs = qs.SetCond(cond1)// WHERE ... AND ... AND NOT ... OR ...cond2 := cond.AndCond(cond1).OrCond(cond.And("name", "slene"))
qs = qs.SetCond(cond2).Count()// WHERE (... AND ... AND NOT ... OR ...) OR ( ... )

Limit

限制最大返回資料行數，第二個引數可以設定 Offset

var DefaultRowsLimit = 1000 // ORM 預設的 limit 值為 1000// 預設情況下 select 查詢的最大行數為 1000// LIMIT 1000qs.Limit(10)// LIMIT 10qs.Limit(10, 20)// LIMIT 10 OFFSET 20 注意跟 SQL 反過來的qs.Limit(-1)// no limitqs.Limit(-1, 100)// LIMIT 18446744073709551615 OFFSET 100// 18446744073709551615 是 1Offset
設定 偏移行數
qs.Offset(20)// LIMIT 1000 OFFSET 20
GroupBy
qs.GroupBy("id", "age")// GROUP BY id,age
OrderBy
引數使用 expr
在 expr 前使用減號 - 表示 DESC 的排列
qs.OrderBy("id", "-profile__age")// ORDER BY id ASC, profile.age DESCqs.OrderBy("-profile__age", "profile")// ORDER BY profile.age DESC, profile_id ASC
Distinct
對應 sql 的 distinct 語句, 返回不重複的值.
qs.Distinct()// SELECT DISTINCT
RelatedSel
關係查詢，引數使用 expr
var DefaultRelsDepth = 5 // 預設情況下直接呼叫 RelatedSel 將進行最大 5 層的關係查詢qs := o.QueryTable("post")

qs.RelatedSel()// INNER JOIN user ... LEFT OUTER JOIN profile ...qs.RelatedSel("user")// INNER JOIN user ...// 設定 expr 只對設定的欄位進行關係查詢// 對設定 null 屬性的 Field 將使用 LEFT OUTER JOIN
Count
依據當前的查詢條件，返回結果行數
cnt, err := o.QueryTable("user").Count() // SELECT COUNT(*) FROM USERfmt.Printf("Count Num: %s, %s", cnt, err)
Exist
exist := o.QueryTable("user").Filter("UserName", "Name").Exist()
fmt.Printf("Is Exist: %s", exist)
Update
依據當前查詢條件，進行批次更新操作
num, err := o.QueryTable("user").Filter("name", "slene").Update(orm.Params{    "name": "astaxie",
})
fmt.Printf("Affected Num: %s, %s", num, err)
// SET name = "astaixe" WHERE name = "slene"
原子操作增加欄位值
// 假設 user struct 裡有一個 nums int 欄位num, err := o.QueryTable("user").Update(orm.Params{    "nums": orm.ColValue(orm.ColAdd, 100),
})// SET nums = nums + 100
orm.ColValue 支援以下操作
ColAdd      // 加ColMinus    // 減ColMultiply // 乘ColExcept   // 除
Delete
依據當前查詢條件，進行批次刪除操作
num, err := o.QueryTable("user").Filter("name", "slene").Delete()
fmt.Printf("Affected Num: %s, %s", num, err)
// DELETE FROM user WHERE name = "slene"
PrepareInsert
用於一次 prepare 多次 insert 插入，以提高批次插入的速度。
var users []*User
...
qs := o.QueryTable("user")
i, _ := qs.PrepareInsert()for _, user := range users {    id, err := i.Insert(user)    if err == nil {
        ...
    }
}// PREPARE INSERT INTO user (`name`, ...) VALUES (?, ...)// EXECUTE INSERT INTO user (`name`, ...) VALUES ("slene", ...)// EXECUTE ...// ...i.Close() // 別忘記關閉 statement
All
返回對應的結果集物件
All 的引數支援 *[]Type 和 []Type 兩種形式的 slice
var users []*User
num, err := o.QueryTable("user").Filter("name", "slene").All(&users)
fmt.Printf("Returned Rows Num: %s, %s", num, err)
All / Values / ValuesList / ValuesFlat 受到  的限制，預設最大行數為 1000
可以指定返回的欄位：
type Post struct {
    Id      int
    Title   string
    Content string
    Status  int}// 只返回 Id 和 Titlevar posts []Post
o.QueryTable("post").Filter("Status", 1).All(&posts, "Id", "Title")
物件的其他欄位值將會是對應型別的預設值
One
嘗試返回單條記錄
var user User
err := o.QueryTable("user").Filter("name", "slene").One(&user)if err == orm.ErrMultiRows {    // 多條的時候報錯
    fmt.Printf("Returned Multi Rows Not One")
}if err == orm.ErrNoRows {    // 沒有找到記錄
    fmt.Printf("Not row found")
}
可以指定返回的欄位：
// 只返回 Id 和 Titlevar post Post
o.QueryTable("post").Filter("Content__istartswith", "prefix string").One(&post, "Id", "Title")
物件的其他欄位值將會是對應型別的預設值
Values
返回結果集的 key => value 值
key 為 Model 裡的 Field name，value 的值 以 string 儲存
var maps []orm.Params
num, err := o.QueryTable("user").Values(&maps)if err == nil {
    fmt.Printf("Result Nums: %dn", num)    for _, m := range maps {
        fmt.Println(m["Id"], m["Name"])
    }
}
返回指定的 Field 資料
TODO: 暫不支援級聯查詢 RelatedSel 直接返回 Values
但可以直接指定 expr 級聯返回需要的資料
var maps []orm.Params
num, err := o.QueryTable("user").Values(&maps, "id", "name", "profile", "profile__age")if err == nil {
    fmt.Printf("Result Nums: %dn", num)    for _, m := range maps {
        fmt.Println(m["Id"], m["Name"], m["Profile"], m["Profile__Age"])        // map 中的資料都是展開的，沒有複雜的巢狀
    }
}
ValuesList
顧名思義，返回的結果集以slice儲存
結果的排列與 Model 中定義的 Field 順序一致
返回的每個元素值以 string 儲存
var lists []orm.ParamsList
num, err := o.QueryTable("user").ValuesList(&lists)if err == nil {
    fmt.Printf("Result Nums: %dn", num)    for _, row := range lists {
        fmt.Println(row)
    }
}
當然也可以指定 expr 返回指定的 Field
var lists []orm.ParamsList
num, err := o.QueryTable("user").ValuesList(&lists, "name", "profile__age")if err == nil {
    fmt.Printf("Result Nums: %dn", num)    for _, row := range lists {
        fmt.Printf("Name: %s, Age: %sm", row[0], row[1])
    }
}
ValuesFlat
只返回特定的 Field 值，將結果集展開到單個 slice 裡
var list orm.ParamsList
num, err := o.QueryTable("user").ValuesFlat(&list, "name")if err == nil {
    fmt.Printf("Result Nums: %dn", num)
    fmt.Printf("All User Names: %s", strings.Join(list, ", "))
}
關係查詢
以例子裡的來看下怎麼進行關係查詢
User 和 Profile 是 OneToOne 的關係
已經取得了 User 物件，查詢 Profile：
user := &User{Id: 1}
o.Read(user)if user.Profile != nil {
    o.Read(user.Profile)
}
直接關聯查詢：
user := &User{}
o.QueryTable("user").Filter("Id", 1).RelatedSel().One(user)// 自動查詢到 Profilefmt.Println(user.Profile)// 因為在 Profile 裡定義了反向關係的 User，所以 Profile 裡的 User 也是自動賦值過的，可以直接取用。fmt.Println(user.Profile.User)// [SELECT T0.`id`, T0.`name`, T0.`profile_id`, T1.`id`, T1.`age` FROM `user` T0 INNER JOIN `profile` T1 ON T1.`id` = T0.`profile_id` WHERE T0.`id` = ? LIMIT 1000] - `1`
透過 User 反向查詢 Profile：
var profile Profile
err := o.QueryTable("profile").Filter("User__Id", 1).One(&profile)if err == nil {
    fmt.Println(profile)
}
Post 和 User 是 ManyToOne 關係，也就是 ForeignKey 為 User
type Post struct {
    Id    int
    Title string
    User  *User  `orm:"rel(fk)"`
    Tags  []*Tag `orm:"rel(m2m)"`
}
var posts []*Post
num, err := o.QueryTable("post").Filter("User", 1).RelatedSel().All(&posts)if err == nil {
    fmt.Printf("%d posts readn", num)    for _, post := range posts {
        fmt.Printf("Id: %d, UserName: %d, Title: %sn", post.Id, post.User.UserName, post.Title)
    }
}// [SELECT T0.`id`, T0.`title`, T0.`user_id`, T1.`id`, T1.`name`, T1.`profile_id`, T2.`id`, T2.`age` FROM `post` T0 INNER JOIN `user` T1 ON T1.`id` = T0.`user_id` INNER JOIN `profile` T2 ON T2.`id` = T1.`profile_id` WHERE T0.`user_id` = ? LIMIT 1000] - `1`
根據 Post.Title 查詢對應的 User：
RegisterModel 時，ORM 也會自動建立 User 中 Post 的反向關係，所以可以直接進行查詢
var user User
err := o.QueryTable("user").Filter("Post__Title", "The Title").Limit(1).One(&user)if err == nil {
    fmt.Printf(user)
}
Post 和 Tag 是 ManyToMany 關係
設定 rel(m2m) 以後，ORM 會自動建立中間表
type Post struct {
    Id    int
    Title string
    User  *User  `orm:"rel(fk)"`
    Tags  []*Tag `orm:"rel(m2m)"`
}
type Tag struct {
    Id    int
    Name  string
    Posts []*Post `orm:"reverse(many)"`
}
一條 Post 紀錄可能對應不同的 Tag 紀錄,一條 Tag 紀錄可能對應不同的 Post 紀錄，所以 Post 和 Tag 屬於多對多關係,透過 tag name 查詢哪些 post 使用了這個 tag
var posts []*Post
num, err := dORM.QueryTable("post").Filter("Tags__Tag__Name", "golang").All(&posts)
透過 post title 查詢這個 post 有哪些 tag
var tags []*Tag
num, err := dORM.QueryTable("tag").Filter("Posts__Post__Title", "Introduce Beego ORM").All(&tags)
載入關係欄位
LoadRelated 用於載入模型的關係欄位，包括所有的 rel/reverse - one/many 關係
ManyToMany 關係欄位載入
// 載入相應的 Tagspost := Post{Id: 1}
err := o.Read(&post)
num, err := o.LoadRelated(&post, "Tags")
// 載入相應的 Poststag := Tag{Id: 1}
err := o.Read(&tag)
num, err := o.LoadRelated(&tag, "Posts")
User 是 Post 的 ForeignKey，對應的 ReverseMany 關係欄位載入
type User struct {
    Id    int
    Name  string
    Posts []*Post `orm:"reverse(many)"`
}

user := User{Id: 1}
err := dORM.Read(&user)
num, err := dORM.LoadRelated(&user, "Posts")for _, post := range user.Posts {    //...}
多對多關係操作
建立一個 QueryM2Mer 物件
o := orm.NewOrm()
post := Post{Id: 1}
m2m := o.QueryM2M(&post, "Tags")// 第一個引數的物件，主鍵必須有值// 第二個引數為物件需要操作的 M2M 欄位// QueryM2Mer 的 api 將作用於 Id 為 1 的 Post
QueryM2Mer Add
tag := &Tag{Name: "golang"}
o.Insert(tag)

num, err := m2m.Add(tag)if err == nil {
    fmt.Println("Added nums: ", num)
}
Add 支援多種型別 Tag Tag []Tag []Tag []interface{}
var tags []*Tag
...// 讀取 tags 以後...
num, err := m2m.Add(tags)if err == nil {
    fmt.Println("Added nums: ", num)
}// 也可以多個作為引數傳入// m2m.Add(tag1, tag2, tag3)
QueryM2Mer Remove
從M2M關係中刪除 tag
Remove 支援多種型別 Tag Tag []Tag []Tag []interface{}
var tags []*Tag
...// 讀取 tags 以後...
num, err := m2m.Remove(tags)if err == nil {
    fmt.Println("Removed nums: ", num)
}// 也可以多個作為引數傳入// m2m.Remove(tag1, tag2, tag3)
QueryM2Mer Exist
判斷 Tag 是否存在於 M2M 關係中
if m2m.Exist(&Tag{Id: 2}) {
    fmt.Println("Tag Exist")
}
QueryM2Mer Clear
清除所有 M2M 關係
nums, err := m2m.Clear()if err == nil {
    fmt.Println("Removed Tag Nums: ", nums)
}
QueryM2Mer Count
計算 Tag 的數量
nums, err := m2m.Count()if err == nil {
    fmt.Println("Total Nums: ", nums)
}


作者：若與
連結：

Beego Models之二

物件的 CRUD 操作

Read

ReadOrCreate

Insert

InsertMulti

Update

Delete

高階查詢

expr

Operators

exact

iexact

contains

icontains

in

gt / gte

lt / lte

startswith

istartswith

endswith

iendswith

isnull

高階查詢介面使用

Filter

Exclude

SetCond

Limit

Offset

GroupBy

OrderBy

Distinct

RelatedSel

Count

Exist

Update

Delete

PrepareInsert

All

One

Values

ValuesList

ValuesFlat

關係查詢

User 和 Profile 是 OneToOne 的關係

Post 和 User 是 ManyToOne 關係，也就是 ForeignKey 為 User

Post 和 Tag 是 ManyToMany 關係

載入關係欄位

多對多關係操作

QueryM2Mer Add

QueryM2Mer Remove

QueryM2Mer Exist

QueryM2Mer Clear

QueryM2Mer Count

相關文章