Laravel 데이터베이스: 쿼리 빌더 편집하기

==개요==
{{목차숨김|3}}
;<nowiki>Database: Query Builder</nowiki>
;<nowiki>데이터: 쿼리 빌더</nowiki>

==소개==
Laravel의 데이터베이스 쿼리 빌더는 데이터베이스 쿼리를 생성하고 실행하기 위한 편리하고 유연한 인터페이스를 제공합니다. 이 빌더는 애플리케이션에서 대부분의 데이터베이스 작업을 수행하는 데 사용할 수 있으며, Laravel이 지원하는 모든 데이터베이스 시스템과 완벽하게 호환됩니다.

Laravel 쿼리 빌더는 SQL 인젝션 공격으로부터 애플리케이션을 보호하기 위해 PDO 파라미터 바인딩을 사용합니다. 쿼리 빌더에 전달되는 문자열을 클리닝(clean)하거나 정화(sanitize)할 필요가 없습니다.

PDO는 컬럼 이름 바인딩을 지원하지 않습니다. 따라서 사용자 입력이 쿼리에서 참조되는 컬럼 이름, 특히 "order by" 컬럼을 결정하도록 허용해서는 안 됩니다.

==데이터베이스 쿼리 실행==
;테이블에서 모든 행 조회
다음은 <code>DB</code> 파사드에서 제공하는 <code>table</code> 메소드를 사용하여 쿼리를 시작하는 방법에 대한 설명입니다. <code>table</code> 메소드는 주어진 테이블에 대한 유창한 쿼리 빌더 인스턴스를 반환하며, 이를 통해 쿼리에 더 많은 제약조건을 연쇄적으로 추가하고, 마지막으로 <code>get</code> 메소드를 사용하여 쿼리 결과를 검색할 수 있습니다:

<syntaxhighlight lang='php'>
<?php
 
namespace App\Http\Controllers;
 
use Illuminate\Support\Facades\DB;
use Illuminate\View\View;
 
class UserController extends Controller
{
    /**
     * Show a list of all of the application's users.
     */
    public function index(): View
    {
        $users = DB::table('users')->get();
 
        return view('user.index', ['users' => $users]);
    }
}
</syntaxhighlight>

<code>get</code> 메소드는 쿼리 결과를 포함하는 <code>Illuminate\Support\Collection</code> 인스턴스를 반환하며, 각 결과는 PHP의 <code>stdClass</code> 객체의 인스턴스입니다. 각 컬럼의 값은 객체의 속성으로 접근하여 가져올 수 있습니다.

<syntaxhighlight lang='php'>
use Illuminate\Support\Facades\DB;
 
$users = DB::table('users')->get();
 
foreach ($users as $user) {
    echo $user->name;
}
</syntaxhighlight>

Laravel 컬렉션은 데이터를 매핑하고 축소하는 데 매우 강력한 다양한 메소드를 제공합니다. Laravel 콜렉션에 대한 자세한 내용은 콜렉션 문서를 참조하십시오.

;테이블에서 단일 행 / 컬럼 조회

데이터베이스 테이블에서 단일 행만 검색해야 하는 경우, <code>DB</code> 파사드의 <code>first</code> 메소드를 사용할 수 있습니다. 이 메소드는 단일 <code>stdClass</code> 객체를 반환합니다:

<syntaxhighlight lang='php'>
$user = DB::table('users')->where('name', 'John')->first();
 
return $user->email;
</syntaxhighlight>

전체 행이 필요하지 않다면, <code>value</code> 메소드를 사용하여 레코드에서 단일 값을 추출할 수 있습니다. 이 메소드는 해당 컬럼의 값을 직접 반환합니다:

<syntaxhighlight lang='php'>
$email = DB::table('users')->where('name', 'John')->value('email');
</syntaxhighlight>

<code>id</code> 컬럼 값을 기준으로 단일 행을 검색하려면, <code>find</code> 메소드를 사용하세요:

<syntaxhighlight lang='php'>
$user = DB::table('users')->find(3);
</syntaxhighlight>

