資料庫：查詢產生器

簡介
執行資料庫查詢
選取敘述
原始表達式
連接
聯集
基本的 Where 子句
進階 Where 子句
排序、分組、限制和偏移
條件子句
插入敘述
- 更新插入
更新敘述
- 更新 JSON 欄位
- 增加和減少
刪除敘述
悲觀鎖定
除錯

簡介

Laravel 的資料庫查詢產生器提供了一個方便、流暢的介面來創建和執行資料庫查詢。它可用於在應用程式中執行大多數資料庫操作，並與 Laravel 支援的所有資料庫系統完美配合。

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

Warning

PDO 不支援綁定欄位名稱。因此，您永遠不應該允許使用者輸入來指示查詢引用的欄位名稱，包括 "order by" 欄位。

執行資料庫查詢

檢索表中的所有列

您可以使用DB Facade提供的table方法開始查詢。table方法會為給定的表返回一個流暢的查詢生成器實例，讓您可以將更多約束鏈接到查詢中，最後使用get方法檢索查詢的結果：

<?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物件的實例。您可以通過將列視為對象的屬性來訪問每個列的值：

use Illuminate\Support\Facades\DB;

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

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

Note

Laravel集合提供了各種非常強大的方法來映射和減少數據。有關Laravel集合的更多信息，請查看集合文檔。

從表中檢索單行/列

如果您只需要從數據庫表中檢索單行，可以使用DB Facade的first方法。此方法將返回單個stdClass對象：

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

return $user->email;

如果您想要從數據庫表中檢索單行，但如果找不到匹配的行則拋出Illuminate\Database\RecordNotFoundException，可以使用firstOrFail方法。如果未捕獲到RecordNotFoundException，則自動向客戶端發送404 HTTP響應：

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

如果您不需要整行，可以使用value方法從記錄中提取單個值。此方法將直接返回列的值：

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

要通過其id列值檢索單行，請使用find方法：

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

檢索列值清單

如果您想要檢索包含單個列值的 Illuminate\Support\Collection 實例，您可以使用 pluck 方法。在這個例子中，我們將檢索一個包含使用者標題的集合：

use Illuminate\Support\Facades\DB;

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

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

您可以通過向 pluck 方法提供第二個引數來指定結果集應使用作為其鍵的列：

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

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

分塊結果

如果您需要處理數千條資料庫記錄，請考慮使用 DB 門面提供的 chunk 方法。此方法一次檢索一小塊結果並將每個結果塊傳遞到一個閉包進行處理。例如，讓我們一次以 100 條記錄的方式檢索整個 users 表：

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

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

您可以通過從閉包中返回 false 來停止進一步處理結果塊：

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

    return false;
});

如果您在分塊結果時更新資料庫記錄，您的分塊結果可能以意外的方式更改。如果您計劃在分塊時更新檢索的記錄，最好始終使用 chunkById 方法。此方法將根據記錄的主鍵自動對結果進行分頁：

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" 條件添加到正在執行的查詢中，因此您應該通常在閉包中邏輯分組您自己的條件：

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

Warning

在分塊回調中更新或刪除記錄時，主鍵或外鍵的更改可能會影響分塊查詢。這可能導致記錄未包含在分塊結果中。

懶惰地流式傳輸結果

lazy 方法與 chunk 方法類似，它以分塊的方式執行查詢。但是，與將每個結果塊傳遞給回調不同，lazy() 方法返回一個 LazyCollection，讓您將結果視為單個流進行交互：

use Illuminate\Support\Facades\DB;

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

再次提醒，如果您計劃在迭代過程中更新檢索到的記錄，最好使用 lazyById 或 lazyByIdDesc 方法。這些方法將根據記錄的主鍵自動分頁結果：

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

Warning

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

聚合

查詢生成器還提供了各種方法來檢索像 count、max、min、avg 和 sum 這樣的聚合值。您可以在構建查詢後調用這些方法之一：

