Laravel 中文文档

主题

全部文档

数据库：查询构建器 ​

简介 ​

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

Laravel 查询构建器使用 PDO 参数绑定来保护应用免受 SQL 注入攻击。作为查询绑定传入查询构建器的字符串无需再清理或消毒。

WARNING

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

INFO

Laravel 集合提供了多种极为强大的数据映射与归约方法。要了解更多，请参阅集合文档。

检索表中的单行 / 单列 ​

若只需从数据库表检索单行，可使用 DB facade 的 first 方法。该方法会返回单个 stdClass 对象：

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

return $user->email;

若要从数据库表检索单行，并在找不到匹配行时抛出 Illuminate\Database\RecordNotFoundException，可使用 firstOrFail 方法。若未捕获该异常，会自动向客户端返回 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 facade 提供的 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) {
    // Process the records...

    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 方法与分块方法类似，同样按块执行查询。不过，它不会把每一块传给回调，而是返回一个 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');

判断记录是否存在 ​

若不想用 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();

原生表达式 ​

有时你可能需要向查询插入任意字符串。要创建原生字符串表达式，可使用 DB facade 提供的 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();

连接（Joins） ​

内连接子句 ​

查询构建器也可用于向查询添加 join 子句。要执行基本的「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」而非「inner 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」。交叉连接会在第一张表与被连接的表之间生成笛卡尔积。交叉连接不接受「子句」闭包，因为它们不需要通过列约束来连接两个表：

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

高级连接子句 ​

你也可以指定更高级的 join 子句。首先，将闭包作为第二个参数传给 join 方法。闭包会收到一个 Illuminate\Database\Query\JoinClause 实例，使你可以指定加在 join 子句上的约束：

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

若要在 join 上使用「where」子句，可使用 JoinClause 实例提供的 where 与 orWhere 方法。这些方法接受的参数与查询构建器上的 where / orWhere 相同，但会把约束加到 join 上，而不是加到查询的「where」子句中：

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 方法将查询连接到子查询。这些方法各接受三个参数：子查询、其表别名，以及定义相关列的闭包：

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） ​

WARNING

目前 PostgreSQL、MySQL >= 8.0.14 以及 SQL Server 支持横向连接（lateral joins）。

你可以使用 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;

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

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

除了 union 方法外，查询构建器还提供 unionAll 方法。使用 unionAll 合并的查询不会移除重复结果。

基础 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」列。

WARNING

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)

WARNING

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

Where Not 子句 ​

whereNot 与 orWhereNot 方法可用于否定一组给定的查询约束。例如，下面的查询会排除清仓商品或价格低于十的商品：

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
$albums = 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();

WARNING

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

$comments = 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
)

WARNING

若向查询添加大量整数绑定，可使用 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
$products = DB::table('products')
    ->whereValueBetween(100, ['min_price', 'max_price'])
    ->get();

whereValueNotBetween 方法验证值是否位于同一表行中两列的值之外：

php
$products = 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 方法调用放在括号中分组，以避免意外的查询行为。为此，你可以向 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 方法传入闭包和值来实现。例如，下面的查询会检索所有拥有给定类型近期「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 子句 ​

WARNING

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

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

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

向量相似度子句 ​

INFO

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

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 还会按距离排序（最相似的在前）。你可以通过将 order 参数设为 false 来禁用该排序：

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 时，必须先加载 pgvector 扩展，才能创建 vector 列：

php
Schema::ensureVectorExtensionExists();

排序、分组、Limit 与 Offset ​

排序 ​

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 ​

你可以使用 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 方法。

Upsert ​

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 方法第二个参数中的列具有「primary」或「unique」索引。此外，MariaDB 与 MySQL 数据库驱动会忽略 upsert 的第二个参数，并始终使用表的「primary」与「unique」索引来检测已有记录。

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' => '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」子句来约束删除语句：

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

虽非强制，但建议将悲观锁包在事务中。这可确保检索到的数据在整个操作完成前不会在数据库中被改动。若失败，事务会回滚任何更改并自动释放锁：

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) { // [tl! remove]
        $query->where('destination', $destination); // [tl! remove]
    }) // [tl! remove]
    ->tap(new DestinationFilter($destination)) // [tl! add]
    ->orderByDesc('price')
    ->get();

// ...

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

查询管道 ​

tap 方法始终返回查询构建器。若希望提取一个会执行查询并返回其他值的对象，可改用 pipe 方法。

考虑下面这个包含应用中共用分页逻辑的查询对象。与向查询应用条件的 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();