【Laravel】クエリビルダによるデータベース操作：使用方法とメソッド一覧

DBファサードをuseする

DBファサードを利用する場合、必ずスクリプトにDBファサードをuse文で読み込んでおきます。

use Illuminate\Support\Facades\DB;

基本的なクエリビルダの使い方

クエリビルダは以下のように、DB:table(テーブル名)で始まり、そのあとはメソッドチェーンを連続して呼び出して必要なSQLクエリを作成します。

$blogs = DB::table('blogs')
    ->where('title', 'Laravel')
    ->orderBy('contents', 'asc')
    ->get();

最後はget()やfind()、value()といったメソッドを使用してクエリ結果を取得します。

ビルダの取得：table()

クエリビルダを利用する場合、まず最初にDBクラスのtable()メソッドを呼び出します。tableメソッドにより「ビルダ」を取得し、その後はビルダに備わっているメソッドを呼び出していく（メソッドチェーン）ことで、SQLクエリ文が生成されます。

ビルダはIlluminate\Database\QueryにあるBilderクラスです。

レコードの取得：get()

クエリビルダの最後にはレコードを取得するメソッドを使用します。レコードを取得するメソッドの一つにget()メソッドがあります。

get()メソッドはクエリの結果からレコードを取得するメソッドであり、SQLのselect文に相当します。そのためクエリ結果のすべてのレコードを返します。get()メソッドの戻り値はコレクションとなっています。

public function index()
{
    $blogs = DB::table('blogs')->get();
    return view('user.index', ['blogs' => $blogs]);
}

get()メソッドの引数にフィールドを指定することで、指定したフィールドだけを取り出すことができます。引数なしで利用するとすべてのフィールドの値を取得します。

$blogs = DB::table('blogs')->get('title', 'contents'));

最初のレコードを取得：first()

クエリ結果から最初のレコードのみを取得するにはfirst()メソッドを使用します。返すレコードは１つのみなので、戻り値はそのレコードのオブジェクトとなります。

first()メソッドはwhere()メソッドなどと共に利用され、クエリ結果が１つのレコードのみであることがわかっている場合に利用されることが多いです。

$blog = DB::table('blogs')->where('title', 'Laravel')->first();

return $blog->contents;

単一のフィールド値のみ取得：value()

クエリ結果から単一のフィールド値のみ取得するにはvalue()メソッドを使用します。value()の引数には取得したいフィールドを指定します。

$contents = DB::table('blogs')->where('title', 'Laravel')->value('contents');

idから単一のレコードを取得：find()

指定したidと一致する単一のレコードを取得するにはfind()メソッドを使用します。引数にidを指定することで、idと一致するレコードが返されます。

$blog = DB::table('blogs')->find(54);

指定したカラムの取得：select()

select()メソッドは指定したカラムの値を取得するメソッドです。SQLのselectに相当します。

引数には取得したいカラム（フィールド名）を指定します。クエリビルダでselect()メソッドを使用しない場合はデフォルトですべてのカラムが取得されるselect('*')が使用されていることとなります。

select()メソッドだけではクエリは実行されません。get()などをメソッドチェーンすることでクエリ結果を取得できます。

$users = DB::table('users')->select('name', 'age')->get();

集計関数を使用する場合はselectの引数には次のように指定します。

$orders = DB::table('orders')
    ->select('group_id', DB::raw('count(*) as total_orders'))
    ->groupBy('group_id')
    ->get();

カラムの値をすべて取得：pluck()

特定のカラム（フィールド）の値をすべて取得するにはpluck()メソッドを使用します。

引数には取得したいフィールド名を指定し、指定したフィールドの値をコレクションとして返します。返された値は以下のようにforeachで処理することもできます。

$users = DB::table('users')->pluck('name');
foreach ($users as $user) {
    echo $user;
}

コレクションではなく配列で利用したい場合はpluck()の後にall()を使用して配列に変換しましょう。

$users = DB::table('users')->pluck('name')->all();

条件指定：where()

SQLのwhere句に相当するメソッドがwhere()メソッドです。引数に条件を指定することでレコードの条件検索ができます。

引数にフィールド名と値の２つを指定することでフィールド名が値と合致するレコードに絞り込みます。

$blog = DB::table('blogs')->where('title', 'Laravel')->first();

引数にフィールド名と演算記号、値の３つを指定することでより細かい検索ができます。例えばidが54より大きいレコードを検索するなどが可能となります。

$blog = DB::table('blogs')->where('id', '>', 54)->get();

複数の条件指定：orWhere()

複数の条件を指定するにはwhere()メソッドとorWhere()メソッドを組み合わせて使用します。

すべての条件に合致するレコードのみを検索する場合はwhere()のみを以下構文のように複数続けて使用します。

上記では条件1と条件2の２つに合致するレコードが取得できます。

条件に１つでも合致するレコードすべてを検索する場合はwhere()メソッドとorWhere()メソッドを使用します。

