跳到内容

数据库:查询构建器

简介

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

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

exclamation

PDO 不支持绑定列名。因此,您永远不应该允许用户输入来指定查询引用的列名,包括“order by”列。

运行数据库查询

从表中检索所有行

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

<?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 对象的实例。您可以通过访问对象的属性来访问每个列的值

use Illuminate\Support\Facades\DB;
 
$users = DB::table('users')->get();
 
foreach ($users as $user) {
echo $user->name;
}
lightbulb

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

从表中检索单个行/列

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

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

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

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

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

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

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

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

检索列值列表

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

use Illuminate\Support\Facades\DB;
 
$titles = DB::table('users')->pluck('title');
 
foreach ($titles as $title) {
echo $title;
}

您可以通过为 pluck 方法提供第二个参数来指定结果集合应使用哪个列作为其键

$titles = DB::table('users')->pluck('title', 'name');
 
foreach ($titles as $name => $title) {
echo $title;
}

分块结果

如果需要处理数千条数据库记录,请考虑使用 DB 外观提供的 chunk 方法。此方法一次检索一小块结果,并将每个块输入到闭包中进行处理。例如,让我们一次检索 100 条记录的 users

use Illuminate\Support\Collection;
use Illuminate\Support\Facades\DB;
 
DB::table('users')->orderBy('id')->chunk(100, function (Collection $users) {
foreach ($users as $user) {
// ...
}
});

您可以通过从闭包返回 false 来停止进一步处理块

DB::table('users')->orderBy('id')->chunk(100, function (Collection $users) {
// Process the records...
 
return false;
});

如果在分块结果时更新数据库记录,您的分块结果可能会以意想不到的方式发生变化。如果您计划在分块时更新检索到的记录,最好始终使用 chunkById 方法。此方法将根据记录的主键自动分页结果

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

由于 chunkByIdlazyById 方法将它们自己的 “where” 条件添加到正在执行的查询中,因此您通常应该在闭包中逻辑分组您自己的条件

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,这允许您将结果作为单个流进行交互

use Illuminate\Support\Facades\DB;
 
DB::table('users')->orderBy('id')->lazy()->each(function (object $user) {
// ...
});

再次说明,如果您计划在迭代检索到的记录时更新它们,最好使用 lazyByIdlazyByIdDesc 方法。这些方法将根据记录的主键自动分页结果

DB::table('users')->where('active', false)
->lazyById()->each(function (object $user) {
DB::table('users')
->where('id', $user->id)
->update(['active' => true]);
});
exclamation

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

聚合

查询构建器还提供了各种方法来检索聚合值,如 countmaxminavgsum。在构造查询后,可以调用其中任何一个方法

use Illuminate\Support\Facades\DB;
 
$users = DB::table('users')->count();
 
$price = DB::table('orders')->max('price');

当然,您可以将这些方法与其他子句结合使用,以微调聚合值的计算方式

$price = DB::table('orders')
->where('finalized', 1)
->avg('price');

确定是否存在记录

您可以使用 existsdoesntExist 方法,而不是使用 count 方法来确定是否存在与查询的约束匹配的任何记录

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

Select 语句

指定 Select 子句

您可能并不总是希望从数据库表中选择所有列。使用 select 方法,您可以为查询指定自定义的 “select” 子句

use Illuminate\Support\Facades\DB;
 
$users = DB::table('users')
->select('name', 'email as user_email')
->get();

distinct 方法允许您强制查询返回不同的结果

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

如果您已经有查询构建器实例,并且希望将列添加到其现有的 select 子句中,可以使用 addSelect 方法

$query = DB::table('users')->select('name');
 
$users = $query->addSelect('age')->get();

原始表达式

有时您可能需要在查询中插入任意字符串。要创建原始字符串表达式,可以使用 DB 外观提供的 raw 方法

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

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

whereRaw / orWhereRaw

whereRaworWhereRaw 方法可用于将原始 "where" 子句注入到您的查询中。这些方法接受一个可选的绑定数组作为其第二个参数。

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

havingRaw / orHavingRaw

