Laradoc

Appearance

資料庫：查詢產生器 (Query Builder) ​

簡介 ​

Laravel 的資料庫查詢產生器為建立及執行資料庫查詢提供了一個方便、流暢的介面。它可以用於執行應用程式中大部分的資料庫操作，並且能完美搭配所有 Laravel 支援的資料庫系統。

Laravel 查詢產生器使用 PDO 參數綁定來保護您的應用程式免受 SQL 注入 (SQL injection) 攻擊。您不需要針對傳遞給查詢產生器作為查詢綁定的字串進行清理或消毒。

⚠️ 警告

PDO 不支援綁定欄位名稱。因此，您絕不應該允許使用者輸入來決定查詢所參照的欄位名稱，包括 "order by" 欄位。

執行資料庫查詢 ​

從資料表中取得所有資料列 ​

您可以使用 DB Facade 提供的 table 方法來開始查詢。table 方法會為給定的資料表回傳一個流暢的查詢產生器實例，讓您可以在查詢上鏈結更多約束，最後使用 get 方法取得查詢結果：

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]);
    }
}

get 方法會回傳一個包含查詢結果的 Illuminate\Support\Collection 實例，其中每個結果都是 PHP stdClass 物件的實例。您可以透過存取物件的屬性來取得每個欄位的值：

php
use Illuminate\Support\Facades\DB;

$users = DB::table('users')->get();

foreach ($users as $user) {
    echo $user->name;
}

📌 備註

Laravel 集合 (Collections) 提供了多種功能強大的方法來對資料進行映射 (Mapping) 與化簡 (Reducing)。有關 Laravel 集合的更多資訊，請參閱 集合文件。

從資料表中取得單一資料列或欄位 ​

如果您只需要從資料表中取得單一資料列，可以使用 DB Facade 的 first 方法。此方法將回傳單個 stdClass 物件：

php
$user = DB::table('users')->where('name', 'John')->first();

return $user->email;

如果您想從資料表中取得單一資料列，但在找不到匹配的資料列時拋出 Illuminate\Database\RecordNotFoundException，可以使用 firstOrFail 方法。如果未擷取到 RecordNotFoundException，系統會自動向客戶端發送 404 HTTP 回應：

php
$user = DB::table('users')->where('name', 'John')->firstOrFail();

如果您不需要整行資料，可以使用 value 方法從紀錄中提取單個值。此方法將直接回傳該欄位的值：

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

要透過 id 欄位值取得單一資料列，請使用 find 方法：

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

取得欄位值清單 ​

如果您想取得包含單一欄位值的 Illuminate\Support\Collection 實例，可以使用 pluck 方法。在下面這個例子中，我們將取得使用者職稱的集合：

php
use Illuminate\Support\Facades\DB;

$titles = DB::table('users')->pluck('title');

foreach ($titles as $title) {
    echo $title;
}

您可以透過向 pluck 方法提供第二個參數，來指定結果集合應使用的鍵名 (Key)：

php
$titles = DB::table('users')->pluck('title', 'name');

foreach ($titles as $name => $title) {
    echo $title;
}

分塊結果 ​

如果您需要處理數千條資料庫紀錄，請考慮使用 DB Facade 提供的 chunk 方法。此方法一次檢索一小塊結果，並將每個分塊傳入閉包 (Closure) 進行處理。例如，讓我們以一次 100 條紀錄為單位，分塊檢索整個 users 資料表：

php
use Illuminate\Support\Collection;
use Illuminate\Support\Facades\DB;

DB::table('users')->orderBy('id')->chunk(100, function (Collection $users) {
    foreach ($users as $user) {
        // ...
    }
});

您可以從閉包中回傳 false 來停止處理後續的分塊：

php
DB::table('users')->orderBy('id')->chunk(100, function (Collection $users) {
    // Process the records...

    return false;
});

如果您在分塊處理結果時更新資料庫紀錄，則分塊結果可能會以意想不到的方式改變。如果您打算在分塊時更新檢索到的紀錄，最好改用 chunkById 方法。此方法會自動根據紀錄的主鍵 (Primary Key) 對結果進行分頁：

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]);
        }
    });

由於 chunkById 和 lazyById 方法會為正在執行的查詢添加自己的 "where" 條件，因此您通常應該在閉包內將自己的條件進行邏輯分組：

php
DB::table('users')->where(function ($query) {
    $query->where('credits', 1)->orWhere('credits', 2);
})->chunkById(100, function (Collection $users) {
    foreach ($users as $user) {
        DB::table('users')
            ->where('id', $user->id)
            ->update(['credits' => 3]);
    }
});

⚠️ 警告

在分塊回呼 (Callback) 內更新或刪除紀錄時，對主鍵或外鍵的任何更改都可能影響分塊查詢。這可能會導致某些紀錄未包含在分塊結果中。

延遲串流結果 ​

lazy 方法與分塊方法類似，它也是分塊執行查詢。然而，lazy() 方法並非將每個分塊傳入回呼，而是回傳一個 LazyCollection，讓您可以像處理單一串流一樣與結果進行互動：

php
use Illuminate\Support\Facades\DB;

DB::table('users')->orderBy('id')->lazy()->each(function (object $user) {
    // ...
});

同樣地，如果您打算在迭代時更新檢索到的紀錄，最好改用 lazyById 或 lazyByIdDesc 方法。這些方法會自動根據紀錄的主鍵對結果進行分頁：

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

⚠️ 警告

在迭代時更新或刪除紀錄時，對主鍵或外鍵的任何更改都可能影響分塊查詢。這可能會導致某些紀錄未包含在結果中。

聚合 ​

