hyperf/docs/zh-cn/db/querybuilder.md

查询构造器

简介

Hyperf 的数据库查询构造器为创建和运行数据库查询提供了一个方便的接口。它可用于执行应用程序中大部分数据库操作，且可在所有支持的数据库系统上运行。

Hyperf 的查询构造器使用 PDO 参数绑定来保护您的应用程序免受 SQL 注入攻击。因此没有必要清理作为绑定传递的字符串。

这里只提供一部分常用的教程，具体教程可以到 Laravel 官网查看。 Laravel Query Builder

获取结果

use Hyperf\DbConnection\Db;

$users = Db::select('SELECT * FROM user;');
$users = Db::table('user')->get();
$users = Db::table('user')->select('name', 'gender as user_gender')->get();

Db::select() 方法会返回一个 array，而 get 方法会返回 Hyperf\Collection\Collection。其中元素是 stdClass，所以可以通过以下代码返回各个元素的数据

<?php

foreach ($users as $user) {
    echo $user->name;
}

将结果转为数组格式

在某些场景下，您可能会希望查询出来的结果内采用 数组(Array) 而不是 stdClass 对象结构时，而 Eloquent 又去除了通过配置的形式配置默认的 FetchMode，那么此时可以通过监听器来监听 Hyperf\Database\Events\StatementPrepared 事件来变更该配置：

<?php
declare(strict_types=1);

namespace App\Listener;

use Hyperf\Database\Events\StatementPrepared;
use Hyperf\Event\Annotation\Listener;
use Hyperf\Event\Contract\ListenerInterface;
use PDO;

#[Listener]
class FetchModeListener implements ListenerInterface
{
    public function listen(): array
    {
        return [
            StatementPrepared::class,
        ];
    }

    public function process(object $event)
    {
        if ($event instanceof StatementPrepared) {
            $event->statement->setFetchMode(PDO::FETCH_ASSOC);
        }
    }
}

获取一行的值

如果想获取一行的值, 则可以使用 first 方法

<?php
use Hyperf\DbConnection\Db;

$row = Db::table('user')->first(); // sql 会自动加上 limit 1
var_dump($row);

获取单个值

如果想获取单个值, 则可以使用 value 方法

<?php
use Hyperf\DbConnection\Db;

$id = Db::table('user')->value('id');
var_dump($id);

获取一列的值

如果你想获取包含单列值的集合，则可以使用 pluck 方法。在下面的例子中，我们将获取角色表中标题的集合：

<?php
use Hyperf\DbConnection\Db;

$names = Db::table('user')->pluck('name');

foreach ($names as $name) {
    echo $name;
}

你还可以在返回的集合中指定字段的自定义键值：

<?php
use Hyperf\DbConnection\Db;

$roles = Db::table('roles')->pluck('title', 'name');

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

分块结果

如果你需要处理上千条数据库记录，你可以考虑使用 chunk 方法。该方法一次获取结果集的一小块，并将其传递给 闭包 函数进行处理。该方法在 Command 编写数千条处理数据的时候非常有用。例如，我们可以将全部 user 表数据切割成一次处理 100 条记录的一小块：

<?php
use Hyperf\DbConnection\Db;

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

你可以通过在 闭包 中返回 false 来终止继续获取分块结果：

use Hyperf\DbConnection\Db;

Db::table('user')->orderBy('id')->chunk(100, function ($users) {

    return false;
});

如果要在分块结果时更新数据库记录，则块结果可能会和预计的返回结果不一致。 因此，在分块更新记录时，最好使用 chunkById 方法。 此方法将根据记录的主键自动对结果进行分页：

use Hyperf\DbConnection\Db;

Db::table('user')->where('gender', 1)->chunkById(100, function ($users) {
    foreach ($users as $user) {
        Db::table('user')
            ->where('id', $user->id)
            ->update(['update_time' => time()]);
    }
});

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

聚合查询

框架还提供了聚合类方法，例如 count, max, min, avg, sum。

use Hyperf\DbConnection\Db;

$count = Db::table('user')->count();

判断记录是否存在

除了通过 count 方法可以确定查询条件的结果是否存在之外，还可以使用 exists 和 doesntExist 方法：

return Db::table('orders')->where('finalized', 1)->exists();

return Db::table('orders')->where('finalized', 1)->doesntExist();

查询

