[Beego模型] 3、高級查詢

[Beego模型] 1、ORM 使用方法php

[Beego模型] 2、CRUD 操做html

[Beego模型] 3、高級查詢golang

[Beego模型] 4、使用SQL語句進行查詢sql

[Beego模型] 5、構造查詢api

[Beego模型] 6、事務處理mvc

 

ORM 以 QuerySeter 來組織查詢,每一個返回 QuerySeter 的方法都會得到一個新的 QuerySeter 對象。post

基本使用方法:code

o := orm.NewOrm()

// 獲取 QuerySeter 對象,user 爲表名
qs := o.QueryTable("user")

// 也能夠直接使用對象做爲表名
user := new(User)
qs = o.QueryTable(user) // 返回 QuerySeter

expr

QuerySeter 中用於描述字段和 sql 操做符,使用簡單的 expr 查詢方法orm

字段組合的先後順序依照表的關係,好比 User 表擁有 Profile 的外鍵,那麼對 User 表查詢對應的 Profile.Age 爲條件,則使用 Profile__Age 注意,字段的分隔符號使用雙下劃線 __,除了描述字段, expr 的尾部能夠增長操做符以執行對應的 sql 操做。好比 Profile__Age__gt 表明 Profile.Age > 18 的條件查詢。htm

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

qs.Filter("id", 1) // WHERE id = 1
qs.Filter("profile__age", 18) // WHERE profile.age = 18
qs.Filter("Profile__Age", 18) // 使用字段名和 Field 名都是容許的
qs.Filter("profile__age", 18) // WHERE profile.age = 18
qs.Filter("profile__age__gt", 18) // WHERE profile.age > 18
qs.Filter("profile__age__gte", 18) // WHERE profile.age >= 18
qs.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 < 1000

Operators

當前支持的操做符號:

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

exact

Filter / Exclude / Condition expr 的默認值

qs.Filter("name", "slene") // WHERE name = 'slene'
qs.Filter("name__exact", "slene") // WHERE name = 'slene'
// 使用 = 匹配,大小寫是否敏感取決於數據表使用的 collation
qs.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 > 17

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

lt / lte

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

qs.Filter("profile__age__lte", 18)
// WHERE profile.age <= 18

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 NULL

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

高級查詢接口使用

QuerySeter 是高級查詢使用的接口,咱們來熟悉下他的接口方法

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 1000

qs.Limit(10)
// LIMIT 10

qs.Limit(10, 20)
// LIMIT 10 OFFSET 20 注意跟 SQL 反過來的

qs.Limit(-1)
// no limit

qs.Limit(-1, 100)
// LIMIT 18446744073709551615 OFFSET 100
// 18446744073709551615 是 1<<64 - 1 用來指定無 limit 限制 但有 offset 偏移的狀況

Offset

設置 偏移行數

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 DESC

qs.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 USER
fmt.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 受到 Limit 的限制,默認最大行數爲 1000

能夠指定返回的字段:

type Post struct {
    Id      int
    Title   string
    Content string
    Status  int
}

// 只返回 Id 和 Title
var 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 和 Title
var 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: %d\n", 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: %d\n", 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: %d\n", 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: %d\n", num)
    for _, row := range lists {
        fmt.Printf("Name: %s, Age: %s\m", 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: %d\n", 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)
// 自動查詢到 Profile
fmt.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 read\n", num)
    for _, post := range posts {
        fmt.Printf("Id: %d, UserName: %d, Title: %s\n", 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 關係字段載入

// 載入相應的 Tags
post := Post{Id: 1}
err := o.Read(&post)
num, err := o.LoadRelated(&post, "Tags")

// 載入相應的 Posts
tag := 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)
}

 

 

 

摘自:https://beego.me/docs/mvc/model/query.md

相關文章
相關標籤/搜索