Laravelのクエリビルダ記法まとめ（QueryBuilder/DB Facade）

get()

条件指定に沿った結果データの全てを取得します。

$data = $users->get();

取得出来る結果データは、StdClassオブジェクトのインスタンスを結果として含むCollectionオブジェクトとして返ってきます。個々の結果データにアクセスするには、以下のようにループで回したり、オブジェクトから直接取得する事も出来ます。

// ループで1件ずつ取得
foreach ($data as $d) {
    echo $d->name;
}

// 結果データそのものから直接取得
echo $data[0]->name;

first()

結果データの最初の1件のみを取得します。結果が何件であっても、1件のみを取得します。

$data = $users->first();

結果データはStdClassオブジェクトで取得されます。取り出すにはオブジェクトのプロパティにアクセスします。

echo $data->name;

value()

value()メソッドで指定した1つのカラムのみを取得します。

$data = $users->value('email');

ただしこのメソッドは条件に限らず1件のみを取得するので、where句などと併用して狙った1件を取得する際などに使います。

echo $data; // test01@test.com

pluck()

pluck()メソッドで指定カラム1つだけをコレクションで取得出来ます。

$data = $users->pluck('email');

こちらはvalue()メソッドとは違い、条件の結果全てのデータを取得します。

Array
(
    [0] => test01@test.com
    [1] => test03@test.com
    [2] => test04@test.com
    [3] => test05@test.com
    [4] => test06@test.com
    [5] => test07@test.com
    [6] => test08@test.com
    [7] => test09@test.com
    [8] => test10@test.com
)

データへのアクセスは、ループでも直接でも取り出しが可能です。

// ループで1件ずつ取得
foreach ($data as $d) {
    echo $d;
}

// 結果データそのものからアクセス
echo $data[0];

ちなみに、取得コレクションの識別子（プロパティ）カラムを指定する事も可能です。

$data = $users->pluck('email', 'name');

第一引数に取り出すカラムを、第二引数にプロパティカラムを指定する事で。key-valueの形での取得が行えます。

Array
(
    [user01] => test01@test.com
    [user02] => test02@test.com
    [user03] => test03@test.com
    [user04] => test04@test.com
    [user05] => test05@test.com
    [user06] => test06@test.com
    [user07] => test07@test.com
    [user08] => test08@test.com
    [user09] => test09@test.com
    [user10] => test10@test.com
)

exists()

exists()メソッドを使うと、条件に対してレコードが存在するかを確認できます。

$data = $users->exists();

レコードが存在する場合は true を返し、レコードが存在しなければ false が返ります。

if ($data) {
    // レコードは存在する
} elseif (!$data) {
    // レコードは存在しない
}

doesntExist()

doesntExist()メソッドはexists()メソッドの逆です。レコードが存在しない場合は true を返し、レコードが存在する場合ば false が返ります。

$data = $users->doesntExist();

if ($data) {
    // レコードは存在しない
} elseif (!$data) {
    // レコードは存在する
}

toSql()

toSql()メソッドで、発行しようとしているSQL文を確認できます。

$data = $users->toSql();

結果を格納した変数$dataにSQL文が格納されます。

echo $data;  // => select * from `users`

count()

count()メソッドで、レコードの件数を取得できます。

$data = $users->count();

echo $data;  // => 10（件）

max()

max()メソッドで、指定カラムの最大値を取得できます。

$data = $users->max('id');

echo $data;  // => 10

引数にはカラム名を指定します。

min()

min()メソッドで、指定カラムの最小値を取得できます。

$data = $users->min('id');

echo $data;  // => 1

引数にはカラム名を指定します。

avg()

avg()メソッドで、指定カラムの平均値を取得できます。

$data = $users->avg('id');

echo $data;  // => 5.5000

引数にはカラム名を指定します。

sum()

sum()メソッドで、指定カラムの合計値を取得できます。

$data = $users->sum('id');

echo $data;  // => 55

引数にはカラム名を指定します。

rawメソッド

DB::rawは最も基本的なSQL文挿入メソッドです。更に各セクション毎に用意されているrawメソッドを使う事によって、記述を短縮できます。

$data = $users->selectRaw('COUNT(*) AS user_count')->get();