use Illuminate\Support\Facades\DB;

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

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

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

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

確定記錄是否存在

您可以使用 exists 和 doesntExist 方法來確定是否存在與查詢約束條件匹配的記錄，而不是使用 count 方法：

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

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

選擇語句

指定選擇子句

您可能並非總是想要從數據庫表中選擇所有列。使用 select 方法，您可以為查詢指定自定義的「選擇」子句：

use Illuminate\Support\Facades\DB;

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

distinct 方法允許您強制查詢返回不同的結果：

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

如果您已經有一個查詢生成器實例，並且希望將列添加到其現有的選擇子句中，您可以使用 addSelect 方法：

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

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

原始表達式

有時候，您可能需要將任意字符串插入查詢中。要創建原始字符串表達式，您可以使用DB Facade提供的raw方法：

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

Warning

原始語句將被注入查詢作為字符串，因此您應該非常小心，以避免創建SQL注入漏洞。

原始方法

除了使用DB::raw方法之外，您還可以使用以下方法將原始表達式插入到查詢的各個部分。請記住，Laravel無法保證使用原始表達式的任何查詢都受到SQL注入漏洞的保護。

`selectRaw`

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

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

`whereRaw / orWhereRaw`

whereRaw和orWhereRaw方法可用於將原始“where”子句注入到查詢中。這些方法接受一個可選的綁定數組作為其第二個參數：

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

`havingRaw / orHavingRaw`

havingRaw和orHavingRaw方法可用於將原始字符串作為“having”子句的值。這些方法接受一個可選的綁定數組作為其第二個參數：

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

`orderByRaw`

orderByRaw方法可用於將原始字符串作為“order by”子句的值：

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

`groupByRaw`

groupByRaw方法可用於將原始字符串作為group by子句的值：

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

連接

內部連接子句

查詢建構器也可用於將連接子句添加到您的查詢中。要執行基本的「內部連接」，您可以在查詢建構器實例上使用 join 方法。傳遞給 join 方法的第一個引數是您需要連接的表的名稱，而其餘引數指定了連接的列約束。您甚至可以在單個查詢中連接多個表：

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

左連接 / 右連接子句

如果您想要執行「左連接」或「右連接」而不是「內部連接」，請使用 leftJoin 或 rightJoin 方法。這些方法與 join 方法具有相同的簽名：

$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 方法執行「交叉連接」。交叉連接在第一個表和連接表之間生成笛卡爾積：

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

進階連接子句

您還可以指定更複雜的連接子句。要開始，將閉包作為 join 方法的第二個引數。閉包將接收一個 Illuminate\Database\Query\JoinClause 實例，允許您在「連接」子句上指定約束：

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

如果您想要在連接上使用「where」子句，您可以使用 JoinClause 實例提供的 where 和 orWhere 方法。這些方法將比較列與值而不是比較兩個列：

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 時間戳記：

$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

Warning

Lateral joins are currently supported by PostgreSQL, MySQL >= 8.0.14, and SQL Server.

您可以使用 joinLateral 和 leftJoinLateral 方法來執行帶有子查詢的 "lateral join"。這兩個方法都接受兩個引數：子查詢和其表別名。加入條件應該在給定子查詢的 where 子句中指定。Lateral joins 對每一行進行評估，並且可以引用子查詢之外的列。

在這個例子中，我們將檢索一個使用者集合以及使用者的三篇最近的部落格文章。每個使用者可以在結果集中產生最多三行：每個使用者的最近部落格文章之一。加入條件在子查詢中的 whereColumn 子句中指定，引用當前使用者行：

$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 方法將其與更多查詢聯合起來：

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 的使用者：

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

為了方便起見，如果您想要驗證一個列是否等於給定的值，您可以將該值作為第二個引數傳遞給 where 方法。Laravel 將假定您想使用 = 運算子：

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

