# 高級查詢
ORM 以 **QuerySeter** 來組織查詢,每個返回 **QuerySeter** 的方法都會獲得一個新的 **QuerySeter** 對象。
基本使用方法:
```go
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 的類似結果,并不代表實際生成的語句。
```go
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
當前支持的操作符號:
* [exact](#exact) / [iexact](#iexact) 等于
* [contains](#contains) / [icontains](#icontains) 包含
* [gt / gte](#gt / gte) 大于 / 大于等于
* [lt / lte](#lt / lte) 小于 / 小于等于
* [startswith](#startswith) / [istartswith](#istartswith) 以...起始
* [endswith](#endswith) / [iendswith](#iendswith) 以...結束
* [in](#in)
* [isnull](#isnull)
后面以 `i` 開頭的表示:大小寫不敏感
### exact
Filter / Exclude / Condition expr 的默認值
```go
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
```go
qs.Filter("name__iexact", "slene")
// WHERE name LIKE 'slene'
// 大小寫不敏感,匹配任意 'Slene' 'sLENE'
```
### contains
```go
qs.Filter("name__contains", "slene")
// WHERE name LIKE BINARY '%slene%'
// 大小寫敏感, 匹配包含 slene 的字符
```
### icontains
```go
qs.Filter("name__icontains", "slene")
// WHERE name LIKE '%slene%'
// 大小寫不敏感, 匹配任意 'im Slene', 'im sLENE'
```
### in
```go
qs.Filter("age__in", 17, 18, 19, 20)
// WHERE age IN (17, 18, 19, 20)
ids:=[]int{17,18,19,20}
qs.Filter("age__in", ids)
// WHERE age IN (17, 18, 19, 20)
// 同上效果
```
### gt / gte
```go
qs.Filter("profile__age__gt", 17)
// WHERE profile.age > 17
qs.Filter("profile__age__gte", 18)
// WHERE profile.age >= 18
```
### lt / lte
```go
qs.Filter("profile__age__lt", 17)
// WHERE profile.age < 17
qs.Filter("profile__age__lte", 18)
// WHERE profile.age <= 18
```
### startswith
```go
qs.Filter("name__startswith", "slene")
// WHERE name LIKE BINARY 'slene%'
// 大小寫敏感, 匹配以 'slene' 起始的字符串
```
### istartswith
```go
qs.Filter("name__istartswith", "slene")
// WHERE name LIKE 'slene%'
// 大小寫不敏感, 匹配任意以 'slene', 'Slene' 起始的字符串
```
### endswith
```go
qs.Filter("name__endswith", "slene")
// WHERE name LIKE BINARY '%slene'
// 大小寫敏感, 匹配以 'slene' 結束的字符串
```
### iendswith
```go
qs.Filter("name__iendswithi", "slene")
// WHERE name LIKE '%slene'
// 大小寫不敏感, 匹配任意以 'slene', 'Slene' 結束的字符串
```
### isnull
```go
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 是高級查詢使用的接口,我們來熟悉下他的接口方法
* type QuerySeter interface {
* [Filter(string, ...interface{}) QuerySeter](#filter)
* [Exclude(string, ...interface{}) QuerySeter](#exclude)
* [SetCond(*Condition) QuerySeter](#setcond)
* [Limit(int, ...int64) QuerySeter](#limit)
* [Offset(int64) QuerySeter](#offset)
* [GroupBy(...string) QuerySeter](#groupby)
* [OrderBy(...string) QuerySeter](#orderby)
* [Distinct() QuerySeter](#distinct)
* [RelatedSel(...interface{}) QuerySeter](#relatedsel)
* [Count() (int64, error)](#count)
* [Exist() bool](#exist)
* [Update(Params) (int64, error)](#update)
* [Delete() (int64, error)](#delete)
* [PrepareInsert() (Inserter, error)](#prepareinsert)
* [All(interface{}, ...string) (int64, error)](#all)
* [One(interface{}, ...string) error](#one)
* [Values(*[]Params, ...string) (int64, error)](#values)
* [ValuesList(*[]ParamsList, ...string) (int64, error)](#valueslist)
* [ValuesFlat(*ParamsList, string) (int64, error)](#valuesflat)
* }
* 每個返回 QuerySeter 的 api 調用時都會新建一個 QuerySeter,不影響之前創建的。
* 高級查詢使用 Filter 和 Exclude 來做常用的條件查詢。囊括兩種清晰的過濾規則:包含, 排除
### Filter
用來過濾查詢結果,起到 **包含條件** 的作用
多個 Filter 之間使用 `AND` 連接
```go
qs.Filter("profile__isnull", true).Filter("name", "slene")
// WHERE profile_id IS NULL AND name = 'slene'
```
### Exclude
用來過濾查詢結果,起到 **排除條件** 的作用
使用 `NOT` 排除條件
多個 Exclude 之間使用 `AND` 連接
```go
qs.Exclude("profile__isnull", true).Filter("name", "slene")
// WHERE NOT profile_id IS NULL AND name = 'slene'
```
### SetCond
自定義條件表達式
```go
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`
```go
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
設置 偏移行數
```go
qs.Offset(20)
// LIMIT 1000 OFFSET 20
```
### GroupBy
```go
qs.GroupBy("id", "age")
// GROUP BY id,age
```
### OrderBy
參數使用 **expr**
在 expr 前使用減號 `-` 表示 `DESC` 的排列
```go
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` 語句, 返回不重復的值.
```go
qs.Distinct()
// SELECT DISTINCT
```
### RelatedSel
關系查詢,參數使用 **expr**
```go
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
依據當前的查詢條件,返回結果行數
```go
cnt, err := o.QueryTable("user").Count() // SELECT COUNT(*) FROM USER
fmt.Printf("Count Num: %s, %s", cnt, err)
```
### Exist
```go
exist := o.QueryTable("user").Filter("UserName", "Name").Exist()
fmt.Printf("Is Exist: %s", exist)
```
### Update
依據當前查詢條件,進行批量更新操作
```go
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"
```
原子操作增加字段值
```go
// 假設 user struct 里有一個 nums int 字段
num, err := o.QueryTable("user").Update(orm.Params{
"nums": orm.ColValue(orm.ColAdd, 100),
})
// SET nums = nums + 100
```
orm.ColValue 支持以下操作
```go
ColAdd // 加
ColMinus // 減
ColMultiply // 乘
ColExcept // 除
```
### Delete
依據當前查詢條件,進行批量刪除操作
```go
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 插入,以提高批量插入的速度。
```go
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
```go
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](#limit) 的限制,默認最大行數為 1000
可以指定返回的字段:
```go
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
嘗試返回單條記錄
```go
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")
}
```
可以指定返回的字段:
```go
// 只返回 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的值是interface{}類型,例如,如果你要將value賦值給struct中的某字段,需要根據結構體對應字段類型使用[斷言](https://golang.org/ref/spec#Type_assertions)獲取真實值。舉例:`Name : m["Name"].(string)`
```go
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 級聯返回需要的數據
```go
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 保存
```go
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
```go
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 里
```go
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, ", "))
}
```
## 關系查詢
以例子里的[模型定義](orm.md)來看下怎么進行關系查詢
#### User 和 Profile 是 OneToOne 的關系
已經取得了 User 對象,查詢 Profile:
```go
user := &User{Id: 1}
o.Read(user)
if user.Profile != nil {
o.Read(user.Profile)
}
```
直接關聯查詢:
```go
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:
```go
var profile Profile
err := o.QueryTable("profile").Filter("User__Id", 1).One(&profile)
if err == nil {
fmt.Println(profile)
}
```
#### Post 和 User 是 ManyToOne 關系,也就是 ForeignKey 為 User
```go
type Post struct {
Id int
Title string
User *User `orm:"rel(fk)"`
Tags []*Tag `orm:"rel(m2m)"`
}
```
```go
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 的反向關系,所以可以直接進行查詢
```go
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 會自動創建中間表
```go
type Post struct {
Id int
Title string
User *User `orm:"rel(fk)"`
Tags []*Tag `orm:"rel(m2m)"`
}
```
```go
type Tag struct {
Id int
Name string
Posts []*Post `orm:"reverse(many)"`
}
```
一條 Post 紀錄可能對應不同的 Tag 紀錄,一條 Tag 紀錄可能對應不同的 Post 紀錄,所以 Post 和 Tag 屬于多對多關系,通過 tag name 查詢哪些 post 使用了這個 tag
```go
var posts []*Post
num, err := dORM.QueryTable("post").Filter("Tags__Tag__Name", "golang").All(&posts)
```
通過 post title 查詢這個 post 有哪些 tag
```go
var tags []*Tag
num, err := dORM.QueryTable("tag").Filter("Posts__Post__Title", "Introduce Beego ORM").All(&tags)
```
## 載入關系字段
LoadRelated 用于載入模型的關系字段,包括所有的 rel/reverse - one/many 關系
ManyToMany 關系字段載入
```go
// 載入相應的 Tags
post := Post{Id: 1}
err := o.Read(&post)
num, err := o.LoadRelated(&post, "Tags")
```
```go
// 載入相應的 Posts
tag := Tag{Id: 1}
err := o.Read(&tag)
num, err := o.LoadRelated(&tag, "Posts")
```
User 是 Post 的 ForeignKey,對應的 ReverseMany 關系字段載入
```go
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 {
//...
}
```
## 多對多關系操作
* type QueryM2Mer interface {
* [Add(...interface{}) (int64, error)](#querym2mer-add)
* [Remove(...interface{}) (int64, error)](#querym2mer-remove)
* [Exist(interface{}) bool](#querym2mer-exist)
* [Clear() (int64, error)](#querym2mer-clear)
* [Count() (int64, error)](#querym2mer-count)
* }
創建一個 QueryM2Mer 對象
```go
o := orm.NewOrm()
post := Post{Id: 1}
m2m := o.QueryM2M(&post, "Tags")
// 第一個參數的對象,主鍵必須有值
// 第二個參數為對象需要操作的 M2M 字段
// QueryM2Mer 的 api 將作用于 Id 為 1 的 Post
```
### QueryM2Mer Add
```go
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{}
```go
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{}
```go
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 關系中
```go
if m2m.Exist(&Tag{Id: 2}) {
fmt.Println("Tag Exist")
}
```
### QueryM2Mer Clear
清除所有 M2M 關系
```go
nums, err := m2m.Clear()
if err == nil {
fmt.Println("Removed Tag Nums: ", nums)
}
```
### QueryM2Mer Count
計算 Tag 的數量
```go
nums, err := m2m.Count()
if err == nil {
fmt.Println("Total Nums: ", nums)
}
```
- beego簡介
- 為 beego 貢獻
- 發布版本
- 升級指南
- beego安裝升級
- Bee 工具的使用
- 快速入門
- 新建項目
- 路由設置
- Controller 運行機制
- model 邏輯
- view 編寫
- 靜態文件處理
- beego 的 MVC 架構介紹
- controller 設計
- 參數配置
- 路由設置
- 控制器函數
- XSRF 過濾
- 請求數據處理
- session 控制
- 過濾器
- flash 數據
- URL構建
- 多種格式數據輸出
- 表單數據驗證
- 錯誤處理
- 日志處理
- model設計
- 概述
- ORM 使用
- CRUD 操作
- 高級查詢
- 原生 SQL 查詢
- 構造查詢
- 事務處理
- 模型定義
- 命令模式
- 測試用例
- 自定義字段
- FAQ
- view 設計
- 模板語法指南
- 模板處理
- 模板函數
- 靜態文件處理
- 模板分頁處理
- beego 的模塊設計
- session 模塊
- grace 模塊
- cache 模塊
- logs 模塊
- httplib 模塊
- context 模塊
- toolbox 模塊
- config 模塊
- i18n 模塊
- beego 高級編程
- 進程內監控
- API 自動化文檔
- 應用部署
- 獨立部署
- supervisor 部署
- Nginx 部署
- apache 部署
- beego 第三方庫
- 應用例子
- 在線聊天室
- 短域名服務
- Todo 列表
- beego實用庫
- 驗證碼
- 分頁
- FAQ