查詢
// main.go
package main
import (
"github.com/jinzhu/gorm"
_"github.com/jinzhu/gorm/dialects/mysql"
""
)
// 1. 定義模型
type User struct {
gorm.Model // ID CreateAt UpdateAt DeletedAt
Name string
Age inte64
}
func main(){
// 連接MySQL數據庫
db, err := gorm.Open("mysql","root:root1234@(127.0.0.1:13306)/db1?charset=utf8mb4&parseTime=true&loc=Local")
if err != nil {
panic(err)
}
defer db.Close()
// 2. 把模型與數據庫中的表對應起來
db.AutoMigrate(&User{})
// 3.創建(運行一下,數據庫裡有數據後,注釋釣創建,然後執行查詢動作)
u1 := User{Name:"qimi",Age:18}
db.Create(*u1)
u2 := User{Name:"jinzhu",Age:20}
db.Create(*u2)
// 4. 查詢
// var user User // 聲明模型結構體類型變量user
user := new(User) // new和make的區別
db.First(user)
fmt.Pringf("user:%#v\n",user)
var users []User
Db.Debug().Find(&users) // .Debug() 可以列印執行的SQL語句
fmt.Printf("users:%#v\n",users)
}// model.go
package gorm
import "time"
type Model struct {
ID unit `gorm:"primary_key"`
CreateAt time.Time
UpdateAt time.Time
DeletedAt *time.Time `sql:"index"`
}一般查詢
// 根據主鍵查詢第一條記錄
db.First(&user) // SELECT * FROM users ORDER BY id LIMIT 1; // 隨機獲取一條記錄 db.Take(&user) // SELECT * FROM users LIMIT 1; // 根據主鍵查詢最後一條記錄 db.Last(&user) // SELECT * FROM users ORDER BY id DESC LIMIT 1; // 查詢所有的記錄 db.Find(&users) // SELECT * FROM users; // 查詢指定的某條記錄(僅當主鍵爲整型是可用) db.First(&user, 10) // SELECT * FROM users WHERE id = 10;
Where條件
普通SQL查詢
// Get first matched record
db.Where("name = ?","jinzhu").First(&user)
// SELECT * FROM users where name = 'jinzhu' limit 1;
// Get all matched records
db.Where("name = ?","jinzhu").Find(&users)
// SELECT * FROM users WHERE name ='jinzhu' ;
// <>
db.Where("name <> ?","jinzhu").Find(&users)
// SELECT * FROM users WHERE name = 'jinzhu';
// IN
db.Where("name IN (?)", []string{"jinzhu", "jinzhu 2"}).Find(&users)
// SELECT * FROM users WHERE name in ('jinzhu','jinzhu 2');
// LIKE
db.Where("name LIKE ?","%jin%").Find(&users)
// SELECT * FROM users WHERE name LIKE '%jin%';
// AND
db.Where("name = ? AND AGE >= ?","JINZHU","22").Find(&users)
// SELECT * FROM users WHERE name = 'jinzhu'AND age >= 22;
// Time
db.Where("updated_at > ?",lastWeek).Find(&users)
// SELECT * FROM users WHERE updated_at > '2000-01-01 00:00:00';
// BETWEEN
db.Where("created_at BETWEEN ? AND ?",lastWeek,today).Find(&users)
// SELECT * FROM users WHERE created_at BETWEEN '2000-01-01 00:00:00' AND '2000-01-08 00:00:00'Struct & Map 查詢
// Struct
db.Where(&User{Name:"jinzhu",Age:20}).First(&user)
// SELECT * FROM users WHERE name = "jinzhu" AND age = 20 LIMIT 1;
// Map
db.Where(map[string]interface{}{"name":"jinzhu","age":20}).Find(&users)
// SELECT * FROM users WHERE name = "jinzhu" AND age = 20;
// 主鍵的切片
db.Where([]int64{20,21,22}).Find(&users)
// SELECT * FROM users WHERE id IN (20,21,22);提示:通過結構體進行查詢時,GORM將會只通過非零值字段查詢,如果字段值爲0,'',false或者其他零值時,將不會被用於構建查詢條件,例如:
db.Where(&User{Name:"jinzhu",Age:0}).Find(&users)
// SELECT * FROM users WHERE name = "jinzhu";可以使用指針或實現Scanner/Valuer接口來避免這個問題。
// 使用指針
type user struct {
gorm.Model
Name string
Age *int
}
// 使用Scanner/Valuer
type User struct {
gorm.Model
Name string
Age sql.NullInt64 // sql.NullInte64 實現了 Scanner/Valuer 接口
}Not 條件
作用Where類似的情況如下:
db.Not("name","jinzhu").First(&user)
// SELECT * FROM users WHERE name <> "jinzhu" LIMIT 1;
// Not In
db.Not("name",[]string{"jinzhu","jinzhu 2"}).Find(&users)
// SELECT * FROM users WHERE name NOT IN ("jinzhu","jinzhu 2");
// Not In slice of primary keys
db.Not([]int64{}).First(&user)
// SELECT * FROM users WHERE id NOT IN (1,2,3);
db.Not([]int64{}).First(&user)
// SELECT * FROM users;
// Plain SQL
db.Not("name = ?","jinzhu").First(&user)
// SELECT * FROM users WHERE NOT(name = "jinzhu");
// Struct
db.Not(User{Name:"jinzhu"}).First(&user)
// SELECT * FROM users WHERE name <> "jinzhu";Or 條件
db.Where("role = ?","admin").Or("role = ?","super_admin").Find(&users)
// SELECT * FROM users WHERE role = 'admin' OR role = 'super_admin';
// Struct
db.Where("name = 'jinzhu'").Or(User{Name:"jinzhu 2"}).Find(&users)
// SELECT * FROM users WHERE name = 'jinzhu' OR name = 'jinzhu 2';
// Map
db.Where("name = 'jinzhu'").Or(map[string]interface{}{"name":"jinzhu 2"}).Find(&users)
// SELECT * FROM users WHERE name = 'jinzhu' OR name = 'jinzhu 2';内聯條件
作用與Where查詢類似,當内聯條件與多個立即執行方法一起使用時,内聯條件不會傳遞給後面的立即執行方法。
立即執行方法(Immediate methods):是指那些會立即生成SQL語句並發送到數據庫的方法,他們一般是CURD方法。
額外查詢選項
// 爲查詢SQL添加額外的SQL操作 db.Set("gorm:query_option","FOR UPDATE").First(&user,10) // SELECT * FROM users WHERE id = 10 FOR UPDATE;
FirstOrInit
獲取匹配的第一條記錄,否則根據給定的條件初始化一個新的對象(僅支持struct和map條件)
// 未找到
db.FirstOrInit(&user,User{Name:"non_existing"})
// user -> User{Name:"non_existing"}
// 找到
db.Where(User{Name:"jinzhu"}).FirstOrInit(&user)
// user -> User{Id:111,Name:"jinzhu",Age:20}
db.FirstOrInit(&user,map[string]interface{}{"name":"jinzhu"})
// user -> User{Id:111,Name:"jinzhu",Age:20}Attrs
如果記錄未找到,將使用參數初始化struct.
// 未找到
db.Where(User{Name:"non_existing"}).Attrs(User{Age:20}).FirstOrInit(&user)
// SELECT * FROM USERS WHERE name = 'non_existing';
// user -> User{Name:"non_existing",Age:20}
db.Where(User{Name:"non_existing"}).Attrs("age",20).FirstOrInit(&user)
// SELECT * FROM USERS WHERE name = 'non_existing';
// user -> User{Name:"non_existing",Age:20}
// 找到
db.Where(User{Name:"jinzhu"}).Attrs(User{Age:30}).FirstOrInit(&user)
// SELECT * FROM USERS WHERE name = 'jinzhu';
// user -> User{Id:111,Name:"jinzhu",Age:20}Assign
不管記錄是否找到,都將參數賦值給struct
// 未找到
db.Where(User{Name:"non_existing"}).Assign(User{Age:20}).FirstOrInit(&user)
// user -> User{Name:"non_existing",Age:20}
// 找到
db.Where(User{Name:"jinzhu"}).Sssign(User{Age:30}).FirstOrInit(&user)
// SELECT * FROM USERS WHERE name = 'jinzhu';
// user -> User{Id:111,Name:"jinzhu",Age:30}FirstOrCreate
獲取匹配的第一條記錄,否則根據給定的條件創建一個新的記錄(僅支持struct和map條件)
//未找到
db.FirstOrCreate(&user,User{Name:"non_existing"})
// INSERT INTO "users" (name) VALUES ("non_existing");
// user -> User{Id:111,Name:"jinzhu"}
// 找到
db.Where(User{Name:"jinzhu"}).FirstOrCreate(&user)
// user -> User{Id:111,Name:"jinzhu"}Attrs
如果記錄未找到,將使用參數創建struct和記錄。
// 未找到
db.Where(User{Name:"non_existing"}).Attrs(User{Age:20}).FirstOrCreate(&user)
// SELECT * FROM users WHERE name = 'non_existing';
// INSERT INTO "users" (name,age) VALUES ("non_existing",20);
// user -> User{Id:112,Name:"non_existing",Age:20}
// 找到
db.Where(User{Name:"jinzhu"}).Attrs(User{Age:30}).FirstOrCreate(&user)
// SELECT * FROM users WHERE name = 'jinzhu';
// user -> User{Id:111,Name:"jinzhu",Age:20}Assign
不管記錄是否找到,都將參數賦值給struct並保存至數據庫。
// 未找到
db.Where(User{Name:"non_existing"}).Assign(User{Age:20}).FirstOrCreate(&user)
// SELECT * FROM users WHERE name = 'non_existing';
// INSERT INTO "users" (name, age) VALUES ("non_existing",20);
// user -> User{Id:112,Name:"non_existing",Age:20}
// 找到
db.Where(User{Name:"jinzhu"}).Assign(User{Age:30}).FirstOrCreate(&user)
// SELECT * FROM users WHERE name = 'jinzhu';
// UPDATE users SET age=30 WHERE id=111;
// user -> User{Id:111,Name:"jinzhu",Age:30}高級查詢
子查詢
基於*gorm.expr的子查詢
db.Where("amount > ?",DB.Table("orders").Select("AVG("amount").Where("state = ?","paid").QueryExpr()).Find(&orders) // SELECT * FORM "orders" WHERE "orders"."deleted_at" IS NULL AND (amount > (SELECT AVG(amount) FROM "orders" WHERE (state = 'paid')));
選擇字段
Select,指定想從數據庫中檢索出的字段,默認會選擇全部字段。
db.Select("name,age").Find(&users)
// SELECT name,age FROM users;
db.Select([]string{"name","age"}).Find(&users)
// SELECT name,age FROM users;
db.Table("users").Select("COALESCE(age,?)",42).Row()
// SELECT COALESCE(age,'42') FROM users;排序
Order,指定從數據庫中檢索出記錄的順序。設置第二參數reorder爲true,可以覆蓋前面定義的排序條件。
db.Order("age desc,name").Find(&users) // SELECT * FROM users ORDER BY age desc, name; // 多字段排序 db.Order("age desc").Order("name").Find(&users) // SELECT * FROM users ORDER BY age desc, name; // 覆蓋排序 db.Order("age desc").Find(&users1).Order("age",true).Find(&users2) // SELECT * FROM users ORDER BY age desc;(users1) // SELECT * FROM users ORDER BY age;(users2)
數量
Limit,指定從數據庫檢索出的最大記錄數。
db.limit(3).Find(&users) // SELECT * FROM users LIMIT 3; // -1 取消Limit 條件 db.Limit(10).Find(&users1).Limit(-1).Find(&users2) // SELECT * FROM users LIMIT 10; (users1) // SELECT * FROM users; (users2)
偏移
Offset,指定開始返回記錄錢要跳過的記錄數。
db.Offset(3).Find(&users) // SELECT * FROM users OFFSET 3; // -1 取消Offset條件 db.Offset(10).Find(&users1).Offset(-1).Find(&users2) // SELECT * FROM users OFFSET 10; (users1) // SELECT * FROM users;(USERS2)
總數
Count,該model能獲取的記錄總數。
db.Where("name = ?","jinzhu").Or("name = ?","jinzhu 2").Find(&users).Count(&count)
// SELECT * FROM users WHERE name = 'jinzhu' OR 'jinzhu 2';(users)
// SELECT count(*) FROM users WHERE name = 'jinzhu' OR name = 'jinzhu 2';(count)
db.Model(&User{}).Where("name = ?","jinzhu").Count(&count)// SELECT count(*) FROM users WHERE name = 'jinzhu'; (count)
db.Table("deleted_users").Count(&count)
// SELECT count(*) FROM deleted_users;
db.Table("deleted_users").Select("count(distinct(name))").Count(&count)
// SELECT count(distinct(name)) FROM deleted_users; (count)注意:Count必須是鏈式查詢的最後一個操作羅,因爲它會覆蓋前面的SELECT,但如果裡面使用了count時不會覆蓋。
Group& Having
rows, err := db.Table("orders").Select("date(created_at) as date, sum(amoount) as total").Group("date(created_at)").Rows()
for rows.Next(){
...
}例子:如何把rows中的數據映射到結構體裡
// 使用scan將多條結果掃描進事先準備好的結構體切片中
type Result struct {
Date time.Time
Total int
}
var rets []Result // 定義一個切片,用Scan把結果掃描到切片
db.Table("users").Select("date(created_at) as date, sum(age) as total").Group("date(created_at)").Scan(&rets)
rows, err := db.Table("orders").Select("date(created_at) as date, sum(amount) as total").Group("date(created_at)").Having("sum(amount) > ?",100).Rows()
for rows.Next(){
...
}
type Result struct {
Date time.Time
Total int64
}
db.Table("orders").Select("date(created_at) as date, sum(amount) as total").Group("date(created_at)").Having("sum(amount) > ?",100).Scan(&results)連接
// Joins,指定連接條件
rows, err := db.Table("users").Select("users.name, emails.email").Joins("left join emails on emails.user_id)
for rows.Next(){
...
}
db.Table("users").Select("users.name, emails.email").Joins("left join emails on emails.user_id = users.id")
// 多連接及參數
db.Joins("JOIN emails ON emails.user_id = users.id AND emails.email = ?","jinzhu@example.org").Joins("...")Pluck
Pluck,查詢model中的一個列,作爲切片,如果想查詢多個列,使用scan。
var ages []int64
db.Find(&users).Pluck("age",&ages)
var names []string
db.Model(&User{}).Pluck("name",&names)
db.Table("deleted_users").Pluck("name",&names)
// 查詢多個字段
db.Select("name,age").Find(&users)掃描
Scan,掃描結果至一個struct
type Result struct {
Name string
Age int
}
var result Result
db.Table("users").Select("name,age").Where("name = ?","Antonio").Scan(&result)
// 原生SQL
Db.Raw("SELECT name, age FROM users WHERE name = ?", "Antonio").Scan(&result)鏈式操作相關
鏈式操作
Method Chaining,Gorm實現了鏈式操作接口,所以可以把代碼寫成這樣:
// 創建一個查詢
tx := db.Where("name = ?", "jinzhu")
// 添加更多條件
if someCondition {
tx = tx.Where("age = ?", 20)
} else {
tx = tx.Where("age = ?", 30)
}
if yetAnotherCondition {
tx = tx.Where("active = ?", 1)
}在調用立即執行方法前不會生成Queryyuju ,借助這個特性可以創建一個函數來處理一些通用邏輯。
立即執行方法(Immediate methods):是指那些會立即生成SQL語句並發送到數據庫的方法,他們一般是CURD方法。
Create,First,Find,Take,Save,UpdateXXX,Delete,Scan,Row,Rows ...
這是一個基於上面鏈式方法代碼的立即執行方法的例子:
tx.Find(&user)
生成的SQL語句如下:
SELECT * FROM users WHERE name = 'jinzhu' AND age = 30 AND active = 1;
範圍
Scopes:是建立在鏈式操作的基礎之上的。
基於它,可以抽取一些通用邏輯,寫出更多可重用的函數庫。
func AmountGeaterThan1000(db *gorm.DB) *gorm.DB {
return db.Where("amount > ?", 1000)
}
func PaidWithCreditCard(db *gorm.DB) *gorm.DB {
return db.Where("pay_mode_sign = ?", "C")
}
func PaidWithCod(db *gorm.DB) *gorm.DB {
return db.Where("pay_mode_sign = ?","C")
}
func OrderStatus(status []string) func (db *gorm.DB) *gorm.DB {
return func (db *gorm.DB) *gorm.DB {
return db.Scopes(AmountGreaterThan1000).Where("status" IN (?), status)
}
}
db.Scopes(AmountGreaterThan1000, PaidWithCreditCard).Fina(&orders)
// 查找所有金額大於1000的信用卡訂單
db.Scopes(AmountGreaterThan1000,PaidWithCod).Find(&orders)
// 查找所有金額大於1000的COD訂單
db.Scopes(AmountGreaterThan1000,OrderStatus([]string{"paid","shipped"})).Find(&orders)
// 查找所有金額大於1000已付或者已發貨的訂單多個立即執行方法
Multiple Immediate Methods,在GORM中使用多個立即執行方法時,後一個立即執行方法會複用前一個立即執行方法的條件(不包括内聯條件)
db.Where("name LIKE ?","jinzhu%").Find(&users, "id IN (?)", []int{1,2,3}).Count(&count)生成的SQL
SELECT * FROM users WHERE name LIKE 'jinzhu%' AND id IN(1,2,3) SELECT count(*) FROM users WHERE name LIKE 'jinzhu%'