后盾人

Appearance

数据库查询生成器 ​

介绍 ​

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

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

WARNING

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

运行数据库查询 ​

从表中检索所有行 ​

您可以使用 DB Facade 提供的 table 方法来开始查询。table 方法返回给定表的 Fluent 查询生成器实例，允许您将更多约束链接到查询，然后最终使用 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 Facade 的第一种方法。此方法将返回单个 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 方法。此方法一次检索一小块结果，并将每个块馈送到 closure 中进行处理。例如，让我们一次以 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 来阻止进一步的 chunk 被处理：

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

WARNING

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

延迟流式处理结果 ​

lazy 方法的工作方式类似于 chunk 方法，因为它以 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

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

Aggregates ​

查询生成器还提供了多种方法来检索聚合值，如 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 Facade 提供的原始方法：

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

WARNING

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

Raw 方法 ​

除了使用 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 ​

Inner 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 Clause ​

如果要执行 “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();

交叉JOIN ​

您可以使用 crossJoin 方法执行 “cross join”。交叉联接在第一个表和联接的表之间生成笛卡尔积：

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

高级 join 查询 ​

您还可以指定更高级的 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();

如果您想在联接上使用 “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();

横向联接 ​

WARNING

PostgreSQL、MySQL >= 8.0.14 和 SQL Server 目前支持横向联接。

您可以使用 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 方法将其与更多查询联合：

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

您可以使用查询生成器的 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();

WARNING

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 (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 方法可用于否定给定的查询约束组。例如，以下查询排除了正在清仓或价格低于 10 的商品：

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
    $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 条件的 “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

SQL Server 当前不支持 whereLike 区分大小写的搜索选项。

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
)

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

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

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 方法提供 query 对象，而不是闭包：

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” 子句，用于将列与子查询的结果进行比较。你可以通过将 column、operator 和 closure 传递给 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();

Ordering, Grouping, Limit and Offset ​

Ordering ​

The orderBy Method ​

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

The latest and oldest Methods ​

latest和oldest的方法允许您轻松地按日期对结果进行排序。默认情况下，结果将按表的 created_at 列排序。或者，您可以传递要作为排序依据的列名称：

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

Random Ordering ​

inRandomOrder 方法可用于对查询结果进行随机排序。例如，你可以使用这个方法来获取一个随机的用户：

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

Removing Existing Orderings ​

reorder 方法删除了以前应用于查询的所有 “order by” 子句：

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

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

您可以在调用 reorder 方法时传递列和方向，以便删除所有现有的 “order by” 子句并将全新的 order 应用于查询：

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

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

Grouping ​

The groupBy and having Methods ​

如您所料，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 and Offset ​

The skip and take Methods ​

您可以使用 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 请求中存在给定的 input 值，则您可能只想应用 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 时，才会执行此闭包。为了说明如何使用此功能，我们将使用它来配置查询的默认 Sequences：

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 的 strict 模式：

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

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

WARNING

使用 PostgreSQL 时，insertGetId 方法要求自动递增列命名为 id。如果您想从不同的 “序列” 中检索 ID，您可以将列名作为第二个参数传递给 insertGetId 方法。

更新插入 ​

upsert 方法将插入不存在的记录，并使用您可能指定的新值更新已存在的记录。该方法的第一个参数由要插入或更新的值组成，而第二个参数列出了唯一标识关联表中记录的列。该方法的第三个也是最后一个参数是一个列数组，如果数据库中已存在匹配的记录，则应更新该数组：

php
    DB::table('flights')->upsert(
        [
            ['departure' => 'Oakland', 'destination' => 'San Diego', 'price' => 99],
            ['departure' => 'Chicago', 'destination' => 'New York', 'price' => 150]
        ],
        ['departure', 'destination'],
        ['price']
    );

在上面的示例中，Laravel 将尝试插入两条记录。如果已存在具有相同出发地和目的地列值的记录，Laravel 将更新该记录的 price 列。

WARNING

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

Update 语句 ​

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

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

更新或插入 ​

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

updateOrInsert 方法将尝试使用第一个参数的列和值对来查找匹配的数据库记录。如果记录存在，它将使用第二个参数中的值进行更新。如果找不到记录，将插入一条新记录，其中包含两个参数的 merged 属性：

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

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

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

表截断和 PostgreSQL ​

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

悲观锁定 ​

查询生成器还包括一些函数，可帮助您在执行 select 语句时实现 “悲观锁定”。要执行带有 “shared lock” 的语句，您可以调用 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();

可以在查询上调用 dumpRawSql 和 ddRawSql 方法，以转储查询的 SQL，并正确替换所有参数绑定：

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

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

后盾人版权所有 © 2018-2024 创作不易请尊重他人劳动成果，未经授权禁止转载！