Preloading (Eager Loading)

Preload

GORMの Preload を使用すると、別のSQLを発行して関連レコードを eager loading することができます。例:

type User struct {
gorm.Model
Username string
Orders []Order
}

type Order struct {
gorm.Model
UserID uint
Price float64
}

// Preload Orders when find users
db.Preload("Orders").Find(&users)
// SELECT * FROM users;
// SELECT * FROM orders WHERE user_id IN (1,2,3,4);

db.Preload("Orders").Preload("Profile").Preload("Role").Find(&users)
// SELECT * FROM users;
// SELECT * FROM orders WHERE user_id IN (1,2,3,4); // has many
// SELECT * FROM profiles WHERE user_id IN (1,2,3,4); // has one
// SELECT * FROM roles WHERE id IN (4,5,6); // belongs to

Joins による Preloading

Preload はアソシエーションデータを別々のクエリでロードします。 Join Preload は内部結合を使用してアソシエーションデータをロードします。例:

db.Joins("Company").Joins("Manager").Joins("Account").First(&user, 1)
db.Joins("Company").Joins("Manager").Joins("Account").First(&user, "users.name = ?", "jinzhu")
db.Joins("Company").Joins("Manager").Joins("Account").Find(&users, "users.id IN ?", []int{1,2,3,4,5})

条件を指定して結合する

db.Joins("Company", DB.Where(&Company{Alive: true})).Find(&users)
// SELECT `users`.`id`,`users`.`name`,`users`.`age`,`Company`.`id` AS `Company__id`,`Company`.`name` AS `Company__name` FROM `users` LEFT JOIN `companies` AS `Company` ON `users`.`company_id` = `Company`.`id` AND `Company`.`alive` = true;

注意 Join Preload は、1 対 1 関係にあるリレーションで動作します。例えば has one, belongs to がそれにあたります。

Preload All

レコード作成/更新時の Select で指定するのと同様に、 Preload でも clause.Associations を指定することができます。全ての関連レコードを Preload する際にこれを使用することができます。例:

type User struct {
gorm.Model
Name string
CompanyID uint
Company Company
Role Role
Orders []Order
}

db.Preload(clause.Associations).Find(&users)

clause.Associations はネストした関連のPreloadは行いません。しかし、 Nested Preloading と併用することができます。例:

db.Preload("Orders.OrderItems.Product").Preload(clause.Associations).Find(&users)

条件付きのPreload

GORMでは条件付きでのPreloadが可能です。これは Inline Conditions と同様の動作になります。

// Preload Orders with conditions
db.Preload("Orders", "state NOT IN (?)", "cancelled").Find(&users)
// SELECT * FROM users;
// SELECT * FROM orders WHERE user_id IN (1,2,3,4) AND state NOT IN ('cancelled');

db.Where("state = ?", "active").Preload("Orders", "state NOT IN (?)", "cancelled").Find(&users)
// SELECT * FROM users WHERE state = 'active';
// SELECT * FROM orders WHERE user_id IN (1,2) AND state NOT IN ('cancelled');

Preload の SQL をカスタマイズする

func(db *gorm.DB) *gorm.DB を引数に渡すことで、PreloadのSQLをカスタマイズできます。例:

db.Preload("Orders", func(db *gorm.DB) *gorm.DB {
return db.Order("orders.amount DESC")
}).Find(&users)
// SELECT * FROM users;
// SELECT * FROM orders WHERE user_id IN (1,2,3,4) order by orders.amount DESC;

Nested Preloading

GORMはネストした関連データのPreloadをサポートしています。例:

db.Preload("Orders.OrderItems.Product").Preload("CreditCard").Find(&users)

// Customize Preload conditions for `Orders`
// `Orders` の Preload をカスタマイズして、
// 条件に一致しない `Orders` の `OrderItems` を preloadしないようにする
db.Preload("Orders", "state = ?", "paid").Preload("Orders.OrderItems").Find(&users)

Gold Sponsors

Become a Sponsor!

Gold Sponsors

Become a Sponsor!