如前所述，您可以使用數據庫系統支持的任何運算子：

$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 方法的三個引數的陣列：

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

Warning

PDO 不支持綁定列名。因此，您不應該讓用戶輸入來指示查詢引用的列名，包括 "order by" 列。

Warning

MySQL 和 MariaDB 在字符串數字比較中自動將字符串類型轉換為整數。在此過程中，非數字字符串被轉換為 0，這可能導致意外結果。例如，如果您的表具有值為 aaa 的 secret 列，並運行 User::where('secret', 0)，將返回該行。為了避免這種情況，請確保在查詢中使用值之前將所有值轉換為適當的類型。

或者條件

當將查詢生成器的 where 方法的調用連鎖在一起時，"where" 條件將使用 and 運算子連接在一起。但是，您可以使用 orWhere 方法使用 or 運算子將一個條件加入到查詢中。orWhere 方法接受與 where 方法相同的引數：

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

如果您需要在括號內分組 "or" 條件，您可以將閉包作為 orWhere 方法的第一個引數傳遞：

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

上面的示例將生成以下 SQL：

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

Warning

您應該始終對 orWhere 調用進行分組，以避免應用全局範圍時出現意外行為。

不在條件

whereNot 和 orWhereNot 方法可用於否定給定的查詢約束組。例如，以下查詢排除了清倉產品或價格低於十元的產品：

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

任何 / 全部 / 無一條件

有時您可能需要將相同的查詢約束應用於多個列。例如，您可能希望檢索所有記錄，其中給定列表中的任何列都LIKE給定值。您可以使用 whereAny 方法來實現此目的：

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

上面的查詢將導致以下 SQL：

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

同樣，whereAll 方法可用於檢索所有給定列與給定約束匹配的記錄：

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

上面的查詢將導致以下 SQL：

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

whereNone 方法可用於檢索所有給定列都不匹配給定約束的記錄：

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

上面的查詢將導致以下 SQL：

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

JSON 條件

Laravel 也支持在提供 JSON 列類型支持的數據庫上查詢 JSON 列類型。目前，這包括 MariaDB 10.3+、MySQL 8.0+、PostgreSQL 12.0+、SQL Server 2017+ 和 SQLite 3.39.0+。要查詢 JSON 列，請使用 -> 運算符：

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

您可以使用 whereJsonContains 來查詢 JSON 陣列：

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

如果您的應用程序使用 MariaDB、MySQL 或 PostgreSQL 數據庫，您可以將值陣列傳遞給 whereJsonContains 方法：

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

您可以使用 whereJsonLength 方法來按其長度查詢 JSON 陣列：

$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" 條件添加到查詢中以進行模式匹配。這些方法提供了一種與數據庫無關的方式來執行字符串匹配查詢，並具有切換區分大小寫的能力。默認情況下，字符串匹配是不區分大小寫的：

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

您可以通過 caseSensitive 參數啟用區分大小寫搜索：

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

orWhereLike 方法允許您添加帶有 LIKE 條件的 "or" 條件：

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

whereNotLike 方法允許您向查詢中添加 "NOT LIKE" 條件：

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

同樣地，您可以使用 orWhereNotLike 來添加帶有 NOT LIKE 條件的 "or" 條件：

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

Warning

目前不支持在 SQL Server 上使用 whereLike 區分大小寫搜索選項。

whereIn / whereNotIn / orWhereIn / orWhereNotIn

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

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

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

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

您還可以將查詢對象作為 whereIn 方法的第二個參數：

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

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

上面的示例將生成以下 SQL：

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

Warning

如果您將大量整數綁定添加到查詢中，則可以使用 whereIntegerInRaw 或 whereIntegerNotInRaw 方法來大大減少內存使用量。

whereBetween / orWhereBetween

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

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

whereNotBetween / orWhereNotBetween

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

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

whereBetweenColumns / whereNotBetweenColumns / orWhereBetweenColumns / orWhereNotBetweenColumns