;컬럼 값 목록 조회

단일 컬럼의 값을 포함하는 <code>Illuminate\Support\Collection</code> 인스턴스를 검색하려면 <code>pluck</code> 메소드를 사용할 수 있습니다. 이 예제에서는 사용자 타이틀의 콜렉션을 검색합니다:

<syntaxhighlight lang='php'>
use Illuminate\Support\Facades\DB;
 
$titles = DB::table('users')->pluck('title');
 
foreach ($titles as $title) {
    echo $title;
}
</syntaxhighlight>

결과 콜렉션이 사용할 키를 지정하려면 <code>pluck</code> 메서드의 두 번째 인수로 지정할 수 있습니다:

<syntaxhighlight lang='php'>
$titles = DB::table('users')->pluck('title', 'name');
 
foreach ($titles as $name => $title) {
    echo $title;
}
</syntaxhighlight>

===결과 청킹===
수천 개의 데이터베이스 레코드를 작업해야 하는 경우, <code>DB</code> 파사드에서 제공하는 <code>chunck</code> 메소드를 사용하는 것을 고려하십시오. 이 메소드는 한 번에 작은 청크의 결과를 가져와 각 청크를 처리할 클로저로 전달합니다. 예를 들어, 한 번에 100개의 레코드를 청크로 나누어 전체 사용자 테이블을 가져오는 방법은 다음과 같습니다:

<syntaxhighlight lang='php'>
use Illuminate\Support\Collection;
use Illuminate\Support\Facades\DB;
 
DB::table('users')->orderBy('id')->chunk(100, function (Collection $users) {
    foreach ($users as $user) {
        // ...
    }
});
</syntaxhighlight>

클로저에서 false를 반환하여 추가 청크 처리를 중단할 수 있습니다:

<syntaxhighlight lang='php'>
DB::table('users')->orderBy('id')->chunk(100, function (Collection $users) {
    // 레코드 처리...
 
    return false;
});
</syntaxhighlight>

결과를 청크로 나누는 동안 데이터베이스 레코드를 업데이트하는 경우, 청크 결과가 예기치 않게 변경될 수 있습니다. 청크로 나눈 후 검색된 레코드를 업데이트할 계획이라면, 항상 <code>chunkById</code> 메소드를 사용하는 것이 좋습니다. 이 메소드는 레코드의 기본키를 기준으로 자동으로 결과를 페이지로 나눕니다:

<syntaxhighlight lang='php'>
DB::table('users')->where('active', false)
    ->chunkById(100, function (Collection $users) {
        foreach ($users as $user) {
            DB::table('users')
                ->where('id', $user->id)
                ->update(['active' => true]);
        }
    });
</syntaxhighlight>

청크 콜백 내부에서 레코드를 업데이트하거나 삭제할 때, 기본키나 외래키에 대한 변경사항이 청크 쿼리에 영향을 줄 수 있습니다. 이로 인해 레코드가 청크 결과에 포함되지 않을 수 있습니다.

===게으른(lazy) 결과 스트리밍===
<code>lazy</code> 메소드는 <code>chunk</code> 메소드와 유사하게 쿼리를 청크 단위로 실행합니다. 그러나 각 청크를 콜백으로 전달하는 대신, <code>lazy()</code> 메소드는 <code>LazyCollection</code>을 반환하여 결과를 단일 스트림으로 처리할 수 있게 합니다:

<syntaxhighlight lang='php'>
use Illuminate\Support\Facades\DB;
 
DB::table('users')->orderBy('id')->lazy()->each(function (object $user) {
    // ...
});
</syntaxhighlight>

마찬가지로, 검색된 레코드를 반복하면서 업데이트하려는 경우 <code>lazyById</code> 또는 <code>lazyByIdDesc</code> 메소드를 사용하는 것이 좋습니다. 이 메서드들은 레코드의 기본키를 기준으로 결과를 자동으로 페이지화합니다:

<syntaxhighlight lang='php'>
DB::table('users')->where('active', false)
    ->lazyById()->each(function (object $user) {
        DB::table('users')
            ->where('id', $user->id)
            ->update(['active' => true]);
    });