havingRaworHavingRaw 方法可用于提供一个原始字符串作为 "having" 子句的值。这些方法接受一个可选的绑定数组作为其第二个参数。

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

orderByRaw

orderByRaw 方法可用于提供一个原始字符串作为 "order by" 子句的值。

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

groupByRaw

groupByRaw 方法可用于提供一个原始字符串作为 group by 子句的值。

$orders = DB::table('orders')
->select('city', 'state')
->groupByRaw('city, state')
->get();

连接

Inner Join 子句

查询构建器还可用于向您的查询添加连接子句。要执行基本的 “inner join”,您可以在查询构建器实例上使用 join 方法。传递给 join 方法的第一个参数是您需要连接的表的名称,而其余参数则指定连接的列约束。您甚至可以在单个查询中连接多个表。

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

如果您想执行 “left join” 或 “right join” 而不是 “inner join”,请使用 leftJoinrightJoin 方法。这些方法具有与 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 方法来执行 “cross join”。交叉连接会在第一个表和被连接的表之间生成笛卡尔积。

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

高级 Join 子句

您还可以指定更高级的连接子句。首先,将一个闭包作为第二个参数传递给 join 方法。该闭包将接收一个 Illuminate\Database\Query\JoinClause 实例,允许您指定 "join" 子句的约束。

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

如果您想在连接中使用 "where" 子句,您可以使用 JoinClause 实例提供的 whereorWhere 方法。这些方法不是比较两个列,而是将该列与一个值进行比较。

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

子查询连接

您可以使用 joinSubleftJoinSubrightJoinSub 方法将查询连接到子查询。这些方法中的每一个都接收三个参数:子查询,它的表别名和一个定义相关列的闭包。在此示例中,我们将检索一个用户集合,其中每个用户记录还包含用户最近发布的博客文章的 created_at 时间戳。

$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 目前支持横向连接。

您可以使用 joinLateralleftJoinLateral 方法来执行带有子查询的 “横向连接”。这些方法中的每一个都接收两个参数:子查询及其表别名。连接条件应在给定子查询的 where 子句中指定。横向连接针对每一行进行评估,并且可以引用子查询之外的列。

在此示例中,我们将检索一个用户集合以及用户最近的三篇博客文章。每个用户可以在结果集中生成最多三行:每个用户最近的博客文章各一行。连接条件在子查询内使用 whereColumn 子句指定,引用当前用户行。

$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” 两个或多个查询。例如,您可以创建一个初始查询,并使用 union 方法将其与更多查询进行联合。

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 列的值等于 100age 列的值大于 35 的用户

$users = DB::table('users')
->where('votes', '=', 100)
->where('age', '>', 35)
->get();

为了方便起见,如果您想验证一个列是否 = 等于给定值,您可以将该值作为第二个参数传递给 where 方法。Laravel 将假定您想使用 = 运算符

$users = DB::table('users')->where('votes', 100)->get();

如前所述,您可以使用数据库系统支持的任何运算符

$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 方法的三个参数的数组。

$users = DB::table('users')->where([
['status', '=', '1'],
['subscribed', '<>', '1'],
])->get();
exclamation

PDO 不支持绑定列名。因此,您永远不应该允许用户输入来指定查询引用的列名,包括“order by”列。

exclamation

在字符串数字比较中,MySQL 和 MariaDB 会自动将字符串类型转换为整数。在此过程中,非数字字符串会被转换为 0,这可能会导致意外的结果。例如,如果您的表有一个值为 aaasecret 列,并且您运行 User::where('secret', 0),则会返回该行。为了避免这种情况,请确保在查询中使用所有值之前将其强制转换为适当的类型。

Or Where 子句

当将对查询构建器的 where 方法的调用链接在一起时,“where” 子句将使用 and 运算符连接在一起。但是,您可以使用 orWhere 方法使用 or 运算符将子句连接到查询。orWhere 方法接受与 where 方法相同的参数

$users = DB::table('users')
->where('votes', '>', 100)
->orWhere('name', 'John')
->get();

如果您需要在括号内对 “or” 条件进行分组,则可以将闭包作为第一个参数传递给 orWhere 方法。