指定一个 Select 语句

当然你可能并不总是希望从数据库表中获取所有列。使用 select 方法，你可以自定义一个 select 查询语句来查询指定的字段：

$users = Db::table('user')->select('name', 'email as user_email')->get();

distinct 方法会强制让查询返回的结果不重复：

$users = Db::table('user')->distinct()->get();

如果你已经有了一个查询构造器实例，并且希望在现有的查询语句中加入一个字段，那么你可以使用 addSelect 方法：

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

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

原始表达式

有时你需要在查询中使用原始表达式，例如实现 COUNT(0) AS count，这就需要用到 raw 方法。

use Hyperf\DbConnection\Db;

$res = Db::table('user')->select('gender', Db::raw('COUNT(0) AS `count`'))->groupBy('gender')->get();

强制索引

数据库出现的慢查问题, 90% 以上是索引不对, 其中有部分查询是因为数据库服务器的 查询优化器 没有使用最佳索引, 这时候就需要使用强制索引:

Db::table(Db::raw("{$table} FORCE INDEX({$index})"));

原生方法

可以使用以下方法代替 Db::raw，将原生表达式插入查询的各个部分。

selectRaw 方法可以代替 select(Db::raw(...))。该方法的第二个参数是可选项，值是一个绑定参数的数组：

$orders = Db::table('order')
    ->selectRaw('price * ? as price_with_tax', [1.0825])
    ->get();

whereRaw 和 orWhereRaw 方法将原生的 where 注入到你的查询中。这两个方法的第二个参数还是可选项，值还是绑定参数的数组：

$orders = Db::table('order')
    ->whereRaw('price > IF(state = "TX", ?, 100)', [200])
    ->get();

havingRaw 和 orHavingRaw 方法可以用于将原生字符串设置为 having 语句的值：

$orders = Db::table('order')
    ->select('department', Db::raw('SUM(price) as total_sales'))
    ->groupBy('department')
    ->havingRaw('SUM(price) > ?', [2500])
    ->get();

orderByRaw 方法可用于将原生字符串设置为 order by 子句的值：

$orders = Db::table('order')
    ->orderByRaw('updated_at - created_at DESC')
    ->get();

表连接

Inner Join Clause

查询构造器也可以编写 join 方法。若要执行基本的「内链接」，你可以在查询构造器实例上使用 join 方法。传递给 join 方法的第一个参数是你需要连接的表的名称，而其他参数则使用指定连接的字段约束。你还可以在单个查询中连接多个数据表：

$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

如果你想使用「左连接」或者「右连接」代替「内连接」，可以使用 leftJoin 或者 rightJoin 方法。这两个方法与 join 方法用法相同：

$users = Db::table('users')
    ->leftJoin('posts', 'users.id', '=', 'posts.user_id')
    ->get();
$users = Db::table('users')
    ->rightJoin('posts', 'users.id', '=', 'posts.user_id')
    ->get();

Cross Join 语句

使用 crossJoin 方法和你想要连接的表名做「交叉连接」。交叉连接在第一个表和被连接的表之间会生成笛卡尔积：

$users = Db::table('sizes')
    ->crossJoin('colours')
    ->get();

高级 Join 语句

你可以指定更高级的 join 语句。比如传递一个 闭包 作为 join 方法的第二个参数。此 闭包 接收一个 JoinClause 对象，从而指定 join 语句中指定的约束：

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

如果你想要在连接上使用「where」风格的语句，你可以在连接上使用 where 和 orWhere 方法。这些方法会将列和值进行比较，而不是列和列进行比较：

Db::table('users')
    ->join('contacts', function ($join) {
        $join->on('users.id', '=', 'contacts.user_id')
                ->where('contacts.user_id', '>', 5);
    })
    ->get();

子连接查询

你可以使用 joinSub，leftJoinSub 和 rightJoinSub 方法关联一个查询作为子查询。他们每一种方法都会接收三个参数：子查询，表别名和定义关联字段的闭包：

$latestPosts = Db::table('posts')
    ->select('user_id', Db::raw('MAX(created_at) as last_post_created_at'))
    ->where('is_published', true)
    ->groupBy('user_id');

$users = Db::table('users')
    ->joinSub($latestPosts, 'latest_posts', function($join) {
        $join->on('users.id', '=', 'latest_posts.user_id');
    })->get();

