Laravel 13.x 中文文档

主题

数据库：查询构建器 ​

简介 ​

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

Laravel 查询构建器使用 PDO 参数绑定来保护您的应用程序免受 SQL 注入攻击。无需清理或净化传递给查询构建器的字符串作为查询绑定。

WARNING

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

Or Where 子句 ​

您可以将 orWhere 方法链接在一起，以向查询添加「or where」子句。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 (Builder $query) {
        $query->where('name', 'Abigail')
            ->where('votes', '>', 50);
    })
    ->get();

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

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

WARNING

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

Where Not 子句 ​

whereNot 方法可用于验证给定列的值不等于给定值：

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

您也可以将闭包传递给 whereNot 方法，以将条件分组到括号内：

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

Where Any / All / None 子句 ​

有时您可能需要将相同的验证应用于多个列。例如，您可能想要检索所有记录，其中任何列都包含给定值。您可以使用 whereAny 方法来实现这一点：

php
$users = DB::table('users')
    ->whereAny([
        'name',
        'email',
        'phone',
    ], 'LIKE', '%taylor%')
    ->get();

whereAll 方法可用于验证所有给定列都匹配给定条件：

php
$users = DB::table('users')
    ->whereAll([
        'first_name',
        'last_name',
    ], 'LIKE', '%T%')
    ->get();

whereNone 方法可用于验证所有给定列都不匹配给定条件：

php
$users = DB::table('users')
    ->whereNone([
        'name',
        'email',
        'phone',
    ], 'LIKE', '%taylor%')
    ->get();

JSON Where 子句 ​

Laravel 也支持查询 JSON 列类型。目前，MySQL 5.7+、PostgreSQL、SQL Server 2017 和 SQLite 3.9.0（使用 JSON1 扩展）支持此功能。要查询 JSON 列，请使用 -> 运算符：

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

您可以使用 whereJsonContains 来查询 JSON 数组：

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

whereBetweenColumns 方法验证列值是否在同一表中两列的值之间：

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

whereNotBetweenColumns 方法验证列值不在同一表中两列的值之间：

php
$patients = DB::table('patients')
    ->whereNotBetweenColumns('weight', ['minimum_weight', 'maximum_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();

whereIntegerInRaw

whereIntegerInRaw 方法可用于验证列值是否等于原始整数数组中的一个：

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

whereIntegerNotInRaw

whereIntegerNotInRaw 方法可用于验证列值不等于原始整数数组中的任何一个：

php
$users = DB::table('users')
    ->whereIntegerNotInRaw('id', ['1', '2'])
    ->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();

whereToday / whereBeforeToday / whereAfterToday

whereToday 方法可用于将列的值与今天进行比较：

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

whereBeforeToday 和 whereAfterToday 方法可用于验证列值是否在今天之前或之后：

php
$users = DB::table('users')
    ->whereBeforeToday('created_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 方法的调用分组到括号内，以避免意外的查询行为。为此，您可以将闭包传递给 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')

WARNING

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

高级 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 方法传递闭包和值来实现这一点。例如，以下查询将检索所有拥有给定类型最近「会员资格」的用户：

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 子句 ​

WARNING

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

whereFullText 和 orWhereFullText 方法可用于向具有 全文索引 的列的查询添加全文「where」子句。这些方法将被 Laravel 转换为底层数据库系统的适当 SQL。例如，对于使用 MariaDB 或 MySQL 的应用程序，将生成 MATCH AGAINST 子句：

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

向量相似性子句 ​

NOTE

向量相似性子句目前仅在 PostgreSQL 连接上使用 pgvector 扩展时支持。有关定义向量列和索引的信息，请参阅 迁移文档。

whereVectorSimilarTo 方法通过余弦相似性与给定向量过滤结果，并按相关性排序结果。minSimilarity 阈值应该是 0.0 到 1.0 之间的值，其中 1.0 表示相同：

php
$documents = DB::table('documents')
    ->whereVectorSimilarTo('embedding', $queryEmbedding, minSimilarity: 0.4)
    ->limit(10)
    ->get();

当向量参数给出普通字符串时，Laravel 将使用 Laravel AI SDK 自动为其生成嵌入：

php
$documents = DB::table('documents')
    ->whereVectorSimilarTo('embedding', 'Best wineries in Napa Valley')
    ->limit(10)
    ->get();

默认情况下，whereVectorSimilarTo 也会按距离排序结果（最相似的在前）。您可以通过将 false 作为 order 参数传递来禁用此排序：

php
$documents = DB::table('documents')
    ->whereVectorSimilarTo('embedding', $queryEmbedding, minSimilarity: 0.4, order: false)
    ->orderBy('created_at', 'desc')
    ->limit(10)
    ->get();

如果您需要更多控制，可以独立使用 selectVectorDistance、whereVectorDistanceLessThan 和 orderByVectorDistance 方法：

php
$documents = DB::table('documents')
    ->select('*')
    ->selectVectorDistance('embedding', $queryEmbedding, as: 'distance')
    ->whereVectorDistanceLessThan('embedding', $queryEmbedding, maxDistance: 0.3)
    ->orderByVectorDistance('embedding', $queryEmbedding)
    ->limit(10)
    ->get();

使用 PostgreSQL 时，必须在创建 vector 列之前加载 pgvector 扩展：

php
Schema::ensureVectorExtensionExists();

排序、分组、限制和偏移 ​

排序 ​

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 方法的签名与 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 时执行给定的闭包。如果第一个参数为 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' => '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()->minus(months: 1)));