$users = DB::table('users')
->where('votes', '>', 100)
->orWhere(function (Builder $query) {
$query->where('name', 'Abigail')
->where('votes', '>', 50);
})
->get();

上面的示例将生成以下 SQL

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

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

Where Not 子句

whereNotorWhereNot 方法可用于否定给定的查询约束组。例如,以下查询排除了正在清仓销售或价格低于 10 的产品

$products = DB::table('products')
->whereNot(function (Builder $query) {
$query->where('clearance', true)
->orWhere('price', '<', 10);
})
->get();

Where Any / All / None 子句

有时您可能需要将相同的查询约束应用于多个列。例如,您可能想要检索给定列表中任何列都 LIKE 给定值的所有记录。您可以使用 whereAny 方法完成此操作

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

上面的查询将导致以下 SQL

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

类似地,whereAll 方法可用于检索给定列都匹配给定约束的记录。

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

上面的查询将导致以下 SQL

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

whereNone 方法可用于检索给定列均不匹配给定约束的记录。

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

上面的查询将导致以下 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 列,请使用 -> 运算符

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

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

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

如果您的应用程序使用 MariaDB,MySQL 或 PostgreSQL 数据库,则可以将值数组传递给 whereJsonContains 方法

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

您可以使用 whereJsonLength 方法按长度查询 JSON 数组

$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" 子句以进行模式匹配。这些方法提供了一种与数据库无关的方式来执行字符串匹配查询,并且可以切换大小写敏感性。默认情况下,字符串匹配不区分大小写。

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

您可以通过 caseSensitive 参数启用区分大小写的搜索

$users = DB::table('users')
->whereLike('name', '%John%', caseSensitive: true)
->get();

orWhereLike 方法允许您添加带有 LIKE 条件的 “or” 子句

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

whereNotLike 方法允许您向查询添加 "NOT LIKE" 子句

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

类似地,您可以使用 orWhereNotLike 添加带有 NOT LIKE 条件的 “or” 子句

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

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

whereIn / whereNotIn / orWhereIn / orWhereNotIn

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

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

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

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

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

$activeUsers = DB::table('users')->select('id')->where('is_active', 1);
 
$users = DB::table('comments')
->whereIn('user_id', $activeUsers)
->get();

上面的示例将生成以下 SQL

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

如果要向查询添加大量的整数绑定数组,则可以使用 whereIntegerInRawwhereIntegerNotInRaw 方法来大大减少内存使用量。

whereBetween / orWhereBetween

whereBetween 方法验证列的值是否在两个值之间

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

whereNotBetween / orWhereNotBetween

whereNotBetween 方法验证列的值是否在两个值之外

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

whereBetweenColumns / whereNotBetweenColumns / orWhereBetweenColumns / orWhereNotBetweenColumns

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

$patients = DB::table('patients')
->whereBetweenColumns('weight', ['minimum_allowed_weight', 'maximum_allowed_weight'])
->get();

whereNotBetweenColumns 方法验证列的值是否在同一表行中两个列的两个值之外

$patients = DB::table('patients')
->whereNotBetweenColumns('weight', ['minimum_allowed_weight', 'maximum_allowed_weight'])
->get();

whereNull / whereNotNull / orWhereNull / orWhereNotNull

whereNull 方法验证给定列的值是否为 NULL

$users = DB::table('users')
->whereNull('updated_at')
->get();

whereNotNull 方法验证列的值是否不为 NULL

$users = DB::table('users')
->whereNotNull('updated_at')
->get();

whereDate / whereMonth / whereDay / whereYear / whereTime

whereDate 方法可用于将列的值与日期进行比较。

$users = DB::table('users')
->whereDate('created_at', '2016-12-31')
->get();

whereMonth 方法可用于将列的值与特定月份进行比较。

$users = DB::table('users')
->whereMonth('created_at', '12')
->get();

whereDay 方法可用于将列的值与该月的特定日期进行比较。

$users = DB::table('users')
->whereDay('created_at', '31')
->get();

whereYear 方法可用于将列的值与特定年份进行比较。

$users = DB::table('users')
->whereYear('created_at', '2016')
->get();

