Laravel 11.x 中文文档

简体中文

English

简体中文

English

主题

数据库：查询构建器 ​

简介 ​

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

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

exclamation

PDO 不支持绑定列名。因此，您绝对不应允许用户输入决定查询中引用的列名，包括“按顺序排列”列。

运行数据库查询 ​

从表中检索所有行 ​

您可以使用 DB facade 提供的 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;
}
lightbulb

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

从表中检索单行/列 ​

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

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

return $user->email;

如果您想从数据库表中检索单行，但如果没有找到匹配的行则抛出 Illuminate\Database\RecordNotFoundException，可以使用 firstOrFail 方法。如果未捕获 RecordNotFoundException，则会自动向客户端发送 404 HTTP 响应：

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

如果您不需要整个行，可以使用 value 方法从记录中提取单个值。此方法将直接返回列的值：

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

要通过其 id 列值检索单行，请使用 find 方法：

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

检索列值列表 ​

如果您想检索一个 Illuminate\Support\Collection 实例，其中包含单列的值，可以使用 pluck 方法。在此示例中，我们将检索用户标题的集合：

php
use Illuminate\Support\Facades\DB;

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

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

您可以通过向 pluck 方法提供第二个参数来指定结果集合应使用的键列：

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) {
    // 处理记录...

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

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

懒惰地流式结果 ​

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

确定记录是否存在 ​

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

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

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

选择语句 ​

指定选择子句 ​

您可能并不总是想从数据库表中选择所有列。使用 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 实例，允许您指定“连接”子句上的约束：

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

侧连接 ​

exclamation

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

您可以使用 joinLateral 和 leftJoinLateral 方法与子查询执行“侧连接”。每个方法接收两个参数：子查询及其表别名。连接条件应在给定子查询的 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();

并集 ​

查询构建器还提供了一种方便的方法来“并集”两个或多个查询。例如，您可以创建一个初始查询，并使用 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 不支持绑定列名。因此，您绝对不应允许用户输入决定查询中引用的列名，包括“按顺序排列”列。

exclamation

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

如果您需要在括号内对“或”条件进行分组，可以将闭包作为第一个参数传递给 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)
exclamation

您应该始终对 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 子句 ​

有时您可能需要将相同的查询约束应用于多个列。例如，您可能希望检索所有记录，其中给定列表中的任何列都与给定值相似。您可以使用 whereAny 方法来实现：

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

上面的查询将生成以下 SQL：

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

类似地，whereAll 方法可用于检索所有给定列匹配给定约束的记录：

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

上面的查询将生成以下 SQL：

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

whereNone 方法可用于检索没有给定列匹配给定约束的记录：

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

上面的查询将生成以下 SQL：

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

JSON Where 子句 ​

Laravel 还支持在提供 JSON 列类型支持的数据库上查询 JSON 列类型。目前，这包括 MariaDB 10.3+、MySQL 8.0+、PostgreSQL 12.0+、SQL Server 2017+ 和 SQLite 3.39.0+。要查询 JSON 列，请使用 -> 运算符：

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

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

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

如果您的应用程序使用 MariaDB、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 子句 ​

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 条件的“或”子句：

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 条件的“或”子句：

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

whereLike 大小写敏感搜索选项目前不支持 SQL Server。

whereIn / whereNotIn / orWhereIn / orWhereNotIn

whereIn 方法验证给定列的值是否包含在给定数组中：

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

whereNotIn 方法验证给定列的值是否不包含在给定数组中：

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

您还可以提供查询对象作为 whereIn 方法的第二个参数：

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

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

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

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

如果您向查询添加大量整数绑定，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();

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

您应该始终对 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 子句 ​

exclamation

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

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

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

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

排序 ​

orderBy 方法 ​

orderBy 方法允许您按给定列对查询结果进行排序。orderBy 方法接受的第一个参数应为您希望按其排序的列，而第二个参数确定排序的方向，可以是 asc 或 desc：

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

要按多个列排序，您可以根据需要多次调用 orderBy：

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

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

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

您可以将另一个闭包作为 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 方法接受一个列名和值的数组：

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 方法第二个参数中的列具有“主键”或“唯一”索引。此外，MariaDB 和 MySQL 数据库驱动程序忽略 upsert 方法的第二个参数，并始终使用表的“主键”和“唯一”索引来检测现有记录。

更新语句 ​

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

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 方法之前添加“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();

虽然不是强制性的，但建议将悲观锁包装在一个事务中。这样可以确保在整个操作完成之前，数据库中检索到的数据保持不变。如果操作失败，事务会回滚所有更改并自动释放锁：

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

调试 ​

您可以在构建查询时使用 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();

版权所有 © 2024-2025 laravel.wiki