whereBetweenColumns 方法驗證一個欄位的值是否在同一表格行中兩個欄位的值之間：

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

whereNotBetweenColumns 方法驗證一個欄位的值是否在同一表格行中兩個欄位的值之外：

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

whereNull / whereNotNull / orWhereNull / orWhereNotNull

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

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

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

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

whereDate / whereMonth / whereDay / whereYear / whereTime

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

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

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

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

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

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

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

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

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

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

wherePast / whereFuture / whereToday / whereBeforeToday / whereAfterToday

wherePast 和 whereFuture 方法可用於確定列的值是否在過去或未來：

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

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

whereNowOrPast 和 whereNowOrFuture 方法可用於確定列的值是否在過去或未來，包括當前日期和時間：

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

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

whereToday、whereBeforeToday 和 whereAfterToday 方法可用於確定列的值是否為今天、在今天之前或在今天之後：

$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 方法可用於確定列的值是否在今天之前或在今天之後，包括今天的日期：

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

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

whereColumn / orWhereColumn

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

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

您也可以向 whereColumn 方法傳遞比較運算符：

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

您也可以向 whereColumn 方法傳遞一個列比較的陣列。這些條件將使用 and 運算符連接：

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

邏輯分組

有時您可能需要在括號內將幾個 "where" 子句分組，以達到查詢所需的邏輯分組。事實上，您通常應該始終將對 orWhere 方法的調用分組在括號內，以避免意外的查詢行為。為此，您可以向 where 方法傳遞一個閉包：

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

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

Warning

應始終將 orWhere 調用分組，以避免應用全域範圍時出現意外行為。

進階 Where 條件

Where 存在條件

whereExists 方法允許您編寫 "where exists" SQL 條件。whereExists 方法接受一個閉包，該閉包將接收一個查詢建構器實例，讓您可以定義應放在 "exists" 子句內的查詢：

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

或者，您可以將查詢對象提供給 whereExists 方法，而不是一個閉包：

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

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

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

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

子查詢 Where 條件

有時您可能需要構建一個將子查詢結果與給定值進行比較的 "where" 條件。您可以通過將閉包和值傳遞給 where 方法來實現這一點。例如，以下查詢將檢索所有最近具有特定類型 "會員資格" 的使用者：

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 方法來實現這一點。例如，以下查詢將檢索所有收入記錄，其中金額小於平均值：

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 條件

Warning

目前 MariaDB、MySQL 和 PostgreSQL 支持全文 where 條件。

whereFullText 和 orWhereFullText 方法可用於為具有全文索引的列添加全文"where"子句，這些方法將被 Laravel 轉換為底層資料庫系統的適當 SQL。例如，對於使用 MariaDB 或 MySQL 的應用程式，將生成 MATCH AGAINST 子句：

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

排序、分組、限制和偏移

排序

`orderBy` 方法

orderBy 方法允許您按照給定的列對查詢結果進行排序。orderBy 方法接受的第一個引數應該是您希望按其排序的列，而第二個引數確定排序的方向，可以是 asc 或 desc：

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

要按多個列排序，您可以根據需要多次調用 orderBy：

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

`latest` 和 `oldest` 方法

latest 和 oldest 方法允許您輕鬆按日期排序結果。默認情況下，結果將按表的 created_at 列排序。或者，您可以傳遞您希望按其排序的列名：

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

隨機排序

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

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

移除現有排序

reorder 方法將刪除先前應用於查詢的所有"order by"子句：

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

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

您可以在調用 reorder 方法時傳遞列和方向，以便刪除所有現有的 "order by" 子句並對查詢應用全新的排序：

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

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

分組

`groupBy` 和 `having` 方法

正如您所期望的那樣，groupBy 和 having 方法可用於對查詢結果進行分組。having 方法的簽名與 where 方法類似：

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