whereTime 方法可用于将列的值与特定时间进行比较。

$users = DB::table('users')
->whereTime('created_at', '=', '11:20:45')
->get();

whereColumn / orWhereColumn

whereColumn 方法可用于验证两个列是否相等。

$users = DB::table('users')
->whereColumn('first_name', 'last_name')
->get();

您还可以将比较运算符传递给 whereColumn 方法。

$users = DB::table('users')
->whereColumn('updated_at', '>', 'created_at')
->get();

您还可以将列比较数组传递给 whereColumn 方法。这些条件将使用 and 运算符连接。

$users = DB::table('users')
->whereColumn([
['first_name', '=', 'last_name'],
['updated_at', '>', 'created_at'],
])->get();

逻辑分组

有时,您可能需要在括号中对多个 “where” 子句进行分组,以实现查询所需的逻辑分组。实际上,为了避免意外的查询行为,您通常应该始终在括号中对 orWhere 方法的调用进行分组。要实现此目的,您可以将闭包传递给 where 方法。

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

如您所见,将闭包传递给 where 方法会指示查询构建器开始一个约束组。闭包将接收一个查询构建器实例,您可以使用该实例设置应包含在括号组内的约束。上面的示例将生成以下 SQL:

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

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

高级 Where 子句

Where Exists 子句

whereExists 方法允许您编写 “where exists” SQL 子句。whereExists 方法接受一个闭包,该闭包将接收一个查询构建器实例,允许您定义应放置在 “exists” 子句内的查询。

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

或者,您可以将查询对象传递给 whereExists 方法,而不是闭包。

$orders = DB::table('orders')
->select(DB::raw(1))
->whereColumn('orders.user_id', 'users.id');
 
$users = DB::table('users')
->whereExists($orders)
->get();

上面的两个示例都将生成以下 SQL:

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

子查询 Where 子句

有时,您可能需要构造一个 “where” 子句,该子句将子查询的结果与给定值进行比较。您可以通过将闭包和值传递给 where 方法来实现此目的。例如,以下查询将检索具有给定类型的最新“membership”的所有用户;

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 方法来实现此目的。例如,以下查询将检索所有金额小于平均值的收入记录;

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

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

whereFullTextorWhereFullText 方法可用于将全文 “where” 子句添加到具有全文索引的列的查询中。这些方法将被 Laravel 转换为底层数据库系统的适当 SQL。例如,将为使用 MariaDB 或 MySQL 的应用程序生成 MATCH AGAINST 子句。

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

排序、分组、限制和偏移

排序

orderBy 方法

orderBy 方法允许您按给定列对查询结果进行排序。orderBy 方法接受的第一个参数应该是您要排序的列,而第二个参数确定排序的方向,可以是 ascdesc

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

要按多个列排序,您只需根据需要多次调用 orderBy

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

latestoldest 方法

latestoldest 方法允许您轻松地按日期对结果进行排序。默认情况下,结果将按表的 created_at 列排序。或者,您可以传递要排序的列名。

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

随机排序

inRandomOrder 方法可用于随机排序查询结果。例如,您可以使用此方法来获取随机用户。

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

删除现有排序

reorder 方法会删除先前应用于查询的所有 “order by” 子句。

$query = DB::table('users')->orderBy('name');
 
$unorderedUsers = $query->reorder()->get();

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

$query = DB::table('users')->orderBy('name');
 
$usersOrderedByEmail = $query->reorder('email', 'desc')->get();

分组

groupByhaving 方法

正如您可能预期的那样,groupByhaving 方法可用于对查询结果进行分组。having 方法的签名类似于 where 方法的签名。

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

您可以使用 havingBetween 方法来筛选给定范围内的结果。

$report = DB::table('orders')
->selectRaw('count(id) as number_of_orders, customer_id')
->groupBy('customer_id')
->havingBetween('number_of_orders', [5, 15])
->get();

您可以将多个参数传递给 groupBy 方法以按多个列进行分组。

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

要构建更高级的 having 语句,请参阅 havingRaw 方法。

限制和偏移

skiptake 方法

