Gormで複雑なSQLを実行したい！【ひと味違うDB操作】

この記事はで読むことができます。

目次非表示

はじめに
Gormで複雑なSQLを実行する方法
複雑なクエリの例
- 例1: 複数テーブルの結合とグループ化
- 例2: ウィンドウ関数の使用
パフォーマンスの考慮事項
まとめ

はじめに

Gorm（Go Object Relational Mapper）は、Go言語用の人気の高いORMライブラリです。ORMを使用することで、データベース操作を簡単に行うことができますが、時には複雑なSQLクエリを実行する必要が出てくることがあります。本記事では、Gormを使用して複雑なSQLを実行する方法について、初心者にも分かりやすく解説していきます。

Gormは基本的な CRUD（Create, Read, Update, Delete）操作を簡単に行えるように設計されていますが、より複雑なデータ取得や操作が必要な場合もあります。そのような場合、Gormは raw SQL や様々なクエリ生成メソッドを提供しており、これらを使うことで複雑なSQLを実行できます。

Gormで複雑なSQLを実行する方法

Gormで複雑なSQLを実行するには、主に以下の方法があります。

Raw SQL
クエリビルダー
サブクエリ
トランザクション
スコープ

それぞれの方法について、詳しく見ていきましょう。

1. Raw SQL

Raw SQLは、直接SQLクエリを書いて実行する方法です。この方法は、Gormの抽象化層をバイパスして、データベースに直接クエリを送信します。

Raw SQLの基本的な使い方

type Result struct {
    ID   int
    Name string
    Age  int
}

var result Result
db.Raw("SELECT id, name, age FROM users WHERE id = ?", 3).Scan(&result)

この例では、Rawメソッドを使用して直接SQLクエリを実行し、結果をScanメソッドでResult構造体にマッピングしています。

複数の結果を取得する

var results []Result
db.Raw("SELECT id, name, age FROM users WHERE age > ?", 20).Scan(&results)

この例では、複数の結果をresultsスライスに格納しています。

Exec を使用してデータを更新する

db.Exec("UPDATE users SET name = ? WHERE id = ?", "John", 3)

Execメソッドを使用すると、SELECT以外のSQL文（INSERT, UPDATE, DELETE等）を実行できます。

2. クエリビルダー

Gormのクエリビルダーを使用すると、メソッドチェーンを使って複雑なSQLクエリを構築できます。

基本的な使い方

var users []User
db.Where("age > ?", 20).
   Where("name LIKE ?", "%John%").
   Order("age desc, name").
   Limit(10).
   Find(&users)

この例では、年齢が20歳以上で名前に”John”が含まれるユーザーを、年齢の降順、名前の昇順で10件取得しています。

OR条件の使用

db.Where("role = ?", "admin").
   Or("role = ?", "super_admin").
   Find(&users)

この例では、ロールが”admin”または”super_admin”のユーザーを取得しています。

グループ化と集計

type Result struct {
    Date  time.Time
    Total int
}

var results []Result
db.Model(&Order{}).
   Select("date(created_at) as date, sum(amount) as total").
   Group("date(created_at)").
   Having("sum(amount) > ?", 100).
   Find(&results)

この例では、注文データを日付でグループ化し、合計金額が100を超える日の売上を取得しています。

3. サブクエリ

サブクエリを使用すると、クエリの中に別のクエリを埋め込むことができます。

サブクエリの基本的な使用方法

db.Where("amount > (?)", db.Table("orders").Select("AVG(amount)")).Find(&orders)

この例では、注文金額が平均を超える注文を取得しています。

FROM句でのサブクエリ

db.Table("(?) as u", db.Model(&User{}).Select("name", "age")).
   Where("age > ?", 20).
   Find(&users)

この例では、サブクエリで作成した一時テーブルからデータを取得しています。

4. トランザクション

トランザクションを使用すると、複数のデータベース操作を1つの単位として扱うことができます。

func CreateOrder(db *gorm.DB) error {
    return db.Transaction(func(tx *gorm.DB) error {
        // 注文を作成
        if err := tx.Create(&Order{/*...*/}).Error; err != nil {
            return err
        }

        // 在庫を更新
        if err := tx.Model(&Product{}).
            Where("id = ?", productID).
            Update("stock", gorm.Expr("stock - ?", quantity)).
            Error; err != nil {
            return err
        }

        // トランザクション成功
        return nil
    })
}