查詢產生器還提供了多種獲取聚合值的方法，例如 count、max、min、avg 和 sum。您可以在構建查詢後呼叫這些方法：

php
use Illuminate\Support\Facades\DB;

$users = DB::table('users')->count();

$price = DB::table('orders')->max('price');

當然，您可以將這些方法與其他子句結合使用，以精確調整聚合值的計算方式：

php
$price = DB::table('orders')
    ->where('finalized', 1)
    ->avg('price');

判斷紀錄是否存在 ​

除了使用 count 方法來判斷是否存在符合查詢約束的紀錄外，您還可以使用 exists 和 doesntExist 方法：

php
if (DB::table('orders')->where('finalized', 1)->exists()) {
    // ...
}

if (DB::table('orders')->where('finalized', 1)->doesntExist()) {
    // ...
}

Select 語句 ​

指定 Select 子句 ​

您不一定總是想從資料庫資料表中選取所有欄位。使用 select 方法，您可以為查詢指定自定義的「select」子句：

php
use Illuminate\Support\Facades\DB;

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

distinct 方法允許您強制查詢回傳不重複的結果：

php
$users = DB::table('users')->distinct()->get();

如果您已經有一個查詢產生器實例，且希望在其現有的 select 子句中增加一個欄位，您可以使用 addSelect 方法：

php
$query = DB::table('users')->select('name');

$users = $query->addSelect('age')->get();

原生表達式 (Raw Expressions) ​

有時您可能需要在查詢中插入一段任意字串。要建立原生字串表達式，您可以使用 DB Facade 提供的 raw 方法：

php
$users = DB::table('users')
    ->select(DB::raw('count(*) as user_count, status'))
    ->where('status', '<>', 1)
    ->groupBy('status')
    ->get();

⚠️ 警告

原生語句將以字串形式注入查詢中，因此您應該非常小心，以避免產生 SQL 插入攻擊 (SQL injection) 漏洞。

原生方法 ​

除了使用 DB::raw 方法外，您還可以使用以下方法將原生表達式插入查詢的各個部分。請記住，Laravel 無法保證任何使用原生表達式的查詢都能防止 SQL 插入攻擊漏洞。

selectRaw ​

selectRaw 方法可以用來取代 addSelect(DB::raw(/* ... */))。此方法接受一個選用的綁定陣列作為其第二個參數：

php
$orders = DB::table('orders')
    ->selectRaw('price * ? as price_with_tax', [1.0825])
    ->get();

whereRaw / orWhereRaw ​

whereRaw 與 orWhereRaw 方法可用於將原生的「where」子句注入您的查詢。這些方法接受一個選用的綁定陣列作為其第二個參數：

php
$orders = DB::table('orders')
    ->whereRaw('price > IF(state = "TX", ?, 100)', [200])
    ->get();

havingRaw / orHavingRaw ​

havingRaw 與 orHavingRaw 方法可用於提供原生字串作為「having」子句的值。這些方法接受一個選用的綁定陣列作為其第二個參數：

php
$orders = DB::table('orders')
    ->select('department', DB::raw('SUM(price) as total_sales'))
    ->groupBy('department')
    ->havingRaw('SUM(price) > ?', [2500])
    ->get();

orderByRaw ​

orderByRaw 方法可用於提供原生字串作為「order by」子句的值：

php
$orders = DB::table('orders')
    ->orderByRaw('updated_at - created_at DESC')
    ->get();

groupByRaw ​

groupByRaw 方法可用於提供原生字串作為 group by 子句的值：

php
$orders = DB::table('orders')
    ->select('city', 'state')
    ->groupByRaw('city, state')
    ->get();

連接 (Joins) ​

內部連接子句 ​

查詢產生器也可以用來在查詢中加入連接子句。要執行基本的「內部連接 (inner join)」，您可以在查詢產生器實例上使用 join 方法。傳遞給 join 方法的第一個參數是您需要連接的資料表名稱，而其餘參數則指定連接的欄位限制。您甚至可以在單個查詢中連接多個資料表：

php
use Illuminate\Support\Facades\DB;

$users = DB::table('users')
    ->join('contacts', 'users.id', '=', 'contacts.user_id')
    ->join('orders', 'users.id', '=', 'orders.user_id')
    ->select('users.*', 'contacts.phone', 'orders.price')
    ->get();

左連接 / 右連接子句 ​

如果您想執行「左連接 (left join)」或「右連接 (right join)」而非「內部連接」，請使用 leftJoin 或 rightJoin 方法。這些方法與 join 方法具有相同的定義：

php
$users = DB::table('users')
    ->leftJoin('posts', 'users.id', '=', 'posts.user_id')
    ->get();

$users = DB::table('users')
    ->rightJoin('posts', 'users.id', '=', 'posts.user_id')
    ->get();

交叉連接子句 ​

您可以使用 crossJoin 方法來執行「交叉連接 (cross join)」。交叉連接會在第一個資料表與連接的資料表之間產生笛卡兒積 (cartesian product)：

php
$sizes = DB::table('sizes')
    ->crossJoin('colors')
    ->get();

進階連接子句 ​

您也可以指定更進階的連接子句。首先，將一個閉包作為第二個參數傳遞給 join 方法。該閉包將接收一個 Illuminate\Database\Query\JoinClause 實例，這允許您在「join」子句上指定限制條件：

php
DB::table('users')
    ->join('contacts', function (JoinClause $join) {
        $join->on('users.id', '=', 'contacts.user_id')->orOn(/* ... */);
    })
    ->get();

如果您想在連接上使用「where」子句，您可以使用 JoinClause 實例提供的 where 與 orWhere 方法。這些方法會將欄位與值進行比較，而非比較兩個欄位：

