Laravel 9.x 中文文档

简体中文

English

简体中文

English

主题

数据库：查询构建器 ​

介绍 ​

Laravel 的数据库查询构建器提供了一个方便、流畅的接口来创建和运行数据库查询。它可以用于在应用程序中执行大多数数据库操作，并且与所有 Laravel 支持的数据库系统完美配合。

Laravel 查询构建器使用 PDO 参数绑定来保护您的应用程序免受 SQL 注入攻击。无需清理或消毒传递给查询构建器的字符串，因为查询绑定会自动处理。

exclamation

PDO 不支持绑定列名。因此，您不应允许用户输入决定查询中引用的列名，包括 "order by" 列。

运行数据库查询 ​

从表中检索所有行 ​

您可以使用 DB facade 提供的 table 方法开始查询。table 方法返回给定表的流畅查询构建器实例，允许您将更多约束链接到查询中，然后最终使用 get 方法检索查询结果：

php
<?php

namespace App\Http\Controllers;

use App\Http\Controllers\Controller;
use Illuminate\Support\Facades\DB;

class UserController extends Controller
{
    /**
     * 显示应用程序所有用户的列表。
     *
     * @return \Illuminate\Http\Response
     */
    public function index()
    {
        $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;
}
lightbulb

Laravel 集合提供了多种强大的方法来映射和减少数据。有关 Laravel 集合的更多信息，请查看 集合文档。

从表中检索单行/列 ​

如果您只需要从数据库表中检索一行，可以使用 DB facade 的 first 方法。此方法将返回一个 stdClass 对象：

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

return $user->email;

如果您不需要整行，可以使用 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 方法提供第二个参数来指定结果集合应使用的列作为其键：

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

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

分块结果 ​

如果您需要处理数千条数据库记录，请考虑使用 DB facade 提供的 chunk 方法。此方法一次检索一小块结果，并将每个块传递给闭包进行处理。例如，让我们以每次 100 条记录的块检索整个 users 表：

php
use Illuminate\Support\Facades\DB;

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

您可以通过从闭包返回 false 来停止进一步的块处理：

php
DB::table('users')->orderBy('id')->chunk(100, function ($users) {
    // 处理记录...

    return false;
});

如果您在分块结果时更新数据库记录，您的块结果可能会以意想不到的方式更改。如果您计划在分块时更新检索到的记录，最好使用 chunkById 方法。此方法将根据记录的主键自动分页结果：

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

在块回调中更新或删除记录时，对主键或外键的任何更改都可能影响块查询。这可能导致记录未包含在块结果中。

惰性流式结果 ​

lazy 方法的工作方式类似于 chunk 方法，因为它以块的形式执行查询。但是，lazy() 方法返回一个 LazyCollection，允许您将结果作为单个流进行交互：

php
use Illuminate\Support\Facades\DB;

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

同样，如果您计划在迭代检索到的记录时更新它们，最好使用 lazyById 或 lazyByIdDesc 方法。这些方法将根据记录的主键自动分页结果：

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

在迭代记录时更新或删除记录时，对主键或外键的任何更改都可能影响块查询。这可能导致记录未包含在结果中。

聚合 ​

查询构建器还提供了多种方法来检索聚合值，如 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" 子句：

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

如果您已经有一个查询构建器实例，并希望向其现有的选择子句中添加列，可以使用 addSelect 方法：

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

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

原始表达式 ​

有时您可能需要在查询中插入任意字符串。要创建原始字符串表达式，可以使用 DB facade 提供的 raw 方法：

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

原始语句将作为字符串注入查询，因此您应非常小心，以避免创建 SQL 注入漏洞。

原始方法 ​

除了使用 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();

连接 ​

内连接子句 ​

查询构建器还可以用于向查询中添加连接子句。要执行基本的 "内连接"，可以在查询构建器实例上使用 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();

左连接/右连接子句 ​

如果您想执行 "左连接" 或 "右连接" 而不是 "内连接"，请使用 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 方法执行 "交叉连接"。交叉连接在第一个表和连接的表之间生成笛卡尔积：

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

高级连接子句 ​

您还可以指定更高级的连接子句。要开始，请将闭包作为第二个参数传递给 join 方法。闭包将接收一个 Illuminate\Database\Query\JoinClause 实例，允许您在 "join" 子句上指定约束：

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

如果您想在连接上使用 "where" 子句，可以使用 JoinClause 实例提供的 where 和 orWhere 方法。这些方法将比较列与值，而不是比较两个列：

php
DB::table('users')
        ->join('contacts', function ($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 ($join) {
            $join->on('users.id', '=', 'latest_posts.user_id');
        })->get();

联合 ​

查询构建器还提供了一种方便的方法来将两个或多个查询 "联合" 在一起。例如，您可以创建一个初始查询，并使用 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();

如前所述，您可以使用数据库系统支持的任何运算符：

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

PDO 不支持绑定列名。因此，您不应允许用户输入决定查询中引用的列名，包括 "order by" 列。

Or Where 子句 ​

在将查询构建器的 where 方法调用链接在一起时，"where" 子句将使用 and 运算符连接在一起。但是，您可以使用 orWhere 方法将子句与查询连接在一起，使用 or 运算符。orWhere 方法接受与 where 方法相同的参数：

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

如果您需要在括号内分组 "or" 条件，可以将闭包作为 orWhere 方法的第一个参数传递：

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

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

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

您应始终在括号中分组 orWhere 调用，以避免在应用全局作用域时出现意外行为。

Where Not 子句 ​

whereNot 和 orWhereNot 方法可用于否定给定的查询约束组。例如，以下查询排除在清仓或价格低于十的产品：

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

JSON Where 子句 ​

Laravel 还支持在提供 JSON 列类型支持的数据库上查询 JSON 列。目前，这包括 MySQL 5.7+、PostgreSQL、SQL Server 2016 和 SQLite 3.39.0（带有 JSON1 扩展）。要查询 JSON 列，请使用 -> 运算符：

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

您可以使用 whereJsonContains 查询 JSON 数组。此功能不支持 SQLite 数据库版本低于 3.38.0：

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

如果您的应用程序使用 MySQL 或 PostgreSQL 数据库，可以将值数组传递给 whereJsonContains 方法：

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

您可以使用 whereJsonLength 方法按其长度查询 JSON 数组：

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

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

附加的 Where 子句 ​

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

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
)
exclamation

如果您向查询中添加大量整数绑定数组，可以使用 whereIntegerInRaw 或 whereIntegerNotInRaw 方法来大大减少内存使用。

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

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 调用，以避免意外的查询行为。为此，您可以将闭包传递给 where 方法：

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

如您所见，将闭包传递给 where 方法指示查询构建器开始一个约束组。闭包将接收一个查询构建器实例，您可以使用它来设置应包含在括号组中的约束。上面的示例将生成以下 SQL：

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

您应始终在括号中分组 orWhere 调用，以避免在应用全局作用域时出现意外行为。

高级 Where 子句 ​

Where Exists 子句 ​

whereExists 方法允许您编写 "where exists" SQL 子句。whereExists 方法接受一个闭包，该闭包将接收一个查询构建器实例，允许您定义应放置在 "exists" 子句中的查询：

php
$users = DB::table('users')
           ->whereExists(function ($query) {
               $query->select(DB::raw(1))
                     ->from('orders')
                     ->whereColumn('orders.user_id', 'users.id');
           })
           ->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;

$users = User::where(function ($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;

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

全文本 Where 子句 ​

exclamation

全文本 where 子句目前由 MySQL 和 PostgreSQL 支持。

whereFullText 和 orWhereFullText 方法可用于为具有 全文本索引 的列向查询添加全文本 "where" 子句。这些方法将由 Laravel 转换为底层数据库系统的适当 SQL。例如，对于使用 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();

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

分组 ​

groupBy 和 having 方法 ​

正如您所料，groupBy 和 having 方法可用于对查询结果进行分组。having 方法的签名与 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 方法。

限制和偏移 ​

skip 和 take 方法 ​

您可以使用 skip 和 take 方法限制查询返回的结果数量或跳过查询中的给定结果数量：

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

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

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 ($query, $role) {
                    $query->where('role_id', $role);
                })
                ->get();

when 方法仅在第一个参数为 true 时执行给定的闭包。如果第一个参数为 false，则不会执行闭包。因此，在上面的示例中，只有在传入请求中存在 role 字段并且其值为 true 时，才会调用 when 方法给定的闭包。

您可以将另一个闭包作为 when 方法的第三个参数传递。只有在第一个参数评估为 false 时，才会执行此闭包。为了说明如何使用此功能，我们将使用它来配置查询的默认排序：

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

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

插入语句 ​

查询构建器还提供了一个 insert 方法，可用于将记录插入数据库表。insert 方法接受一个列名和值的数组：

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

您可以通过传递数组的数组一次插入多条记录。每个数组表示应插入表中的一条记录：

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

insertOrIgnore 方法将在将记录插入数据库时忽略错误。使用此方法时，您应注意，重复记录错误将被忽略，并且根据数据库引擎的不同，其他类型的错误也可能被忽略。例如，insertOrIgnore 将 绕过 MySQL 的严格模式：

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

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

自动递增 ID ​

如果表具有自动递增的 id，请使用 insertGetId 方法插入记录，然后检索 ID：

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

使用 PostgreSQL 时，insertGetId 方法期望自动递增列命名为 id。如果您希望从不同的 "序列" 中检索 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 列。

exclamation

除 SQL Server 外的所有数据库都要求 upsert 方法的第二个参数中的列具有 "primary" 或 "unique" 索引。此外，MySQL 数据库驱动程序会忽略 upsert 方法的第二个参数，并始终使用表的 "primary" 和 "unique" 索引来检测现有记录。

更新语句 ​

除了将记录插入数据库外，查询构建器还可以使用 update 方法更新现有记录。update 方法与 insert 方法一样，接受一个列和值对的数组，指示要更新的列。update 方法返回受影响的行数。您可以使用 where 子句约束 update 查询：

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

更新或插入 ​

有时您可能希望更新数据库中的现有记录，或者在不存在匹配记录时创建它。在这种情况下，可以使用 updateOrInsert 方法。updateOrInsert 方法接受两个参数：用于查找记录的条件数组，以及指示要更新的列和值对的数组。

updateOrInsert 方法将尝试使用第一个参数的列和值对定位匹配的数据库记录。如果记录存在，将使用第二个参数中的值更新它。如果找不到记录，将使用两个参数的合并属性插入新记录：

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

更新 JSON 列 ​

更新 JSON 列时，应使用 -> 语法更新 JSON 对象中的适当键。此操作在 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 方法之前添加 "where" 子句来约束 delete 语句：

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

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

如果您希望截断整个表，这将删除表中的所有记录并将自动递增 ID 重置为零，可以使用 truncate 方法：

php
DB::table('users')->truncate();

表截断和 PostgreSQL ​

截断 PostgreSQL 数据库时，将应用 CASCADE 行为。这意味着所有外键相关的记录也将被删除。

悲观锁定 ​

查询构建器还包括一些函数，帮助您在执行 select 语句时实现 "悲观锁定"。要使用 "共享锁" 执行语句，可以调用 sharedLock 方法。共享锁可防止选定的行在事务提交之前被修改：

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

或者，您可以使用 lockForUpdate 方法。"for update" 锁可防止选定的记录被修改或与另一个共享锁一起选择：

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

调试 ​

您可以在构建查询时使用 dd 和 dump 方法来转储当前查询绑定和 SQL。dd 方法将显示调试信息，然后停止执行请求。dump 方法将显示调试信息，但允许请求继续执行：

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

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

版权所有 © 2024-2025 laravel.wiki