$data = $users->whereRaw('`role` = 1')->get();

$data = $users->whereRaw('`role` = ? AND id < ?', [1, 5])->get();

$data = $users
    ->select('role', DB::raw('SUM(role) as role_count'))
    ->groupBy('role')
    ->havingRaw('role > 1')
    ->get();

// 取得結果
[0] => stdClass Object
    (
        [role] => 5
        [role_count] => 20
    )

[1] => stdClass Object
    (
        [role] => 10
        [role_count] => 50
    )

$data = $users
    ->orderByRaw('updated_at - created_at DESC')
    ->get();

INNER JOIN

join()メソッドを使います。

$data = $users
    ->join('role', 'users.role', '=', 'role.role_id')
    ->join('message', 'users.id', '=', 'message.user_id')
    ->get();

上記のようにjoin()メソッドをチェインする事で、複数のテーブルを結合できます。

LEFT JOIN

leftJoin()メソッドを使います。

$data = $users
    ->leftJoin('message', 'users.id', '=', 'message.user_id')
    ->get();

CROSS JOIN

crossJoin()メソッドを使います。

クロス結合を行いたいテーブルを指定する事で、基テーブルと指定テーブルのデカルト積（すべての行の組み合わせ）を取得できます。

$data = $users->crossJoin('role')->get();

複雑なJOIN

JOINの条件が通常よりも複雑な場合は、第二引数にクロージャを指定し定義する事で、実現できます。

$data = $users
    ->join('contacts', function ($join) {
        $join->on('users.id', '=', 'contacts.user_id')
             ->orOn(...);
    })
    ->get();

クロージャの中でWHERE句を用いることもできます。

$data = $users
    ->join('contacts', function ($join) {
        $join->on('users.id', '=', 'contacts.user_id')
             ->where('contacts.user_id', '>', 5);
    })
    ->get();

ベーシックなWHERE節

ポピュラーなWHERE節を使うには、where()メソッドを使います。

第一引数にカラム名、第二引数に比較演算子、またはSQLで使うオペレータ、第三引数に比較する値を指定します。

$data = $users->where('id', '>', 5)->get();

第二引数がイコール、つまり等しい場合に限っては、比較演算子を省略し、引数は2つで取得できます。

// id=5 の場合
$data = $users->where('id', 5)->get();

LIKE句も、同様に三つの引数で取得できます。

$data = $users->where('email', 'like', '%test.com')->get();

これらのwhere()メソッドはチェインによって AND でのWHERE句を形成できますが、配列で渡す事によって一度のwhere()メソッドでそれを実現できます。

$data = $users->where([
    ['role', '>', 5],
    ['id', '>', 6]
])->get();

OR節

先に紹介したものはすべて、チェインでつなげるとANDでのWHERE句になりますが、当然、ORも記述できます。

その場合は、orWhere()メソッドを使います。

$data = $users
    ->where('role', '>', 5)
    ->orWhere('role', '>', 8)
    ->get();

whereBetween

whereBetween()メソッドを使うと、BETWEEN節（AとBの間）を記述できます。

$data = $users->whereBetween('id', [4, 6])->get();

第一引数に対象カラム、第二引数には配列でそれぞれ、対象の値を渡します。

IN節

IN句に関するメソッドは以下の通りです。

$data = $users->whereIn('id', [2, 5, 9])->get();

$data = $users->whereNotIn('id', [2, 5, 9])->get();

「含まれる・含まれない」は完全一致である点に注意してください。”あいまい”の意ではありません。

Null判別

null判定のメソッドは以下の通りです。

$data = $users->whereNull('email')->get();

$data = $users->whereNotNull('email')->get();

日時比較

日時の比較を行う際にも、Laravelのクエリビルダには専用のメソッドが用意されています。

$data = $users->whereDate('updated_at', '2018-03-21')->get();

whereMonth / orWhereMonth

月の比較には、whereMonth()メソッドを使います。

$data = $users->whereMonth('updated_at', 2)->get();

※orWhereMonth()はver5.6.10以降で使用可能です。

whereDay / orWhereDay

日付の値そのものとの比較にはwhereDay()メソッドを使います。

$data = $users->whereDay('updated_at', 25)->get();