php
DB::table('users')
    ->join('contacts', function (JoinClause $join) {
        $join->on('users.id', '=', 'contacts.user_id')
            ->where('contacts.user_id', '>', 5);
    })
    ->get();

子查詢連接 ​

您可以使用 joinSub、leftJoinSub 與 rightJoinSub 方法將查詢連接到子查詢。這些方法中的每一個都接受三個參數：子查詢、其資料表別名，以及定義相關欄位的閉包。在此範例中，我們將檢索使用者集合，其中每個使用者記錄還包含該使用者最近發布的部落格文章之 created_at 時間戳記：

php
$latestPosts = DB::table('posts')
    ->select('user_id', DB::raw('MAX(created_at) as last_post_created_at'))
    ->where('is_published', true)
    ->groupBy('user_id');

$users = DB::table('users')
    ->joinSub($latestPosts, 'latest_posts', function (JoinClause $join) {
        $join->on('users.id', '=', 'latest_posts.user_id');
    })->get();

側向連接 (Lateral Joins) ​

⚠️ 警告

側向連接目前由 PostgreSQL、MySQL >= 8.0.14 以及 SQL Server 支援。

您可以使用 joinLateral 與 leftJoinLateral 方法來對子查詢執行「側向連接 (lateral join)」。這些方法中的每一個都接受兩個參數：子查詢及其資料表別名。連接條件應在指定子查詢的 where 子句中指定。側向連接會針對每一列進行評估，並且可以引用子查詢之外的欄位。

在此範例中，我們將檢索使用者集合以及該使用者最近的三篇部落格文章。每個使用者在結果集中最多可以產生三列：分別對應於他們最近的三篇部落格文章。連接條件是在子查詢中使用 whereColumn 子句指定的，引用當前的使用者列：

php
$latestPosts = DB::table('posts')
    ->select('id as post_id', 'title as post_title', 'created_at as post_created_at')
    ->whereColumn('user_id', 'users.id')
    ->orderBy('created_at', 'desc')
    ->limit(3);

$users = DB::table('users')
    ->joinLateral($latestPosts, 'latest_posts')
    ->get();

聯合 (Unions) ​

查詢產生器還提供了一個方便的方法，可以將兩個或多個查詢「聯合 (Union)」在一起。例如，您可以建立一個初始查詢，並使用 union 方法將其與更多查詢進行聯合：

php
use Illuminate\Support\Facades\DB;

$first = DB::table('users')
    ->whereNull('first_name');

$users = DB::table('users')
    ->whereNull('last_name')
    ->union($first)
    ->get();

除了 union 方法外，查詢產生器還提供了一個 unionAll 方法。使用 unionAll 方法結合的查詢將不會移除重複的結果。unionAll 方法具有與 union 方法相同的方法簽章。

基本 Where 子句 ​

Where 子句 ​

您可以使用查詢產生器的 where 方法在查詢中加入「where」子句。最基本的 where 方法呼叫需要三個參數。第一個參數是欄位的名稱。第二個參數是運算子，可以是資料庫支援的任何運算子。第三個參數是要與該欄位值比較的值。

例如，以下查詢會檢索 votes 欄位的值等於 100 且 age 欄位的值大於 35 的使用者：

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

為了方便起見，如果您想驗證某個欄位是否「等於」(=) 給定值，您可以將該值作為 where 方法的第二個參數傳遞。Laravel 會假設您想使用 = 運算子：

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

您也可以向 where 方法提供一個結合陣列，以便快速針對多個欄位進行查詢：

php
$users = DB::table('users')->where([
    'first_name' => 'Jane',
    'last_name' => 'Doe',
])->get();

如前所述，您可以使用資料庫系統支援的任何運算子：

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();

您也可以將條件陣列傳遞給 where 函式。陣列的每個元素應該是一個包含通常傳遞給 where 方法的三個參數的陣列：

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

⚠️ 警告

PDO 不支援綁定欄位名稱。因此，您絕不應該允許使用者輸入來決定查詢所引用的欄位名稱，包括「order by」欄位。

⚠️ 警告

MySQL 和 MariaDB 在字串與數字比較時會自動將字串轉換為整數。在此過程中，非數字字串會被轉換為 0，這可能會導致意料之外的結果。例如，如果您的資料表中有一名為 secret 且值為 aaa 的欄位，而您執行 User::where('secret', 0)，則該資料列將會被回傳。為了避免這種情況，請確保在查詢中使用所有值之前，已將其轉換為適當的類型。

Or Where 子句 ​

當串接查詢產生器的 where 方法呼叫時，「where」子句將使用 and 運算子連接。但是，您可以使用 orWhere 方法，使用 or 運算子將子句加入到查詢中。orWhere 方法接受與 where 方法相同的參數：

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

如果您需要在括號內對「or」條件進行分組，可以將閉包作為第一個參數傳遞給 orWhere 方法：

php
use Illuminate\Database\Query\Builder; 

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

上面的範例將產生以下 SQL：

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

⚠️ 警告

您應該始終對 orWhere 呼叫進行分組，以避免在應用全域範圍 (Global Scopes) 時發生非預期的行為。

Where Not 子句 ​

whereNot 和 orWhereNot 方法可用於否定給定的一組查詢約束。例如，以下查詢排除了正在出清或價格小於 10 的產品：

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

Where Any / All / None 子句 ​

有時您可能需要將相同的查詢約束應用於多個欄位。例如，您可能想要檢索給定清單中任何欄位都 LIKE 給定值的所有紀錄。您可以使用 whereAny 方法來達成此目的：