联合查询

查询构造器还提供了将两个查询 「联合」 的快捷方式。比如，你可以先创建一个查询，然后使用 union 方法将其和第二个查询进行联合：

$first = Db::table('users')->whereNull('first_name');

$users = Db::table('users')
    ->whereNull('last_name')
    ->union($first)
    ->get();

Where 语句

简单的 Where 语句

在构造 where 查询实例的中，你可以使用 where 方法。调用 where 最基本的方式是需要传递三个参数：第一个参数是列名，第二个参数是任意一个数据库系统支持的运算符，第三个是该列要比较的值。

例如，下面是一个要验证 gender 字段的值等于 1 的查询：

$users = Db::table('user')->where('gender', '=', 1)->get();

为了方便，如果你只是简单比较列值和给定数值是否相等，可以将数值直接作为 where 方法的第二个参数：

$users = Db::table('user')->where('gender', 1)->get();

当然，你也可以使用其他的运算符来编写 where 子句：

$users = Db::table('users')->where('gender', '>=', 0)->get();

$users = Db::table('users')->where('gender', '<>', 1)->get();

$users = Db::table('users')->where('name', 'like', 'T%')->get();

你还可以传递条件数组到 where 函数中：

$users = Db::table('user')->where([
    ['status', '=', '1'],
    ['gender', '=', '1'],
])->get();

你还可以使用闭包的方式创建查询数组

$users = Db::table('user')->where([
    ['status', '=', '1'],
    ['gender', '=', '1'],
    [function ($query) {
        $query->where('type', 3)->orWhere('type', 6);
    }]
])->get();

Or 语句

你可以一起链式调用 where 约束，也可以在查询中添加 or 字句。 orWhere 方法和 where 方法接收的参数一样：

$users = Db::table('user')
    ->where('gender', 1)
    ->orWhere('name', 'John')
    ->get();

其他 Where 语句

whereBetween

whereBetween 方法验证字段值是否在给定的两个值之间：

$users = Db::table('users')->whereBetween('votes', [1, 100])->get();

whereNotBetween

whereNotBetween 方法验证字段值是否在给定的两个值之外：

$users = Db::table('users')->whereNotBetween('votes', [1, 100])->get();

whereIn / whereNotIn

whereIn 方法验证字段的值必须存在指定的数组里:

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

whereNotIn 方法验证字段的值必须不存在于指定的数组里:

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

参数分组

有时候你需要创建更高级的 where 子句，例如「where exists」或者嵌套的参数分组。查询构造器也能够处理这些。下面，让我们看一个在括号中进行分组约束的例子:

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

你可以看到，通过一个 Closure 写入 where 方法构建一个查询构造器 来约束一个分组。这个 Closure 接收一个查询实例，你可以使用这个实例来设置应该包含的约束。上面的例子将生成以下 SQL:

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

你应该用 orWhere 调用这个分组，以避免应用全局作用出现意外.

Where Exists 语句

whereExists 方法允许你使用 where exists SQL 语句。 whereExists 方法接收一个 Closure 参数，该 whereExists 方法接受一个 Closure 参数，该闭包获取一个查询构建器实例从而允许你定义放置在 exists 字句中查询：

Db::table('users')->whereExists(function ($query) {
    $query->select(Db::raw(1))
            ->from('orders')
            ->whereRaw('orders.user_id = users.id');
})
->get();

上述查询将产生如下的 SQL 语句：

select * from users
where exists (
    select 1 from orders where orders.user_id = users.id
)

JSON Where 语句

Hyperf 也支持查询 JSON 类型的字段（仅在对 JSON 类型支持的数据库上）。

$users = Db::table('users')
    ->where('options->language', 'en')
    ->get();

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

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

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

你可以使用 whereJsonLength 来查询 JSON 数组的长度：

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

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

Ordering, Grouping, Limit, & Offset

orderBy

orderBy 方法允许你通过给定字段对结果集进行排序。 orderBy 的第一个参数应该是你希望排序的字段，第二个参数控制排序的方向，可以是 asc 或 desc

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

latest / oldest

latest 和 oldest 方法可以使你轻松地通过日期排序。它默认使用 created_at 列作为排序依据。当然，你也可以传递自定义的列名：

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

inRandomOrder

inRandomOrder 方法被用来将结果随机排序。例如，你可以使用此方法随机找到一个用户。

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