この例では、注文の作成と在庫の更新を1つのトランザクションとして扱っています。どちらかの操作が失敗した場合、両方の操作がロールバックされます。

5. スコープ

スコープを使用すると、よく使用するクエリの条件をカプセル化し、再利用可能にすることができます。

func AmountGreaterThan1000(db *gorm.DB) *gorm.DB {
    return db.Where("amount > ?", 1000)
}

func PaidOrders(db *gorm.DB) *gorm.DB {
    return db.Where("paid = ?", true)
}

var orders []Order
db.Scopes(AmountGreaterThan1000, PaidOrders).Find(&orders)

この例では、AmountGreaterThan1000とPaidOrdersというスコープを定義し、それらを組み合わせて使用しています。

複雑なクエリの例

ここでは、より実践的な複雑なクエリの例を見ていきます。

例1: 複数テーブルの結合とグループ化

type Result struct {
    CategoryName string
    TotalSales   float64
}

var results []Result
db.Table("orders").
   Select("categories.name as category_name, SUM(orders.total) as total_sales").
   Joins("JOIN order_items ON orders.id = order_items.order_id").
   Joins("JOIN products ON order_items.product_id = products.id").
   Joins("JOIN categories ON products.category_id = categories.id").
   Where("orders.created_at BETWEEN ? AND ?", startDate, endDate).
   Group("categories.id").
   Having("total_sales > ?", 1000).
   Order("total_sales DESC").
   Find(&results)

この例では、注文、注文項目、製品、カテゴリの4つのテーブルを結合し、特定の期間内のカテゴリ別売上を計算しています。売上が1000を超えるカテゴリのみを、売上の降順で取得しています。

例2: ウィンドウ関数の使用

type Result struct {
    OrderID   uint
    ProductName string
    Quantity  int
    RowNumber int
}

var results []Result
db.Raw(`
    SELECT 
        order_id,
        product_name,
        quantity,
        ROW_NUMBER() OVER (PARTITION BY order_id ORDER BY quantity DESC) as row_number
    FROM order_items
    WHERE order_id IN (
        SELECT id FROM orders WHERE created_at > ?
    )
`, time.Now().AddDate(0, -1, 0)).Scan(&results)

この例では、過去1ヶ月間の注文に対して、各注文内で最も数量の多い商品から順番をつけています。ウィンドウ関数 ROW_NUMBER() を使用していますが、これはRaw SQLでのみ実行可能です。

パフォーマンスの考慮事項

複雑なSQLを実行する際は、パフォーマンスに注意を払う必要があります。以下は、パフォーマンスを向上させるためのいくつかのヒントです。

インデックスの適切な使用: 頻繁に検索や結合に使用されるカラムにはインデックスを作成しましょう。
EAGERロードの活用: 関連するデータを一度に取得することで、N+1問題を回避できます。
ページネーションの実装: 大量のデータを一度に取得するのではなく、ページネーションを使用しましょう。
クエリのキャッシュ: 頻繁に実行される複雑なクエリの結果をキャッシュすることで、データベースの負荷を軽減できます。
クエリの最適化: EXPLAINコマンドを使用して、クエリの実行計画を確認し、必要に応じて最適化しましょう。

具体的にはPreloadを使う事で実行回数を減らせます（2）

   db.Preload("Orders").Preload("Profile").Find(&users)

大量のデータを扱う場合はページネーションを実装しましょう。gormから簡単です！（3）

   db.Offset(10).Limit(10).Find(&users)

まとめ

Gormは、単純なCRUD操作から複雑なSQLクエリの実行まで、幅広いデータベース操作をサポートしています。本記事で紹介した方法を活用することで、高度なデータ分析や複雑なビジネスロジックの実装が可能になります。

Raw SQL、クエリビルダー、サブクエリ、トランザクション、スコープなど、様々なアプローチを組み合わせることで、ほとんどのデータベース操作のニーズに対応できるでしょう。

ただし、複雑なSQLを使用する際は、つねにパフォーマンスとメンテナンス性のバランスを考慮することが重要です。可能な限りGormの抽象化を活用しつつ、必要に応じてRaw SQLを使用するというアプローチが、多くの場合に最適な選択となるでしょう。

Gormを使いこなすことで、Goアプリケーションでのデータベース操作がより柔軟かつ効率的になります。ぜひ、ここで紹介した手法を実際のプロジェクトで試してみてください。複雑なデータベース操作が必要になったとき、この記事が良い参考になることを願っています。