※orWhereDay()はver5.6.10以降で使用可能です。

whereYear / orWhereYear

年の比較には、whereYear()メソッドを使います。

$data = $users->whereYear('updated_at', 2018)->get();

※orWhereYear()はver5.6.10以降で使用可能です。

whereTime

時間の比較には、whereYear()メソッドを使います。

$data = $users->whereTime('updated_at', '<', '12:00')->get();

単純ソート

単純なソートに関しては、専用のソートメソッドも用意されています。

$data = $users->latest()->get();

$data = $users->oldest()->get();

ランダムで並び替え

inRandomOrder()メソッドを使うと、結果データをランダムな順番に出来ます。

$data = $users->inRandomOrder()->get();

LIMIT

取得レコード数を制限するには、limit()メソッドを使います。

$data = $users->limit(3)->get();

OFFSET

結果レコードの取得開始位置（何件目から取得するか）を指定するには、offset()メソッドを使います。

$data = $users
    ->offset(2)
    ->limit(3)
    ->get();

OFFSETは得てしてLIMIT節と組み合わせて使う事が多いですが、上記の例の場合では「2件目から3件取得する」という意味になります。

挿入後に自動増分IDを取得する

テーブルが自動増分ID（オートインクリメント＝AUTO_INCREMENT）を持っている場合には、insertGetId()メソッドでレコード挿入を行う事で、返り値に自動増分IDを取得できます。

$data = $users
    ->insertGetId(
        [
            'name' => 'test11',
            'email' => 'test11@test.com',
            'password' => '123456',
            'role' => 5
        ]
    );

注意点として、PostgreSQLでinsertGetId()メソッドを使う場合に、デフォルトでは自動増分IDカラム名は idでなければなりません。

自動増分IDカラム名がidではなく他の名前の場合は、第二引数にそのカラム名を指定する必要があります。

JSONカラムの更新

もちろんJSONカラムも更新が可能です。その場合はアロー演算子（->）で適切な変更対象を指定します。

$data = $users
    ->where('id', 1)
    ->update(['options->enabled' => true]);

カラムの値を増減させる単純な更新

例えば、カラムの中に何かのカウント数を持っていたとして、何かの時にその値を1だけ増やしたいとか減らしたいとか、もしくは任意の数だけ増減させたいなんて事もよくあります。

その時にはincrement()とdecrement()メソッドを使うと簡単に実装する事が出来ます。

$data = $users->where('id', 1)->increment('count');
$data = $users->where('id', 1)->increment('count', 3);

上記はincrement()メソッドでcountカラムの値を加算させています。

第二引数に値を指定すればその分の数が、指定しなければ1が加算され更新されます。

$data = $users->where('id', 1)->decrement('count');
$data = $users->where('id', 1)->decrement('count', 3);

上記はdecrement()メソッドでcountカラムの値を減算させています。

こちらも同様に、第二引数に値を指定すればその分の数が、指定しなければ1が減算され更新されます。

ちなみに上記は1件のレコードに対して更新を行っていますが、where節を変更して対象のレコードに対してまとめて更新をかける事ももちろん可能です。

そしてincrement()とdecrement()メソッドの使えるところは、増減させるだけではなく、他の通常の更新情報を配列で第三引数に渡す事で、増減以外の更新も行える事です。

$data = $users->where('id', 1)->increment('count', 3, ['name' => 'test1-2']);

上記のようにする事で、増減をおこないつつ、他のカラムに対しても通常の更新を行う事が出来ます。

TRUNCATE

delete()メソッドは単純にレコードを削除するだけなので、もし全レコードを削除しても、自動増分IDはリセットされません。

もしテーブル内を全て削除し、オートインクリメントもリセットしたい場合は、truncate()メソッドを使います。

$users->truncate();

共有ロック

sharedLock()メソッドを使う事で、トランザクションがコミットされるまでSELECTしている行が更新されることを防ぐことが出来ます。

$data = $users->where('id', 1)->sharedLock()->get();

占有ロック

lockForUpdate()メソッドを使う事で、レコードを更新したりSELECTするために他の共有ロックが行われるのを防ぐことが出来ます。

$data = $users->where('id', 1)->lockForUpdate()->get();