groupBy / having

groupBy 和 having 方法可以将结果分组。 having 方法的使用与 where 方法十分相似：

$users = Db::table('users')
    ->groupBy('account_id')
    ->having('account_id', '>', 100)
    ->get();

你可以向 groupBy 方法传递多个参数：

$users = Db::table('users')
    ->groupBy('first_name', 'status')
    ->having('account_id', '>', 100)
    ->get();

对于更高级的 having 语法，参见 havingRaw 方法。

skip / take

要限制结果的返回数量，或跳过指定数量的结果，你可以使用 skip 和 take 方法：

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

或者你也可以使用 limit 和 offset 方法：

$users = Db::table('users')->offset(10)->limit(5)->get();

条件语句

有时候你可能想要子句只适用于某个情况为真是才执行查询。例如你可能只想给定值在请求中存在的情况下才应用 where 语句。 你可以通过使用 when 方法：

$role = $request->input('role');

$users = Db::table('users')
    ->when($role, function ($query, $role) {
        return $query->where('role_id', $role);
    })
    ->get();

when 方法只有在第一个参数为 true 的时候才执行给的的闭包。如果第一个参数为 false ，那么这个闭包将不会被执行

你可以传递另一个闭包作为 when 方法的第三个参数。 该闭包会在第一个参数为 false 的情况下执行。为了说明如何使用这个特性，我们来配置一个查询的默认排序：

$sortBy = null;

$users = Db::table('users')
    ->when($sortBy, function ($query, $sortBy) {
        return $query->orderBy($sortBy);
    }, function ($query) {
        return $query->orderBy('name');
    })
    ->get();

插入

查询构造器还提供了 insert 方法用于插入记录到数据库中。 insert 方法接收数组形式的字段名和字段值进行插入操作：

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

你甚至可以将数组传递给 insert 方法，将多个记录插入到表中

Db::table('users')->insert([
    ['email' => 'taylor@example.com', 'votes' => 0],
    ['email' => 'dayle@example.com', 'votes' => 0]
]);

自增 ID

如果数据表有自增 ID ，使用 insertGetId 方法来插入记录并返回 ID 值

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

更新

当然， 除了插入记录到数据库中，查询构造器也可以通过 update 方法更新已有的记录。 update 方法和 insert 方法一样，接受包含要更新的字段及值的数组。你可以通过 where 子句对 update 查询进行约束：

Db::table('users')->where('id', 1)->update(['votes' => 1]);

更新或者新增

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

updateOrInsert 方法将首先尝试使用第一个参数的键和值对来查找匹配的数据库记录。 如果记录存在，则使用第二个参数中的值去更新记录。 如果找不到记录，将插入一个新记录，更新的数据是两个数组的集合：

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

更新 JSON 字段

更新 JSON 字段时，你可以使用 -> 语法访问 JSON 对象中相应的值，此操作只能支持 MySQL 5.7+：

Db::table('users')->where('id', 1)->update(['options->enabled' => true]);

自增与自减

查询构造器还为给定字段的递增或递减提供了方便的方法。此方法提供了一个比手动编写 update 语句更具表达力且更精练的接口。

这两种方法都至少接收一个参数：需要修改的列。第二个参数是可选的，用于控制列递增或递减的量：

Db::table('users')->increment('votes');

Db::table('users')->increment('votes', 5);

Db::table('users')->decrement('votes');

Db::table('users')->decrement('votes', 5);

你也可以在操作过程中指定要更新的字段：

Db::table('users')->increment('votes', 1, ['name' => 'John']);

删除

查询构造器也可以使用 delete 方法从表中删除记录。 在使用 delete 前，可以添加 where 子句来约束 delete 语法：

Db::table('users')->delete();

Db::table('users')->where('votes', '>', 100)->delete();

如果你需要清空表，你可以使用 truncate 方法，它将删除所有行，并重置自增 ID 为零：

Db::table('users')->truncate();

悲观锁

查询构造器也包含一些可以帮助你在 select 语法上实现「悲观锁定」的函数。若想在查询中实现一个「共享锁」， 你可以使用 sharedLock 方法。 共享锁可防止选中的数据列被篡改，直到事务被提交为止

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

或者，你可以使用 lockForUpdate 方法。使用「update」锁可避免行被其它共享锁修改或选取：

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