php
$users = DB::table('users')
    ->where('active', true)
    ->whereAny([
        'name',
        'email',
        'phone',
    ], 'like', 'Example%')
    ->get();

上面的查詢將產生以下 SQL：

sql
SELECT *
FROM users
WHERE active = true AND (
    name LIKE 'Example%' OR
    email LIKE 'Example%' OR
    phone LIKE 'Example%'
)

同樣地，whereAll 方法可用於檢索所有給定欄位都符合給定約束的紀錄：

php
$posts = DB::table('posts')
    ->where('published', true)
    ->whereAll([
        'title',
        'content',
    ], 'like', '%Laravel%')
    ->get();

上面的查詢將產生以下 SQL：

sql
SELECT *
FROM posts
WHERE published = true AND (
    title LIKE '%Laravel%' AND
    content LIKE '%Laravel%'
)

whereNone 方法可用於檢索沒有任何給定欄位符合給定約束的紀錄：

php
$posts = DB::table('albums')
    ->where('published', true)
    ->whereNone([
        'title',
        'lyrics',
        'tags',
    ], 'like', '%explicit%')
    ->get();

上面的查詢將產生以下 SQL：

sql
SELECT *
FROM albums
WHERE published = true AND NOT (
    title LIKE '%explicit%' OR
    lyrics LIKE '%explicit%' OR
    tags LIKE '%explicit%'
)

JSON Where 子句 ​

Laravel 也支援在提供 JSON 欄位類型支援的資料庫上查詢 JSON 欄位類型。目前這包括 MariaDB 10.3+、MySQL 8.0+、PostgreSQL 12.0+、SQL Server 2017+ 以及 SQLite 3.39.0+。要查詢 JSON 欄位，請使用 -> 運算子：

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

$users = DB::table('users')
    ->whereIn('preferences->dining->meal', ['pasta', 'salad', 'sandwiches'])
    ->get();

您可以使用 whereJsonContains 和 whereJsonDoesntContain 方法來查詢 JSON 陣列：

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

$users = DB::table('users')
    ->whereJsonDoesntContain('options->languages', 'en')
    ->get();

如果您的應用程式使用 MariaDB、MySQL 或 PostgreSQL 資料庫，您可以將值陣列傳遞給 whereJsonContains 和 whereJsonDoesntContain 方法：

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

$users = DB::table('users')
    ->whereJsonDoesntContain('options->languages', ['en', 'de'])
    ->get();

此外，您可以使用 whereJsonContainsKey 或 whereJsonDoesntContainKey 方法來檢索包含或不包含某個 JSON 鍵的結果：

php
$users = DB::table('users')
    ->whereJsonContainsKey('preferences->dietary_requirements')
    ->get();

$users = DB::table('users')
    ->whereJsonDoesntContainKey('preferences->dietary_requirements')
    ->get();

最後，您可以使用 whereJsonLength 方法來依據 JSON 陣列的長度進行查詢：

php
$users = DB::table('users')
    ->whereJsonLength('options->languages', 0)
    ->get();

$users = DB::table('users')
    ->whereJsonLength('options->languages', '>', 1)
    ->get();

額外的 Where 子句 ​

whereLike / orWhereLike / whereNotLike / orWhereNotLike

whereLike 方法允許你在查詢中加入 "LIKE" 子句以進行模式比對。這些方法提供了一種與資料庫無關的方式來執行字串比對查詢，並能夠切換是否區分大小寫。預設情況下，字串比對是不區分大小寫的：

php
$users = DB::table('users')
    ->whereLike('name', '%John%')
    ->get();

你可以透過 caseSensitive 引數來啟用區分大小寫的搜尋：

php
$users = DB::table('users')
    ->whereLike('name', '%John%', caseSensitive: true)
    ->get();

orWhereLike 方法允許你加入一個帶有 LIKE 條件的 "or" 子句：

php
$users = DB::table('users')
    ->where('votes', '>', 100)
    ->orWhereLike('name', '%John%')
    ->get();

whereNotLike 方法允許你在查詢中加入 "NOT LIKE" 子句：

php
$users = DB::table('users')
    ->whereNotLike('name', '%John%')
    ->get();

同樣地，你可以使用 orWhereNotLike 來加入一個帶有 NOT LIKE 條件的 "or" 子句：

php
$users = DB::table('users')
    ->where('votes', '>', 100)
    ->orWhereNotLike('name', '%John%')
    ->get();

⚠️ 警告

whereLike 的區分大小寫搜尋選項目前在 SQL Server 上不受支援。

whereIn / whereNotIn / orWhereIn / orWhereNotIn

whereIn 方法驗證給定欄位的值是否包含在給定的陣列中：

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

whereNotIn 方法驗證給定欄位的值是否不包含在給定的陣列中：

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

你也可以提供一個查詢物件作為 whereIn 方法的第二個引數：

php
$activeUsers = DB::table('users')->select('id')->where('is_active', 1);

$users = DB::table('comments')
    ->whereIn('user_id', $activeUsers)
    ->get();

上述範例將產生以下 SQL：

sql
select * from comments where user_id in (
    select id
    from users
    where is_active = 1
)

⚠️ 警告

如果你在查詢中加入大量的整數綁定陣列，可以使用 whereIntegerInRaw 或 whereIntegerNotInRaw 方法來大幅減少記憶體使用量。

whereBetween / orWhereBetween

whereBetween 方法驗證欄位的值是否介於兩個值之間：

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

whereNotBetween / orWhereNotBetween

whereNotBetween 方法驗證欄位的值是否落在兩個值之外：

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