您可以使用 havingBetween 方法來在給定範圍內篩選結果：

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

您可以將多個引數傳遞給 groupBy 方法以按多個列進行分組：

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

要構建更高級的 having 陳述，請參見 havingRaw 方法。

限制和偏移

`skip` 和 `take` 方法

您可以使用 skip 和 take 方法來限制從查詢返回的結果數量，或者跳過查詢中給定數量的結果：

$users = DB::table('users')->skip(10)->take(5)->get();

或者，您可以使用 limit 和 offset 方法。這些方法在功能上等同於 take 和 skip 方法，分別：

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

條件子句

有時，您可能希望某些查詢子句基於另一個條件應用於查詢。例如，您可能只想在傳入的 HTTP 請求中存在特定輸入值時應用 where 陳述。您可以使用 when 方法來實現這一點：

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

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

當第一個引數為 true 時，when 方法僅執行給定的閉包。如果第一個引數為 false，則不會執行閉包。因此，在上面的示例中，只有在傳入請求中存在 role 字段且評估為 true 時，才會調用傳遞給 when 方法的閉包。

您可以將另一個閉包作為 when 方法的第三個引數傳遞。只有在第一個引數評估為 false 時，此閉包才會執行。為了說明如何使用這個功能，我們將用它來配置查詢的默認排序：

$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 方法接受一個包含列名和值的陣列：

DB::table('users')->insert([
    'email' => 'kayla@example.com',
    'votes' => 0
]);

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

DB::table('users')->insert([
    ['email' => 'picard@example.com', 'votes' => 0],
    ['email' => 'janeway@example.com', 'votes' => 0],
]);

insertOrIgnore 方法將忽略插入資料庫中的錯誤。使用此方法時，您應該注意，重複記錄錯誤將被忽略，並且根據資料庫引擎的不同，其他類型的錯誤也可能被忽略。例如，insertOrIgnore 將繞過 MySQL 的嚴格模式：

DB::table('users')->insertOrIgnore([
    ['id' => 1, 'email' => 'sisko@example.com'],
    ['id' => 2, 'email' => 'archer@example.com'],
]);

insertUsing 方法將使用子查詢插入新記錄到表中，以確定應該插入的數據：

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

自動增量 ID

如果表具有自動增量 ID，請使用 insertGetId 方法插入一條記錄，然後檢索 ID：

$id = DB::table('users')->insertGetId(
    ['email' => 'john@example.com', 'votes' => 0]
);

Warning

在使用 PostgreSQL 時，insertGetId 方法期望自動增量列的名稱為 id。如果您想從不同的 "序列" 中檢索 ID，您可以將列名作為第二個引數傳遞給 insertGetId 方法。

Upserts

upsert 方法將插入不存在的記錄，並更新已存在的記錄為您指定的新值。該方法的第一個引數包含要插入或更新的值，第二個引數列出唯一標識相關表中記錄的列，第三個和最後一個引數是應更新的列的陣列，如果數據庫中已存在匹配的記錄。

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 列。

Warning

除 SQL Server 外的所有數據庫都要求 upsert 方法的第二個參數中的列具有“主”或“唯一”索引。此外，MariaDB 和 MySQL 數據庫驅動程序將忽略 upsert 方法的第二個參數，並始終使用表的“主”和“唯一”索引來檢測現有記錄。

更新語句

除了將記錄插入數據庫外，查詢構建器還可以使用 update 方法更新現有記錄。update 方法與 insert 方法類似，接受一個列和值對的數組，指示要更新的列。update 方法返回受影響的行數。您可以使用 where 條件來約束 update 查詢：

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

更新或插入

有時您可能希望更新數據庫中的現有記錄，如果沒有匹配的記錄存在則創建它。在這種情況下，可以使用 updateOrInsert 方法。updateOrInsert 方法接受兩個參數：一個條件數組，用於查找記錄，以及一個列和值對的數組，指示要更新的列。

