Laravelのwith関数（Eagerロード）でクエリチューニング｜エンジニアBLOG

Laravelを使って開発をする際に、親子関係にあるテーブルのデータをまとめて取得したいという場面があります。

今回はこのようなときに便利なwith関数（Eagerロード）についてご説明します。

関連する複数のテーブルのデータをまとめて取得する場合に、

の２種類の方法があります。

例えば、下記のような２つのテーブルがあり、請求書Aとその明細のデータを取得するとします。

Lazy Loadingでは、

というように２回に分けてデータを取得します。

これに対してEager Loadingでは、２つのテーブルのデータを１度に取得します。

Eager Loadingを使うと、クエリの発行回数を減らすことができるので、いわゆる「N＋１問題」の回避策として用いられます。

N＋１問題とは？

クエリの発行回数が過剰に増えて、サーバーサイドでタイムアウトエラーなどの不具合を起こしてしまう現象をいいます。

with関数以外にも、leftJoin関数を利用することで、関連テーブルのデータをまとめて取得することができます。

それでは、with関数とleftJoin関数は、どのように使い分ければ良いのでしょうか？

２つの関数の特徴について表にまとめると下記のようになります。

leftJoin関数は関連データをフラットな形で取得するので、親子関係が１対１のとき（ケース①）は問題ありませんが、１対多のとき（ケース②）は親側にダブりが出てしまいます。

これに対して、with関数は関連データをネストした形で取得するので、親子関係が１対多のときでもダブリなく取得できるのです。

なので、親子関係が１対１のときはleftJoin関数、１対多のときはwith関数を使うと覚えておくといいかもしれません。

with関数を使うときは、次の２ステップを踏みます。

①モデルにリレーションを定義する

public function invoice_detail() {
    return $this->hasMany('App\Models\InvoiceDetail');
}

②データを取得するときにwith関数を使う

Invoice::with('invoice_detail')->where('id', $invoice_id)->first();

with関数は単に小テーブルのデータを取得するだけではなく、下記のようなこともできます。

複数のリレーションをカンマ（,）で区切って書きます。

Invoice::with([invoice_detail,relation_slip])->where('id', $invoice_id)->first();

リレーションの後にコロン（:）を付けて、続けてカラム名をカンマ（,）で区切って書きます。

Invoice::with('invoice_detail:id,name')->where('id', $invoice_id)->first();

Invoice::with('invoice_detail')->where('id', $invoice_id)->first();

リレーションの後にピリオド（.）を付けて、続けて孫のリレーションを書きます。

Invoice::with('invoice_detail.')->where('id', $invoice_id)->first();