whereBetweenColumns / whereNotBetweenColumns / orWhereBetweenColumns / orWhereNotBetweenColumns

whereBetweenColumns 方法驗證欄位的值是否介於同一個資料表資料列中兩個欄位的值之間：

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

whereNotBetweenColumns 方法驗證欄位的值是否落在同一個資料表資料列中兩個欄位的值之外：

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

whereValueBetween / whereValueNotBetween / orWhereValueBetween / orWhereValueNotBetween

whereValueBetween 方法驗證給定的值是否介於同一個資料表資料列中兩個相同型別欄位的值之間：

php
$patients = DB::table('products')
    ->whereValueBetween(100, ['min_price', 'max_price'])
    ->get();

whereValueNotBetween 方法驗證一個值是否落在同一個資料表資料列中兩個欄位的值之外：

php
$patients = DB::table('products')
    ->whereValueNotBetween(100, ['min_price', 'max_price'])
    ->get();

whereNull / whereNotNull / orWhereNull / orWhereNotNull

whereNull 方法驗證給定欄位的值是否為 NULL：

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

whereNotNull 方法驗證欄位的值是否不為 NULL：

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

whereDate / whereMonth / whereDay / whereYear / whereTime

whereDate 方法可用於將欄位的值與日期進行比較：

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

whereMonth 方法可用於將欄位的值與特定月份進行比較：

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

whereDay 方法可用於將欄位的值與月份中的特定日期進行比較：

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

whereYear 方法可用於將欄位的值與特定年份進行比較：

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

whereTime 方法可用於將欄位的值與特定時間進行比較：

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

wherePast / whereFuture / whereToday / whereBeforeToday / whereAfterToday

wherePast 與 whereFuture 方法可用於判斷欄位的值是在過去還是未來：

php
$invoices = DB::table('invoices')
    ->wherePast('due_at')
    ->get();

$invoices = DB::table('invoices')
    ->whereFuture('due_at')
    ->get();

whereNowOrPast 與 whereNowOrFuture 方法可用於判斷欄位的值是在過去或未來，包含目前的日期與時間：

php
$invoices = DB::table('invoices')
    ->whereNowOrPast('due_at')
    ->get();

$invoices = DB::table('invoices')
    ->whereNowOrFuture('due_at')
    ->get();

whereToday、whereBeforeToday 以及 whereAfterToday 方法分別可用於判斷欄位的值是否為今天、今天之前或今天之後：

php
$invoices = DB::table('invoices')
    ->whereToday('due_at')
    ->get();

$invoices = DB::table('invoices')
    ->whereBeforeToday('due_at')
    ->get();

$invoices = DB::table('invoices')
    ->whereAfterToday('due_at')
    ->get();

同樣地，whereTodayOrBefore 與 whereTodayOrAfter 方法可用於判斷欄位的值是在今天之前或今天之後，包含今天的日期：

php
$invoices = DB::table('invoices')
    ->whereTodayOrBefore('due_at')
    ->get();

$invoices = DB::table('invoices')
    ->whereTodayOrAfter('due_at')
    ->get();

whereColumn / orWhereColumn

whereColumn 方法可用於驗證兩個欄位是否相等：

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

你也可以傳遞一個比較運算子給 whereColumn 方法：

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

你還可以傳遞一個欄位比較陣列給 whereColumn 方法。這些條件將使用 and 運算子串接：

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

邏輯分組 ​

有時候，您可能需要將多個「where」子句放在括號內分組，以實現查詢所需的邏輯分組。事實上，通常您應該始終將 orWhere 方法的呼叫放在括號中分組，以避免非預期的查詢行為。要實現這一點，您可以將一個閉包 (Closure) 傳遞給 where 方法：

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

如您所見，將閉包傳遞給 where 方法會指示查詢產生器開始一個約束分組。該閉包將接收一個查詢產生器實例，您可以使用它來設定應包含在括號群組中的約束。上述範例將產生以下 SQL：

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

⚠️ 警告

您應該始終對 orWhere 呼叫進行分組，以避免在套用全域範圍 (Global Scopes) 時發生非預期的行為。

進階 Where 子句 ​

Where Exists 子句 ​

whereExists 方法允許您撰寫 "where exists" SQL 子句。whereExists 方法接受一個閉包，該閉包將接收一個查詢產生器實例，讓您定義應放置在 "exists" 子句內部的查詢：

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

或者，您可以向 whereExists 方法提供一個查詢物件，而不是閉包：

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

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

上述兩個範例都將產生以下 SQL：

sql
select * from users
where exists (
    select 1
    from orders
    where orders.user_id = users.id
)

子查詢 Where 子句 ​

有時您可能需要構建一個 "where" 子句，將子查詢的結果與給定值進行比較。您可以透過向 where 方法傳遞一個閉包和一個值來實現此目的。例如，以下查詢將檢索所有擁有特定類型之近期「會員資格 (membership)」的使用者：

php
use App\Models\User;
use Illuminate\Database\Query\Builder;

$users = User::where(function (Builder $query) {
    $query->select('type')
        ->from('membership')
        ->whereColumn('membership.user_id', 'users.id')
        ->orderByDesc('membership.start_date')
        ->limit(1);
}, 'Pro')->get();

或者，您可能需要構建一個將欄位與子查詢結果進行比較的 "where" 子句。您可以透過向 where 方法傳遞欄位、運算子和閉包來實現此目的。例如，以下查詢將檢索所有金額低於平均值的收入紀錄：

php
use App\Models\Income;
use Illuminate\Database\Query\Builder;

$incomes = Income::where('amount', '<', function (Builder $query) {
    $query->selectRaw('avg(i.amount)')->from('incomes as i');
})->get();