updateOrInsert 方法將嘗試使用第一個參數的列和值對來定位匹配的數據庫記錄。如果記錄存在，將使用第二個參數中的值對更新它。如果找不到記錄，將使用兩個參數的合併屬性插入新記錄：

DB::table('users')
    ->updateOrInsert(
        ['email' => 'john@example.com', 'name' => 'John'],
        ['votes' => '2']
    );

您可以向 updateOrInsert 方法提供一個閉包，以根據匹配記錄的存在來自定義要更新或插入數據庫的屬性。

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 物件中的適當鍵。此操作支援 MariaDB 10.3+、MySQL 5.7+ 和 PostgreSQL 9.5+：

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

增加和減少

查詢建構器還提供了方便的方法來增加或減少給定列的值。這兩種方法都至少接受一個引數：要修改的列。可以提供第二個引數來指定應增加或減少列的數量：

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

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

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

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

如果需要，您也可以在增加或減少操作期間指定要更新的其他列：

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

此外，您可以使用 incrementEach 和 decrementEach 方法一次增加或減少多個列：

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

刪除語句

查詢建構器的 delete 方法可用於從表中刪除記錄。delete 方法將返回受影響的行數。您可以通過在調用 delete 方法之前添加 "where" 子句來限制 delete 語句：

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

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

悲觀鎖定

查詢建構器還包括一些功能，可幫助您在執行 select 語句時實現 "悲觀鎖定"。要使用 "共享鎖定" 執行語句，可以調用 sharedLock 方法。共享鎖定可防止選定的行在您的交易提交之前被修改：

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

或者，您可以使用 lockForUpdate 方法。"用於更新" 鎖定可防止選定的記錄被修改，或者被另一個共享鎖定選擇：

雖然不是必須的，建議在交易內部使用悲觀鎖。這確保了在整個操作完成之前，從數據庫檢索的數據保持不變。如果操作失敗，交易將回滾任何更改並自動釋放鎖定：

調試

在構建查詢時，您可以使用 dd 和 dump 方法來轉儲當前查詢的綁定和 SQL。dd 方法將顯示調試信息，然後停止執行請求。dump 方法將顯示調試信息，但允許請求繼續執行：

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

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

可以在查詢上調用 dumpRawSql 和 ddRawSql 方法，以轉儲帶有所有參數綁定的查詢 SQL：

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

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

Files

queries.md

Latest commit

History

queries.md

File metadata and controls

資料庫：查詢產生器

簡介

執行資料庫查詢

檢索表中的所有列

從表中檢索單行/列

檢索列值清單

分塊結果

懶惰地流式傳輸結果

聚合

確定記錄是否存在

選擇語句

指定選擇子句

原始表達式

原始方法

selectRaw

whereRaw / orWhereRaw

havingRaw / orHavingRaw

orderByRaw

groupByRaw

連接

內部連接子句

左連接 / 右連接子句

交叉連接子句

進階連接子句

子查詢連接

Lateral Joins

Unions

基本 Where 子句

Where 子句

或者條件

不在條件

任何 / 全部 / 無一條件

JSON 條件

額外的 Where 條件

邏輯分組

進階 Where 條件

Where 存在條件

子查詢 Where 條件

全文 Where 條件

排序、分組、限制和偏移

排序

orderBy 方法

latest 和 oldest 方法

隨機排序

移除現有排序

分組

groupBy 和 having 方法

限制和偏移

skip 和 take 方法

條件子句

插入語句

自動增量 ID

Upserts

更新語句

更新或插入

更新 JSON 欄位

增加和減少

刪除語句

悲觀鎖定

調試

`selectRaw`

`whereRaw / orWhereRaw`

`havingRaw / orHavingRaw`

`orderByRaw`

`groupByRaw`

`orderBy` 方法

`latest` 和 `oldest` 方法

`groupBy` 和 `having` 方法

`skip` 和 `take` 方法