</syntaxhighlight>

레코드를 반복하면서 업데이트하거나 삭제할 때, 기본 키 또는 외래 키에 대한 변경은 청크 쿼리에 영향을 미칠 수 있습니다. 이로 인해 레코드가 결과에 포함되지 않을 수 있습니다.

===집계===

==문 선택==
==원시 표현==
==조인==
==유니온==
==기본 Where 절==
===Where 절===
쿼리 빌더의 <code>where</code> 메소드를 사용하여 쿼리에 "where" 절을 추가할 수 있습니다. <code>where</code> 메소드의 가장 기본적인 호출에는 세 개의 인수가 필요합니다. 첫 번째 인수는 컬럼의 이름입니다. 두 번째 인수는 데이터베이스에서 지원하는 연산자 중 하나입니다. 세 번째 인수는 컬럼의 값과 비교할 값입니다.

예를 들어, 다음 쿼리는 <code>votes</code> 컬럼의 값이 <code>100</code>이고 <code>age</code> 컬럼의 값이 <code>35</code>보다 큰 사용자를 조회합니다:

<syntaxhighlight lang='php'>
$users = DB::table('users')
                ->where('votes', '=', 100)
                ->where('age', '>', 35)
                ->get();
</syntaxhighlight>

편의를 위해, 컬럼이 주어진 값과 같음(<code>=</code>)을 확인하려는 경우, 두 번째 인수로 값을 전달할 수 있습니다. Laravel은 <code>=</code> 연산자를 사용하려 한다고 가정합니다:

<syntaxhighlight lang='php'>
$users = DB::table('users')->where('votes', 100)->get();
</syntaxhighlight>

앞서 언급했듯이, 데이터베이스 시스템에서 지원하는 모든 연산자를 사용할 수 있습니다:

<syntaxhighlight lang='php'>
$users = DB::table('users')
                ->where('votes', '>=', 100)
                ->get();
 
$users = DB::table('users')
                ->where('votes', '<>', 100)
                ->get();
 
$users = DB::table('users')
                ->where('name', 'like', 'T%')
                ->get();
</syntaxhighlight>

또한 조건의 배열을 <code>where</code> 함수에 전달할 수도 있습니다. 배열의 각 요소는 일반적으로 <code>where</code> 메소드에 전달되는 세 개의 인수를 포함하는 배열이어야 합니다:

<syntaxhighlight lang='php'>
$users = DB::table('users')->where([
    ['status', '=', '1'],
    ['subscribed', '<>', '1'],
])->get();
</syntaxhighlight>

PDO는 컬럼 이름 바인딩을 지원하지 않습니다. 따라서 쿼리에서 참조되는 컬럼 이름을 사용자 입력에 의해 결정되도록 해서는 안 됩니다. 여기에는 "order by" 컬럼이 포함됩니다.

===Or Where 절===
Query Builder의 <code>where</code> 메소드를 연속으로 호출할 때, "where" 절들은 <code>and</code> 연산자로 결합됩니다. 그러나 <code>orWhere</code> 메소드를 사용하여 <code>or</code> 연산자로 절을 쿼리에 추가할 수 있습니다. <code>orWhere</code> 메소드는 <code>where</code> 메소드와 동일한 인수를 받습니다:

<syntaxhighlight lang='php'>
$users = DB::table('users')
                    ->where('votes', '>', 100)
                    ->orWhere('name', 'John')
                    ->get();
</syntaxhighlight>

괄호 안에 "or" 조건을 그룹화해야 하는 경우, <code>orWhere</code> 메소드의 첫 번째 인수로 클로저를 전달할 수 있습니다:

<syntaxhighlight lang='php'>
$users = DB::table('users')
            ->where('votes', '>', 100)
            ->orWhere(function (Builder $query) {
                $query->where('name', 'Abigail')
                      ->where('votes', '>', 50);
            })
            ->get();
</syntaxhighlight>

위의 예제는 다음 SQL을 생성합니다:

<syntaxhighlight lang='sql'>
select * from users where votes > 100 or (name = 'Abigail' and votes > 50)
</syntaxhighlight>

전역 스코프가 적용될 때 예기치 않은 동작을 방지하기 위해 항상 <code>orWhere</code> 호출을 그룹화해야 합니다.

===Where Not 절===
<code>whereNot</code>과 <code>orWhereNot</code> 메소드는 주어진 그룹의 쿼리 제약 조건을 부정하는 데 사용할 수 있습니다. 예를 들어, 다음 쿼리는 클리어런스 중이거나 가격이 10보다 적은 제품을 제외합니다:

<syntaxhighlight lang='php'>
$products = DB::table('products')
                ->whereNot(function (Builder $query) {
                    $query->where('clearance', true)
                          ->orWhere('price', '<', 10);
                })
                ->get();
</syntaxhighlight>

===Where Any / All 절===
===JSON Where 절===
Laravel은 JSON 컬럼 유형을 지원하는 데이터베이스에서 JSON 컬럼 유형을 쿼리하는 것을 지원합니다. 현재 MySQL 8.0+, PostgreSQL 12.0+, SQL Server 2017+, SQLite 3.39.0+ ([https://www.sqlite.org/json1.html JSON1 확장] 포함)이 이에 해당합니다. JSON 컬럼을 쿼리하려면 <code>-></code> 연산자를 사용하세요:

<syntaxhighlight lang='php'>
$users = DB::table('users')
                ->where('preferences->dining->meal', 'salad')
                ->get();
</syntaxhighlight>

JSON 배열을 쿼리하려면 <code>whereJsonContains</code>를 사용할 수 있습니다:

<syntaxhighlight lang='php'>
$users = DB::table('users')
                ->whereJsonContains('options->languages', 'en')
                ->get();
</syntaxhighlight>

MySQL 또는 PostgreSQL 데이터베이스를 사용하는 경우, <code>whereJsonContains</code> 메소드에 값을 배열로 전달할 수 있습니다:

<syntaxhighlight lang='php'>
$users = DB::table('users')
                ->whereJsonContains('options->languages', ['en', 'de'])
                ->get();
</syntaxhighlight>

JSON 배열의 길이를 기준으로 쿼리하려면 <code>whereJsonLength</code> 메소드를 사용할 수 있습니다:

<syntaxhighlight lang='php'>
$users = DB::table('users')
                ->whereJsonLength('options->languages', 0)
                ->get();
 
$users = DB::table('users')
                ->whereJsonLength('options->languages', '>', 1)
                ->get();
</syntaxhighlight>

===추가 Where 절===
;whereBetween / orWhereBetween
<code>whereBetween</code> 메소드는 컬럼의 값이 두 값 사이에 있는지 확인합니다:

<syntaxhighlight lang='php'>
$users = DB::table('users')
           ->whereBetween('votes', [1, 100])
           ->get();
</syntaxhighlight>

;whereNotBetween / orWhereNotBetween
<code>whereNotBetween</code> 메소드는 컬럼의 값이 두 값 사이에 있지 않은지 확인합니다:

<syntaxhighlight lang='php'>
$users = DB::table('users')
                    ->whereNotBetween('votes', [1, 100])
                    ->get();
</syntaxhighlight>

;whereBetweenColumns / whereNotBetweenColumns / orWhereBetweenColumns / orWhereNotBetweenColumns
<code>whereBetweenColumns</code> 메소드는 같은 테이블 행에 있는 두 컬럼 값 사이에 있는지 확인합니다:

<syntaxhighlight lang='php'>
$patients = DB::table('patients')
                       ->whereBetweenColumns('weight', ['minimum_allowed_weight', 'maximum_allowed_weight'])
                       ->get();
</syntaxhighlight>

<code>whereNotBetweenColumns</code> 메소드는 같은 테이블 행에 있는 두 컬럼 값 사이에 있지 않은지 확인합니다:

<syntaxhighlight lang='php'>
$patients = DB::table('patients')
                       ->whereNotBetweenColumns('weight', ['minimum_allowed_weight', 'maximum_allowed_weight'])
                       ->get();
</syntaxhighlight>

;whereIn / whereNotIn / orWhereIn / orWhereNotIn
<code>whereIn</code> 메소드는 주어진 컬럼의 값이 주어진 배열 내에 있는지 확인합니다:

<syntaxhighlight lang='php'>
$users = DB::table('users')
                    ->whereIn('id', [1, 2, 3])
                    ->get();
</syntaxhighlight>

<code>whereNotIn</code> 메소드는 주어진 컬럼의 값이 주어진 배열 내에 없는지 확인합니다:

<syntaxhighlight lang='php'>
$users = DB::table('users')
                    ->whereNotIn('id', [1, 2, 3])
                    ->get();
</syntaxhighlight>

<code>whereIn</code> 메소드의 두 번째 인자로 쿼리 객체를 제공할 수도 있습니다:

<syntaxhighlight lang='php'>
$activeUsers = DB::table('users')->select('id')->where('is_active', 1);
 
$users = DB::table('comments')
                    ->whereIn('user_id', $activeUsers)
                    ->get();
</syntaxhighlight>

위의 예는 다음 SQL을 생성합니다:

<syntaxhighlight lang='sql'>
select * from comments where user_id in (
    select id
    from users
    where is_active = 1
)
</syntaxhighlight>

{{WARNING}}
대량의 정수 바인딩을 쿼리에 추가하는 경우, <code>whereIntegerInRaw</code> 또는 <code>whereIntegerNotInRaw</code> 메소드를 사용하여 메모리 사용량을 크게 줄일 수 있습니다.
{{/WARNING}}

;whereNull / whereNotNull / orWhereNull / orWhereNotNull
<code>whereNull</code> 메소드는 주어진 컬럼의 값이 NULL인지 확인합니다:

<syntaxhighlight lang='php'>
$users = DB::table('users')
                ->whereNull('updated_at')
                ->get();
</syntaxhighlight>

<code>whereNotNull</code> 메소드는 주어진 컬럼의 값이 NULL이 아닌지 확인합니다:

<syntaxhighlight lang='php'>
$users = DB::table('users')
                ->whereNotNull('updated_at')
                ->get();
</syntaxhighlight>

;whereDate / whereMonth / whereDay / whereYear / whereTime
<code>whereDate</code> 메소드는 컬럼의 값을 특정 날짜와 비교하는 데 사용됩니다:

<syntaxhighlight lang='php'>
$users = DB::table('users')
                ->whereDate('created_at', '2016-12-31')
                ->get();
</syntaxhighlight>

<code>whereMonth</code> 메소드는 컬럼의 값을 특정 월과 비교하는 데 사용됩니다:

<syntaxhighlight lang='php'>
$users = DB::table('users')
                ->whereMonth('created_at', '12')
                ->get();
</syntaxhighlight>

<code>whereDay</code> 메소드는 컬럼의 값을 특정 일과 비교하는 데 사용됩니다:

<syntaxhighlight lang='php'>
$users = DB::table('users')
                ->whereDay('created_at', '31')
                ->get();
</syntaxhighlight>

<code>whereYear</code> 메소드는 컬럼의 값을 특정 연도와 비교하는 데 사용됩니다:

<syntaxhighlight lang='php'>
$users = DB::table('users')
                ->whereYear('created_at', '2016')
                ->get();
</syntaxhighlight>

<code>whereTime</code> 메소드는 컬럼의 값을 특정 시간과 비교하는 데 사용됩니다:

<syntaxhighlight lang='php'>
$users = DB::table('users')
                ->whereTime('created_at', '=', '11:20:45')
                ->get();
</syntaxhighlight>

;whereColumn / orWhereColumn
<code>whereColumn</code> 메소드는 두 컬럼이 같은지 확인하는 데 사용됩니다:

<syntaxhighlight lang='php'>
$users = DB::table('users')
                ->whereColumn('first_name', 'last_name')
                ->get();
</syntaxhighlight>

<code>whereColumn</code> 메소드에 비교 연산자를 전달할 수도 있습니다:

<syntaxhighlight lang='php'>
$users = DB::table('users')
                ->whereColumn('updated_at', '>', 'created_at')
                ->get();
</syntaxhighlight>

또한 <code>whereColumn</code> 메소드에 컬럼 비교 배열을 전달할 수도 있습니다. 이러한 조건은 <code>and</code> 연산자로 연결됩니다:

<syntaxhighlight lang='php'>
$users = DB::table('users')
                ->whereColumn([
                    ['first_name', '=', 'last_name'],
                    ['updated_at', '>', 'created_at'],
                ])->get();
</syntaxhighlight>

===논리적 그룹화===
쿼리의 원하는 논리적 그룹화를 달성하기 위해 여러 "where" 절을 괄호 안에 그룹화해야 할 때가 있습니다. 사실, 예상치 못한 쿼리 동작을 피하기 위해 <code>orWhere</code> 메소드 호출을 항상 괄호 안에 그룹화하는 것이 좋습니다. 이를 달성하기 위해, 클로저를 <code>where</code> 메소드에 전달할 수 있습니다:

<syntaxhighlight lang='php'>
$users = DB::table('users')
           ->where('name', '=', 'John')
           ->where(function (Builder $query) {
               $query->where('votes', '>', 100)
                     ->orWhere('title', '=', 'Admin');
           })
           ->get();
</syntaxhighlight>

보시다시피, 클로저를 <code>where</code> 메소드에 전달하면 쿼리 빌더가 제약조건 그룹을 시작하도록 지시합니다. 클로저는 쿼리 빌더 인스턴스를 받게 되며, 이 인스턴스를 사용하여 괄호 그룹에 포함되어야 하는 제약 조건을 설정할 수 있습니다. 위의 예제는 다음과 같은 SQL을 생성합니다:

<syntaxhighlight lang='sql'>
select * from users where name = 'John' and (votes > 100 or title = 'Admin')
</syntaxhighlight>

{{WARNING}}
글로벌 스코프가 적용될 때 예상치 못한 동작을 피하기 위해 항상 <code>orWhere</code> 호출을 그룹화해야 합니다.
{{/WARNING}}

==고급 Where 절==
===Where Exists 절===
<code>whereExists</code> 메소드는 "where exists" SQL 절을 작성할 수 있게 해줍니다. <code>whereExists</code> 메소드는 클로저를 인수로 받습니다. 이 클로저는 쿼리 빌더 인스턴스를 받게 되며, "exists" 절 내에 배치될 쿼리를 정의할 수 있게 합니다:

<syntaxhighlight lang='php'>
$users = DB::table('users')
           ->whereExists(function (Builder $query) {
               $query->select(DB::raw(1))
                     ->from('orders')
                     ->whereColumn('orders.user_id', 'users.id');
           })
           ->get();
</syntaxhighlight>

또는, 클로저 대신 쿼리 객체를 <code>whereExists</code> 메소드에 제공할 수도 있습니다:

<syntaxhighlight lang='php'>
$orders = DB::table('orders')
                ->select(DB::raw(1))
                ->whereColumn('orders.user_id', 'users.id');

$users = DB::table('users')
                    ->whereExists($orders)
                    ->get();
</syntaxhighlight>

위의 두 예제는 모두 다음 SQL을 생성합니다:

<syntaxhighlight lang='sql'>
select * from users
where exists (
    select 1
    from orders
    where orders.user_id = users.id
)
</syntaxhighlight>

===서브쿼리 Where 절===
===풀텍스트 Where 절===
==정렬, 그룹화, 리미트, 오프셋==
===정렬===
===그룹화===
===리미트, 오프셋===
==조건절==
==Insert 문==
===Upsert===
==Update 문==
===JSON 컬럼 업데이트===
===증가 및 감소===
==Delete 문==
==비관적 락==
==디버깅==
==참고==
* https://laravel.com/docs/11.x/queries

[[분류: Laravel 쿼리빌더]]