全文檢索 Where 子句 ​

⚠️ 警告

全文檢索 where 子句目前由 MariaDB, MySQL 和 PostgreSQL 支援。

whereFullText 和 orWhereFullText 方法可用於為具有 全文索引 的欄位新增全文檢索 "where" 子句。Laravel 會將這些方法轉換為底層資料庫系統對應的 SQL。例如，在使用 MariaDB 或 MySQL 的應用程式中，將會產生 MATCH AGAINST 子句：

php
$users = DB::table('users')
    ->whereFullText('bio', 'web developer')
    ->get();

排序、分組、限制與偏移 ​

排序 ​

orderBy 方法 ​

orderBy 方法允許您按給定欄位對查詢結果進行排序。orderBy 方法接受的第一個參數應為您希望排序的欄位，而第二個參數則決定排序方向，可以為 asc 或 desc：

php
$users = DB::table('users')
    ->orderBy('name', 'desc')
    ->get();

要按多個欄位排序，您只需根據需要多次呼叫 orderBy 即可：

php
$users = DB::table('users')
    ->orderBy('name', 'desc')
    ->orderBy('email', 'asc')
    ->get();

排序方向是選填的，預設為升冪排序。如果您想按降冪排序，可以為 orderBy 方法指定第二個參數，或直接使用 orderByDesc：

php
$users = DB::table('users')
    ->orderByDesc('verified_at')
    ->get();

最後，使用 -> 運算子，可以根據 JSON 欄位內的值對結果進行排序：

php
$corporations = DB::table('corporations')
    ->where('country', 'US')
    ->orderBy('location->state')
    ->get();

latest 與 oldest 方法 ​

latest 和 oldest 方法讓您可以輕鬆地按日期對結果進行排序。預設情況下，結果將按資料表的 created_at 欄位進行排序。或者，您可以傳遞您希望排序的欄位名稱：

php
$user = DB::table('users')
    ->latest()
    ->first();

隨機排序 ​

inRandomOrder 方法可用於隨機排序查詢結果。例如，您可以使用此方法來獲取一位隨機使用者：

php
$randomUser = DB::table('users')
    ->inRandomOrder()
    ->first();

移除現有的排序 ​

reorder 方法會移除之前套用到查詢的所有 "order by" 子句：

php
$query = DB::table('users')->orderBy('name');

$unorderedUsers = $query->reorder()->get();

您可以在呼叫 reorder 方法時傳遞欄位與方向，以便移除所有現有的 "order by" 子句並為查詢套用全新的排序：

php
$query = DB::table('users')->orderBy('name');

$usersOrderedByEmail = $query->reorder('email', 'desc')->get();

為了方便起見，您可以使用 reorderDesc 方法以降冪方式重新排序查詢結果：

php
$query = DB::table('users')->orderBy('name');

$usersOrderedByEmail = $query->reorderDesc('email')->get();

分組 ​

groupBy 與 having 方法 ​

正如您所料，groupBy 和 having 方法可用於對查詢結果進行分組。having 方法的簽名 (Signature) 與 where 方法類似：

php
$users = DB::table('users')
    ->groupBy('account_id')
    ->having('account_id', '>', 100)
    ->get();

您可以使用 havingBetween 方法在給定範圍內過濾結果：

php
$report = DB::table('orders')
    ->selectRaw('count(id) as number_of_orders, customer_id')
    ->groupBy('customer_id')
    ->havingBetween('number_of_orders', [5, 15])
    ->get();

您可以向 groupBy 方法傳遞多個參數以按多個欄位進行分組：

php
$users = DB::table('users')
    ->groupBy('first_name', 'status')
    ->having('account_id', '>', 100)
    ->get();

要構建更進階的 having 語句，請參閱 havingRaw 方法。

限制與偏移 ​

您可以使用 limit 和 offset 方法來限制查詢回傳的結果數量，或在查詢中跳過給定數量的結果：

php
$users = DB::table('users')
    ->offset(10)
    ->limit(5)
    ->get();

條件子句 ​

有時你可能希望根據另一個條件將某些查詢子句應用到查詢中。例如，你可能只想在傳入的 HTTP 請求中存在給定的輸入值時才套用 where 語句。你可以使用 when 方法來實現這一點：

php
$role = $request->input('role');

$users = DB::table('users')
    ->when($role, function (Builder $query, string $role) {
        $query->where('role_id', $role);
    })
    ->get();

when 方法僅在第一個參數為 true 時才執行給定的閉包 (Closure)。如果第一個參數為 false，則不會執行該閉包。因此，在上面的範例中，只有當傳入的請求中存在 role 欄位且其值評估為 true 時，才會呼叫傳給 when 方法的閉包。

你可以將另一個閉包作為第三個參數傳遞給 when 方法。只有當第一個參數評估為 false 時，才會執行此閉包。為了說明如何使用此功能，我們將使用它來設定查詢的預設排序：

php
$sortByVotes = $request->boolean('sort_by_votes');

$users = DB::table('users')
    ->when($sortByVotes, function (Builder $query, bool $sortByVotes) {
        $query->orderBy('votes');
    }, function (Builder $query) {
        $query->orderBy('name');
    })
    ->get();

Insert 語句 ​

查詢產生器還提供了一個 insert 方法，可用於將記錄插入資料庫資料表中。insert 方法接受一個包含欄位名稱和值的陣列：

php
DB::table('users')->insert([
    'email' => '[email protected]',
    'votes' => 0
]);

你可以透過傳遞陣列的陣列一次插入多條記錄。每個陣列代表應該插入表中的一條記錄：