自增 ID ​

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

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

WARNING

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

WARNING

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

Update 语句 ​

除了向数据库插入记录外，查询构建器还可以使用 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']
    );

您可以向 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 对象中的适当键。此操作在 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 语句时实现「悲观锁」。要使用「共享锁」执行语句，可以调用 sharedLock 方法。共享锁可防止选定的行在您的事务提交之前被修改：

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

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

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

运行数据库查询 ​

从表中检索所有行 ​

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

php
<?php

namespace App\Http\Controllers;

use Illuminate\Support\Facades\DB;
use Illuminate\View\View;

class UserController extends Controller
{
    /**
     * 显示应用程序的所有用户列表。
     */
    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;
}

NOTE

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

从表中检索单行/列 ​

如果您只需要从数据库表中检索一行，可以使用 DB 门面的 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 方法提供第二个参数来指定结果集合应用作其键的列：

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

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

分块结果 ​

如果您需要处理数千条数据库记录，请考虑使用 DB 门面提供的 chunk 方法。此方法一次检索一小块结果，并将每块传入闭包进行处理。例如，让我们一次以 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) {
    // 处理记录...

    return false;
});

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

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

WARNING

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

延迟流式结果 ​

lazy 方法的工作方式类似于 chunk 方法，因为它以分块方式执行查询。但是，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]);
    });

WARNING

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

聚合 ​

查询构建器还提供了各种方法来检索聚合值，如 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');

确定记录是否存在 ​

您可以使用 exists 和 doesntExist 方法来确定是否存在与查询约束匹配的记录，而不是使用 count 方法：

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

原始表达式 ​

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

php
$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(/* ... */))。此方法接受一个可选的绑定数组作为第二个参数：

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 (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 连接 ​

WARNING

Lateral 连接目前由 PostgreSQL、MySQL >= 8.0.14 和 SQL Server 支持。

您可以使用 joinLateral 和 leftJoinLateral 方法与子查询执行「lateral 连接」。这些方法中的每一个都接收两个参数：子查询及其表别名。连接条件应在给定子查询的 where 子句中指定。Lateral 连接针对每行进行评估，并且可以引用子查询外部的列。

在此示例中，我们将检索用户集合以及用户的三个最近博客文章。每个用户在结果集中最多可以产生三行：每个最近的博客文章一行。连接条件在子查询内使用 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();

联合 ​

查询构建器还提供了一种方便的方法来「联合」两个或更多查询。例如，您可以创建一个初始查询，并使用 union 方法将其与更多查询联合：

php
use Illuminate\Support\Facades\DB;

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

$users = DB::table('users')
    ->whereNull('last_name')
    ->union($usersWithoutFirstName)
    ->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();

WARNING

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