您可以使用 skiptake 方法来限制从查询返回的结果数,或跳过查询中给定数量的结果。

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

或者,您可以使用 limitoffset 方法。这些方法在功能上分别与 takeskip 方法等效。

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

条件子句

有时,您可能希望某些查询子句基于其他条件应用于查询。例如,您可能只想在传入的 HTTP 请求中存在给定输入值时才应用 where 语句。您可以使用 when 方法来实现此目的。

$role = $request->input('role');
 
$users = DB::table('users')
->when($role, function (Builder $query, string $role) {
$query->where('role_id', $role);
})
->get();

仅当第一个参数为 true 时,when 方法才会执行给定的闭包。如果第一个参数为 false,则不会执行闭包。因此,在上面的示例中,只有当 role 字段存在于传入的请求中并且计算结果为 true 时,才会调用传递给 when 方法的闭包。

您可以将另一个闭包作为第三个参数传递给 when 方法。只有当第一个参数的计算结果为 false 时,才会执行此闭包。为了说明如何使用此功能,我们将使用它来配置查询的默认排序。

$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 方法接受列名和值的数组。

DB::table('users')->insert([
'email' => '[email protected]',
'votes' => 0
]);

您可以通过传递数组的数组来一次插入多条记录。每个数组表示应插入到表中的记录。

DB::table('users')->insert([
['email' => '[email protected]', 'votes' => 0],
['email' => '[email protected]', 'votes' => 0],
]);

insertOrIgnore 方法将在将记录插入数据库时忽略错误。使用此方法时,您应该注意,将忽略重复的记录错误,并且根据数据库引擎的不同,也可能忽略其他类型的错误。例如,insertOrIgnore绕过 MySQL 的严格模式

DB::table('users')->insertOrIgnore([
['id' => 1, 'email' => '[email protected]'],
['id' => 2, 'email' => '[email protected]'],
]);

insertUsing 方法将新记录插入表中,同时使用子查询来确定应插入的数据。

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。

$id = DB::table('users')->insertGetId(
['email' => '[email protected]', 'votes' => 0]
);
exclamation

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

Upsert

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

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

在上面的示例中,Laravel 将尝试插入两条记录。如果已存在具有相同 departuredestination 列值的记录,则 Laravel 将更新该记录的 price 列。

exclamation

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

Update 语句

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

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

更新或插入

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

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

DB::table('users')
->updateOrInsert(
['email' => '[email protected]', 'name' => 'John'],
['votes' => '2']
);

您可以向 updateOrInsert 方法提供一个闭包,以根据匹配记录的存在情况自定义更新或插入到数据库的属性。

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+ 支持此操作。

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

递增和递减

查询构建器还提供了便捷的方法来递增或递减给定列的值。这两个方法都接受至少一个参数:要修改的列。可以提供第二个参数来指定列应递增或递减的数量。

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

此外,您可以使用 incrementEachdecrementEach 方法一次递增或递减多个列。

DB::table('users')->incrementEach([
'votes' => 5,
'balance' => 100,
]);

Delete 语句

查询构建器的 delete 方法可用于从表中删除记录。 delete 方法返回受影响的行数。您可以在调用 delete 方法之前添加 "where" 子句来约束 delete 语句。

$deleted = DB::table('users')->delete();
 
$deleted = DB::table('users')->where('votes', '>', 100)->delete();

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

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

表截断和 PostgreSQL

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

悲观锁

查询构建器还包括一些函数,可帮助您在执行 select 语句时实现“悲观锁定”。要使用“共享锁”执行语句,您可以调用 sharedLock 方法。共享锁会阻止在您的事务提交之前修改选定的行。

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

或者,您可以使用 lockForUpdate 方法。“for update”锁会阻止修改选定的记录,或者使用另一个共享锁选择这些记录。

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

调试

您可以在构建查询时使用 dddump 方法来转储当前的查询绑定和 SQL。dd 方法将显示调试信息,然后停止执行请求。dump 方法将显示调试信息,但允许请求继续执行。

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

可以在查询上调用 dumpRawSqlddRawSql 方法,以转储查询的 SQL,并正确替换所有参数绑定。

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