php
DB::table('users')->insert([
    ['email' => '[email protected]', 'votes' => 0],
    ['email' => '[email protected]', 'votes' => 0],
]);

insertOrIgnore 方法在將記錄插入資料庫時會忽略錯誤。使用此方法時，你應該意識到重複記錄的錯誤將被忽略，其他類型的錯誤也可能根據資料庫引擎而被忽略。例如，insertOrIgnore 將繞過 MySQL 的嚴格模式 (Strict Mode)：

php
DB::table('users')->insertOrIgnore([
    ['id' => 1, 'email' => '[email protected]'],
    ['id' => 2, 'email' => '[email protected]'],
]);

insertUsing 方法將向資料表中插入新記錄，同時使用子查詢來確定應插入的資料：

php
DB::table('pruned_users')->insertUsing([
    'id', 'name', 'email', 'email_verified_at'
], DB::table('users')->select(
    'id', 'name', 'email', 'email_verified_at'
)->where('updated_at', '<=', now()->minus(months: 1)));

自動遞增 ID ​

如果資料表具有自動遞增的 ID，請使用 insertGetId 方法插入記錄並取得該 ID：

php
$id = DB::table('users')->insertGetId(
    ['email' => '[email protected]', 'votes' => 0]
);

⚠️ 警告

使用 PostgreSQL 時，insertGetId 方法預期自動遞增欄位的名稱為 id。如果你想從不同的「序列 (Sequence)」中取得 ID，可以將欄位名稱作為第二個參數傳遞給 insertGetId 方法。

Upserts ​

upsert 方法將插入不存在的記錄，並使用你指定的全新值更新已存在的記錄。該方法的第一個參數包含要插入或更新的值，而第二個參數列出了唯一識別相關資料表中記錄的欄位。該方法的第三個也是最後一個參數是一個陣列，列出了如果資料庫中已存在匹配記錄時應更新的欄位：

php
DB::table('flights')->upsert(
    [
        ['departure' => 'Oakland', 'destination' => 'San Diego', 'price' => 99],
        ['departure' => 'Chicago', 'destination' => 'New York', 'price' => 150]
    ],
    ['departure', 'destination'],
    ['price']
);

在上面的範例中，Laravel 將嘗試插入兩條記錄。如果已經存在具有相同 departure 和 destination 欄位值的記錄，Laravel 將更新該記錄的 price 欄位。

⚠️ 警告

除了 SQL Server 之外，所有資料庫都要求 upsert 方法第二個參數中的欄位具有「主鍵 (Primary)」或「唯一 (Unique)」索引。此外，MariaDB 和 MySQL 資料庫驅動程式會忽略 upsert 方法的第二個參數，並始終使用資料表的「主鍵」和「唯一」索引來檢測現有記錄。

Update 語句 ​

除了向資料庫插入記錄外，查詢產生器還可以使用 update 方法更新現有記錄。與 insert 方法一樣，update 方法接受一個欄位和值配對的陣列，表示要更新的欄位。update 方法會回傳受影響的行數。你可以使用 where 子句來限制 update 查詢：

php
$affected = DB::table('users')
    ->where('id', 1)
    ->update(['votes' => 1]);

更新或插入 ​

有時你可能想要更新資料庫中的現有記錄，或者在沒有匹配記錄時建立它。在這種情況下，可以使用 updateOrInsert 方法。updateOrInsert 方法接受兩個參數：一個用於尋找記錄的條件陣列，以及一個表示要更新的欄位和值配對的陣列。

updateOrInsert 方法將嘗試使用第一個參數的欄位和值配對來定位匹配的資料庫記錄。如果記錄存在，它將使用第二個參數中的值進行更新。如果找不到記錄，則會插入一條新記錄，其中包含兩個參數合併後的屬性：

php
DB::table('users')
    ->updateOrInsert(
        ['email' => '[email protected]', 'name' => 'John'],
        ['votes' => '2']
    );

你可以向 updateOrInsert 方法提供一個閉包，以根據是否存在匹配記錄來客製化更新或插入到資料庫中的屬性：

php
DB::table('users')->updateOrInsert(
    ['user_id' => $user_id],
    fn ($exists) => $exists ? [
        'name' => $data['name'],
        'email' => $data['email'],
    ] : [
        'name' => $data['name'],
        'email' => $data['email'],
        'marketable' => true,
    ],
);

更新 JSON 欄位 ​

更新 JSON 欄位時，應使用 -> 語法來更新 JSON 物件中的相應鍵 (Key)。此操作在 MariaDB 10.3+、MySQL 5.7+ 和 PostgreSQL 9.5+ 上受支援：

php
$affected = DB::table('users')
    ->where('id', 1)
    ->update(['options->enabled' => true]);

遞增與遞減 ​

查詢產生器還提供了遞增或遞減給定欄位值的便捷方法。這兩個方法都至少接受一個參數：要修改的欄位。可以提供第二個參數來指定欄位應遞增或遞減的量：

php
DB::table('users')->increment('votes');

DB::table('users')->increment('votes', 5);

DB::table('users')->decrement('votes');

DB::table('users')->decrement('votes', 5);

如果需要，你還可以在遞增或遞減操作期間指定要更新的其他欄位：

php
DB::table('users')->increment('votes', 1, ['name' => 'John']);

此外，你可以使用 incrementEach 和 decrementEach 方法一次遞增或遞減多個欄位：

php
DB::table('users')->incrementEach([
    'votes' => 5,
    'balance' => 100,
]);

Delete 語句 ​

查詢產生器的 delete 方法可用於從資料表中刪除紀錄。delete 方法會回傳受影響的資料列數。您可以在呼叫 delete 方法之前加入 "where" 子句來限制 delete 語句：