上記では条件1または条件2のどちらかに合致するレコードが取得できます。例えばユーザーから送信されたテキストがtitleまたはcontentsフィールドに含まれるレコードを抽出するには次のように記述します。

public function search(Request $request)
{
    $text = $request->text;
    $items = DB::table('blogs')
        ->where('title', 'like', '%' . $text . '%')
        ->orWhere('contents', 'like', '%' . $text . '%')
        ->get();
    return view('search', ['items' => $items]);
}

検索の条件を文字列で指定：whereRaw/orWhereRaw()

検索条件を文字列で指定したい場合はwhereRaw()メソッドまたはorWhereRaw()を使用します。

第一引数には検索条件を式で指定、第二引数には条件式内の「？」またはプレースホルダに埋め込むパラメータを配列（連想配列）で指定します。

public function search(Request $request)
{
    $items = DB::table('users')
        ->whereRaw('age >= ? and age <= ? ', [20, 54])
        ->get();
    return view('search', ['items' => $items]);
}

以下コード例ではブログを作成した本人のブログまたは管理者権限のユーザーであればすべてのブログがビューに返される内容となっています。

public function search(Request $request)
{
    $items = DB::table('blogs')
        ->where('created_by', \Auth::user()->id)
        ->orWhereRaw('1=?', [$request->user()->is_admin?1:0])
        ->get();
    return view('search', ['items' => $items]);
}

並び順の指定：orderBy()

クエリ文で取り出されるレコードの並び順を指定するにはorderBy()メソッドを使用します。第一引数にはフィールド名、第二引数には昇順を表す「asc」、または降順を表す「desc」を指定します。

$blog = DB::table('blogs')->where('title', 'Laravel')->orderBy('contents', 'asc')->get();

カラムの値でグループ化：groupBy

groupBy()メソッドはクエリ結果を特定のカラム（フィールド）の値に基づいてグループ化するメソッドです。SQLのgroup byに相当します。

例えばユーザーの住んでいる都道府県でグループ化や商品の品目でグループ化するといった使い方をされます。

グループ化した項目の合計値やカウントを計測するために、groupBy()メソッドは集計関数（sum()やcount()、max()など）と共に利用されることが多いです。

以下コード例はgroup_idでグループ化して、そのレコード数をカウントしています。

$counts = DB::table('users')
    ->select('group_id', DB::raw('count(*) as total'))
    ->groupBy('group_id')
    ->get();

グループ化した結果を条件抽出：having/havingRaw

having()メソッドはグループ化した結果をフィルタリング（抽出条件を指定）するメソッドです。SQLのhavingに相当します。主にgroupBy()メソッドと組み合わせて利用します。

where()メソッドはグループ化する前の個々のレコードに対して条件検索をしますが、having()メソッドの対象はグループ化されたデータです。

例えば購入金額の平均がいくら以上の顧客を抽出するなどで利用されます。以下にコード例を記します。

$users = DB::table('users')
    ->groupBy('group_id')
    ->having('group_id', '>', 54)
    ->get();

生のSQLを引数で使用したい場合はhavingRaw()メソッドを使用します。

第一引数には検索条件を式で指定、第二引数には条件式内の「？」またはプレースホルダに埋め込むパラメータを配列（連想配列）で指定します。

$results = DB::table('orders')
    ->groupBy('account_id')
    ->havingRaw('SUM(amount) > ?', [5400])
    ->get();

抽出するレコードの制限：limit()

クエリ結果から抽出するレコード数を制限したい場合はlimit()メソッドを使用します。limit()メソッドは引数に指定した数だけレコードを取得します。

指定した位置からレコードを取得：offset()

クエリ結果から指定した位置以降のレコードを抽出するにはoffset()メソッドを使用します。offset()の引数に指定した数値からのレコードを取得します。

レコードの追加：insert()

クエリビルダによるレコードを追加するにはinsert()メソッドを使用します。

引数にはカラム名と値の配列を渡します。つまり連想配列のような形になります。これにより配列のデータがレコードとして保存されます。

DB::table('users')->insert([
    'email' => 'office54@office54.net',
    'age' => 54
]);

レコードの更新：update()

クエリビルダによる既存のレコードの更新にはupdate()メソッドを使用します。

insert()と同様に引数にはカラム名と値の配列を渡します。update()によるレコードの更新を行う場合は、where()メソッドなどを用いてレコードを絞り込んでから更新を行います。

DB::table('users')
    ->where('id', 55)
    ->update([
        'email' => 'office54@office54.net',
        'age' => 55
]);

レコードの削除：delete()

クエリビルダによる既存レコードの削除にはdelete()メソッドを使用します。

引数には何も指定せず、呼び出すだけでレコードを削除できます。delete()メソッドを使用する場合も必ずwhere()メソッドなどでレコードを絞り込んでおく必要があります。

DB::table('users')
    ->where('id', 1)
    ->delete();