php
$deleted = DB::table('users')->delete();

$deleted = DB::table('users')->where('votes', '>', 100)->delete();

悲觀鎖定 ​

查詢產生器還包含了一些函式，可以幫助您在執行 select 語句時實現「悲觀鎖定 (Pessimistic Locking)」。若要執行帶有「共享鎖 (Shared Lock)」的語句，您可以呼叫 sharedLock 方法。共享鎖會防止選定的資料列在您的交易被提交之前被修改：

php
DB::table('users')
    ->where('votes', '>', 100)
    ->sharedLock()
    ->get();

或者，您可以使用 lockForUpdate 方法。一個「for update」鎖會防止選定的紀錄被修改，或者被另一個共享鎖選取：

php
DB::table('users')
    ->where('votes', '>', 100)
    ->lockForUpdate()
    ->get();

雖然不是強制性的，但建議將悲觀鎖定包裝在 交易 (Transaction) 中。這可確保在整個操作完成之前，資料庫中檢索到的資料保持不變。如果發生失敗，交易將自動回滾 (Roll Back) 任何變更並釋放鎖定：

php
DB::transaction(function () {
    $sender = DB::table('users')
        ->lockForUpdate()
        ->find(1);

    $receiver = DB::table('users')
        ->lockForUpdate()
        ->find(2);

    if ($sender->balance < 100) {
        throw new RuntimeException('Balance too low.');
    }

    DB::table('users')
        ->where('id', $sender->id)
        ->update([
            'balance' => $sender->balance - 100
        ]);

    DB::table('users')
        ->where('id', $receiver->id)
        ->update([
            'balance' => $receiver->balance + 100
        ]);
});

可重用的查詢組件 ​

如果您在整個應用程式中有重複的查詢邏輯，您可以使用查詢產生器的 tap 與 pipe 方法將邏輯提取到可重用的物件中。想像一下，您的應用程式中有這兩個不同的查詢：

php
use Illuminate\Database\Query\Builder;
use Illuminate\Support\Facades\DB;

$destination = $request->query('destination');

DB::table('flights')
    ->when($destination, function (Builder $query, string $destination) {
        $query->where('destination', $destination);
    })
    ->orderByDesc('price')
    ->get();

// ...

$destination = $request->query('destination');

DB::table('flights')
    ->when($destination, function (Builder $query, string $destination) {
        $query->where('destination', $destination);
    })
    ->where('user', $request->user()->id)
    ->orderBy('destination')
    ->get();

您可能想將查詢之間共同的目的地過濾邏輯提取到一個可重用的物件中：

php
<?php

namespace App\Scopes;

use Illuminate\Database\Query\Builder;

class DestinationFilter
{
    public function __construct(
        private ?string $destination,
    ) {
        //
    }

    public function __invoke(Builder $query): void
    {
        $query->when($this->destination, function (Builder $query) {
            $query->where('destination', $this->destination);
        });
    }
}

然後，您可以使用查詢產生器的 tap 方法將該物件的邏輯應用於查詢：

php
use App\Scopes\DestinationFilter;
use Illuminate\Database\Query\Builder;
use Illuminate\Support\Facades\DB;

DB::table('flights')
    ->when($destination, function (Builder $query, string $destination) { 
        $query->where('destination', $destination); 
    }) 
    ->tap(new DestinationFilter($destination)) 
    ->orderByDesc('price')
    ->get();

// ...

DB::table('flights')
    ->when($destination, function (Builder $query, string $destination) { 
        $query->where('destination', $destination); 
    }) 
    ->tap(new DestinationFilter($destination)) 
    ->where('user', $request->user()->id)
    ->orderBy('destination')
    ->get();

查詢管道 (Query Pipes) ​

tap 方法總是會回傳查詢產生器實例。如果您想要提取一個會執行查詢並回傳另一個值的物件，則可以使用 pipe 方法。

考慮以下包含在整個應用程式中使用的共享 分頁 (Pagination) 邏輯的查詢物件。與將查詢條件應用於查詢的 DestinationFilter 不同，Paginate 物件會執行查詢並回傳一個分頁器實例：

php
<?php

namespace App\Scopes;

use Illuminate\Contracts\Pagination\LengthAwarePaginator;
use Illuminate\Database\Query\Builder;

class Paginate
{
    public function __construct(
        private string $sortBy = 'timestamp',
        private string $sortDirection = 'desc',
        private int $perPage = 25,
    ) {
        //
    }

    public function __invoke(Builder $query): LengthAwarePaginator
    {
        return $query->orderBy($this->sortBy, $this->sortDirection)
            ->paginate($this->perPage, pageName: 'p');
    }
}

使用查詢產生器的 pipe 方法，我們可以利用這個物件來應用我們的共享分頁邏輯：

php
$flights = DB::table('flights')
    ->tap(new DestinationFilter($destination))
    ->pipe(new Paginate);

除錯 ​

在建構查詢時，您可以使用 dd 與 dump 方法來傾印目前的查詢綁定與 SQL。dd 方法將顯示除錯資訊並停止執行請求。dump 方法將顯示除錯資訊，但允許請求繼續執行：

php
DB::table('users')->where('votes', '>', 100)->dd();

DB::table('users')->where('votes', '>', 100)->dump();

可以在查詢上呼叫 dumpRawSql 與 ddRawSql 方法，以傾印正確替換了所有參數綁定的查詢 SQL：

php
DB::table('users')->where('votes', '>', 100)->dumpRawSql();

DB::table('users')->where('votes', '>', 100)->ddRawSql();