查询构建器

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

原始 SQL 示例

有时使用纯 SQL 执行查询会更合理, 你可以通过 Db::select 方法来完成此操作。

php

Db::select('select * from sometable where name = :name', ['name' => 'Charles']);

请参阅有关运行原生 SQL 查询的文章以获取更多信息。

检索结果

要开始一个流畅查询，在 Db 外观上使用 table 方法。table 方法返回一个针对给定表的流畅查询构建器实例，允许你将更多约束链式添加到查询中，然后最终获取结果。在此示例中，get 将从一个表返回所有记录。

php

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

类似于原始查询，get 方法返回一个 array 结果集，其中每个结果都是 PHP stdClass 对象的一个实例。你可以将列作为对象的属性来访问每个列的值。

php

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

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

php

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

echo $user->name;

提取值

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

php

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

如果您想检索一个包含单列值的数组，您可以使用 pluck 方法。在此示例中，我们将检索一个角色标题数组。

php

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

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

您还可以为返回的数组指定一个自定义的键列。

php

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

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

pluck 的结果将返回 Collection 对象，使其行为类似于数组。使用 all() 方法将其转换为 PHP 数组，例如，pluck('name')->all()。

分块结果

如果您需要处理数千条数据库记录，请考虑使用 chunk 方法。此方法一次检索一小“块”结果，并将每一块结果送入一个 Closure 进行处理。此方法对于编写控制台命令来处理数千条记录非常有用。例如，让我们以每次 100 条记录的块来处理整个 users 表。

php

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

您可以通过从 Closure 返回 false 来阻止进一步的数据块被处理。

php

Db::table('users')->chunk(100, function($users) {
    // Process the records...

    return false;
});

如果你在分块处理结果时更新数据库记录，你的分块结果可能会以意想不到的方式发生变化。因此，在分块处理时更新记录，最好始终使用 chunkById 方法。此方法将自动根据记录的主键对结果进行分页。

php

Db::table('users')->where('active', false)
    ->chunkById(100, function ($users) {
        foreach ($users as $user) {
            Db::table('users')
                ->where('id', $user->id)
                ->update(['active' => true]);
        }
    });

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

聚合函数

查询构建器还提供了多种聚合方法，例如 count、max、min、avg 和 sum。构建查询后，你可以调用这些方法中的任意一个：

php

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

$price = Db::table('orders')->max('price');

当然，你可以结合这些方法与其他子句来构建你的查询：

php

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

与其使用 count 方法来判断是否存在与查询约束匹配的记录，你可以使用 exists 和 doesntExist 方法：

php

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

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

SELECT 语句

在某些情况下，你可能不总是想从数据库表中选择所有列。使用 select 方法，你可以为该查询指定一个自定义的 select 子句。

php

$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::raw 方法。

php

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

另一个用途可能是将列和/或字符串拼接起来。

php

Db::raw("(first_name, ' ', last_name) as full_name");

原始语句将作为字符串注入到查询中，因此您应极其谨慎，以避免创建 SQL 注入漏洞。

原始方法

除了使用 Db::raw，您也可以使用以下方法将原始表达式插入到查询的不同部分。

此 selectRaw 方法可用于替代 addSelect(Db::raw(...)). 此方法接受一个可选的绑定数组作为其第二个参数:

php

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

whereRaw 和 orWhereRaw 方法可用于向你的查询中注入一个原始的 where 子句。这些方法接受一个可选的绑定数组作为它们的第二个参数：

php

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

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 方法可用于设置原始字符串作为 order by 子句的值：

php

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

该 groupByRaw 方法可用于将一个原始字符串设置为 group by 子句的值：

php

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

连接

查询构建器也可用于编写连接语句. 要执行基本的 SQL "内连接", 您可以使用查询构建器实例上的 join 方法. 传递给 join 方法的第一个参数是您需要连接的表的名称, 而其余参数指定连接的列约束. 当然, 正如您所见, 您可以在单个查询中连接多个表.

php

$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 方法。 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

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

高级连接语句

你也可以指定更高级的连接子句。若要开始，请将一个 Closure 作为第二个参数传递到 join 方法中。该 Closure 将接收一个 JoinClause 对象，它允许你在 join 子句上指定约束。

php

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

如果你希望在你的连接中使用“where”风格的子句，你可以使用一个连接上的 where 和 orWhere 方法。这些方法不会比较两列，而是会将该列与一个值进行比较。

php

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

子查询连接

你可以使用 joinSub, leftJoinSub, 和 rightJoinSub 方法将查询关联到子查询。这些方法都接收三个参数：子查询, 其表别名, 和一个定义关联列的 Closure：

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 ($join) {
        $join->on('users.id', '=', 'latest_posts.user_id');
    })->get();

联合体

查询构建器也提供了一种快速的方法来“合并”两个查询。例如，你可以创建一个初始查询，然后使用 union 方法将其与第二个查询合并。

php

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

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

unionAll 方法也可用，并且与 union 具有相同的方法签名。

Where 子句

要向查询添加 where 子句，请在查询构建器实例上使用 where 方法。对 where 最基本的调用需要三个参数。第一个参数是列名。第二个参数是一个运算符，它可以是数据库支持的任何运算符。第三个参数是用于针对列进行求值的值。

例如，这是一个查询，它验证了 "votes" 列的值等于 100。

php

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

为方便起见，如果您只想验证某列是否等于给定值，您可以将该值直接作为第二个参数传递给 where 方法。

php

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

您可以使用其他各种运算符在编写 where 子句时，例如，大于 >，不等于 <> 和 like。

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 约束，以及在查询中添加 or 子句。orWhere 方法接受与 where 方法相同的参数：

php

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

你还可以在下面的任何一个 where 语句方法前面加上 or, 使其成为“或”条件 - 例如, orWhereBetween, orWhereIn, etc.

搜索语句

searchWhere 和 orSearchWhere 方法可用于对列的值执行搜索查询。该方法将使用搜索词（第一个参数）和搜索列（第二个参数），通过不区分大小写的 like 查询，向查询中添加内容。

php

$pages = Db::table('posts')
    ->searchWhere('foo bar', ['title', 'content'])
    ->get();

上述示例将生成以下 SQL，其中每个列和值都 lower() 应用了它：

sql

select * from users where
    (title like '%foo%' and title like '%bar%') or
    (content like '%foo%' and content like '%bar%')

默认情况下，搜索词中的每个词都将被搜索，然而，您可以通过提供一个模式（第三个参数）来修改此行为，并支持以下模式。

全部：结果必须包含所有词语 (默认)
任意: 结果可包含任意词
确切：结果必须包含确切短语

php

$query->searchWhere('foo bar', ['title', 'content'], 'exact');

上述 exact 搜索示例将生成以下 SQL：

sql

select * from users where (title like '%foo bar%' or content like '%foo bar%')

复合 WHERE 子句

有时你可能需要创建更高级的 where 子句, 例如 "where exists" 或嵌套的参数分组. Laravel 查询构建器也能处理这些情况. 首先, 让我们看一个在括号中分组约束的示例:

php

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

如你所见，将 Closure 传入 orWhere 方法会指示查询构造器开始一个约束组。 Closure 将会接收到一个查询构造器实例，你可以使用它来设置应包含在括号组中的约束。上面的示例将会生成以下 SQL：

sql

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

存在语句

whereExists 方法允许您编写 where exist SQL 子句。 whereExists 方法接受一个 Closure 参数，该参数将接收一个查询构建器实例，使您能够定义应放置在 "exists" 子句中的查询：

php

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

上述查询将生成以下 SQL：

sql

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

JSON WHERE 语句

October CMS 也支持在提供 JSON 列类型支持的数据库上查询 JSON 列类型。要查询 JSON 列，使用 -> 运算符。

php

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

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

您可以使用 whereJsonContains 来查询 JSON 数组（SQLite 不支持）。

php

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

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 语句。你可以使用 when 方法实现这一点：

php

$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，此闭包将会执行。为了说明此功能的用法，我们将用它来配置查询的默认排序：

php

$sortBy = null;

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

排序, 分组, 限制

订购

orderBy 方法允许你根据给定列对查询结果进行排序。orderBy 方法的第一个参数应该是你希望排序的列，而第二个参数控制排序方向，并且可以是 asc 或 desc。

php

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

latest 和 oldest 方法允许您轻松地按日期排序结果。默认情况下，结果将按 created_at 列排序。或者，您可以传入您希望排序的列名。

php

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

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

php

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

分组

groupBy 和 having 方法可用于对查询结果进行分组。having 方法的签名与 where 方法的签名类似。

php

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

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

php

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

对于更高级的 having 语句，您可能希望使用 havingRaw 方法。

限制与偏移量

为了限制查询返回的结果数量，或者在查询中跳过给定数量的结果（OFFSET），您可以使用 skip 和 take 方法。

php

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

插入

查询构建器还提供了一个 insert 方法，用于将记录插入到数据库表中。insert 方法接受一个包含要插入的列名和值的数组：

php

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

你甚至可以通过传递一个数组的数组，使用一次对 insert 的调用向表中插入多条记录。每个数组代表一个要插入表中的行：

php

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

自增 ID

如果表格具有自增 ID，请使用 insertGetId 方法插入一条记录，然后获取该 ID：

php

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

当使用 PostgreSQL 数据库驱动时，insertGetId 方法期望自动递增列的名称为 id。如果你想从不同的"序列"中检索 ID，你可以将序列名称作为第二个参数传递给 insertGetId 方法。

更新

除了向数据库插入记录之外，查询构造器还可以使用 update 方法来更新现有记录。update 方法与 insert 方法类似，接受一个包含列和值对的数组，其中包含要更新的列。你可以使用 where 子句来约束 update 查询。

php

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

更新或插入

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

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

php

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

更新插入

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

php

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

除 SQL Server 外的所有数据库都要求 upsert 方法的第二个参数中的列具有“主键”或“唯一”索引。

更新 JSON 列

更新 JSON 列时，您应该使用 -> 语法来访问 JSON 对象中相应的键。MySQL 5.7+ 和 PostgreSQL 9.5+ 支持此操作：

php

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

递增 / 递减

查询构建器也提供了用于递增或递减给定列值的便捷方法。这仅仅是一个快捷方式，相比于手动编写 update 语句，它提供了一个更具表达性和简洁的接口。

这两种方法都接受至少一个参数：要修改的列。可以选择传入第二个参数以控制列的增加/减少量。

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

删除

查询构建器也可以用于通过 delete 方法从表中删除记录。

php

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

你可以通过在调用 delete 方法之前添加 where 子句来限制 delete 语句。

php

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

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

php

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

悲观锁

查询构建器也包含一些函数，帮助你在 select 语句上实现“悲观锁”。要使用“共享锁”运行语句，你可以在查询上使用 sharedLock 方法。共享锁会阻止被选中的行被修改，直到你的事务提交。

php

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

或者，你也可以使用 lockForUpdate 方法。 “for update”锁阻止这些行被修改或被另一个共享锁选中。

php

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

缓存查询

你可以使用缓存服务轻松缓存查询结果。只需在准备查询时链式调用 remember 或 rememberForever 方法。

php

$users = Db::table('users')->remember(10)->get();

在此示例中，查询结果将被缓存十分钟。当结果被缓存时，查询将不会针对数据库运行，并且结果将从为您的应用程序指定的默认缓存驱动器加载。

调试

你可以在构建查询时使用 dd 或 dump 方法来导出查询绑定和 SQL。该 dd 方法将显示调试信息，然后停止执行请求。该 dump 方法将显示调试信息，但允许请求继续执行：

php

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

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

另请参阅

Laravel 查询构建器

查询构建器

原始 SQL 示例

有时使用纯 SQL 执行查询会更合理, 你可以通过 Db::select 方法来完成此操作。

php

Db::select('select * from sometable where name = :name', ['name' => 'Charles']);

请参阅有关运行原生 SQL 查询的文章以获取更多信息。

检索结果

php

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

类似于原始查询，get 方法返回一个 array 结果集，其中每个结果都是 PHP stdClass 对象的一个实例。你可以将列作为对象的属性来访问每个列的值。

php

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

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

php

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

echo $user->name;

提取值

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

php

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

如果您想检索一个包含单列值的数组，您可以使用 pluck 方法。在此示例中，我们将检索一个角色标题数组。

php

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

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

您还可以为返回的数组指定一个自定义的键列。

php

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

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

pluck 的结果将返回 Collection 对象，使其行为类似于数组。使用 all() 方法将其转换为 PHP 数组，例如，pluck('name')->all()。

分块结果

php

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

您可以通过从 Closure 返回 false 来阻止进一步的数据块被处理。

php

Db::table('users')->chunk(100, function($users) {
    // Process the records...

    return false;
});

php

Db::table('users')->where('active', false)
    ->chunkById(100, function ($users) {
        foreach ($users as $user) {
            Db::table('users')
                ->where('id', $user->id)
                ->update(['active' => true]);
        }
    });

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

聚合函数

查询构建器还提供了多种聚合方法，例如 count、max、min、avg 和 sum。构建查询后，你可以调用这些方法中的任意一个：

php

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

$price = Db::table('orders')->max('price');

当然，你可以结合这些方法与其他子句来构建你的查询：

php

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

与其使用 count 方法来判断是否存在与查询约束匹配的记录，你可以使用 exists 和 doesntExist 方法：

php

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

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

SELECT 语句

在某些情况下，你可能不总是想从数据库表中选择所有列。使用 select 方法，你可以为该查询指定一个自定义的 select 子句。

php

$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::raw 方法。

php

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

另一个用途可能是将列和/或字符串拼接起来。

php

Db::raw("(first_name, ' ', last_name) as full_name");

原始语句将作为字符串注入到查询中，因此您应极其谨慎，以避免创建 SQL 注入漏洞。

原始方法

除了使用 Db::raw，您也可以使用以下方法将原始表达式插入到查询的不同部分。

此 selectRaw 方法可用于替代 addSelect(Db::raw(...)). 此方法接受一个可选的绑定数组作为其第二个参数:

php

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

whereRaw 和 orWhereRaw 方法可用于向你的查询中注入一个原始的 where 子句。这些方法接受一个可选的绑定数组作为它们的第二个参数：

php

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

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 方法可用于设置原始字符串作为 order by 子句的值：

php

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

该 groupByRaw 方法可用于将一个原始字符串设置为 group by 子句的值：

php

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

连接

php

$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 方法。 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

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

高级连接语句

php

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

php

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

子查询连接

你可以使用 joinSub, leftJoinSub, 和 rightJoinSub 方法将查询关联到子查询。这些方法都接收三个参数：子查询, 其表别名, 和一个定义关联列的 Closure：

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 ($join) {
        $join->on('users.id', '=', 'latest_posts.user_id');
    })->get();

联合体

查询构建器也提供了一种快速的方法来“合并”两个查询。例如，你可以创建一个初始查询，然后使用 union 方法将其与第二个查询合并。

php

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

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

unionAll 方法也可用，并且与 union 具有相同的方法签名。

Where 子句

例如，这是一个查询，它验证了 "votes" 列的值等于 100。

php

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

为方便起见，如果您只想验证某列是否等于给定值，您可以将该值直接作为第二个参数传递给 where 方法。

php

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

您可以使用其他各种运算符在编写 where 子句时，例如，大于 >，不等于 <> 和 like。

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 约束，以及在查询中添加 or 子句。orWhere 方法接受与 where 方法相同的参数：

php

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

你还可以在下面的任何一个 where 语句方法前面加上 or, 使其成为“或”条件 - 例如, orWhereBetween, orWhereIn, etc.

搜索语句

php

$pages = Db::table('posts')
    ->searchWhere('foo bar', ['title', 'content'])
    ->get();

上述示例将生成以下 SQL，其中每个列和值都 lower() 应用了它：

sql

select * from users where
    (title like '%foo%' and title like '%bar%') or
    (content like '%foo%' and content like '%bar%')

默认情况下，搜索词中的每个词都将被搜索，然而，您可以通过提供一个模式（第三个参数）来修改此行为，并支持以下模式。

全部：结果必须包含所有词语 (默认)
任意: 结果可包含任意词
确切：结果必须包含确切短语

php

$query->searchWhere('foo bar', ['title', 'content'], 'exact');

上述 exact 搜索示例将生成以下 SQL：

sql

select * from users where (title like '%foo bar%' or content like '%foo bar%')

复合 WHERE 子句

php

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

sql

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

存在语句

php

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

上述查询将生成以下 SQL：

sql

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

JSON WHERE 语句

October CMS 也支持在提供 JSON 列类型支持的数据库上查询 JSON 列类型。要查询 JSON 列，使用 -> 运算符。

php

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

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

您可以使用 whereJsonContains 来查询 JSON 数组（SQLite 不支持）。

php

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

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

条件子句

php

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

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

when 方法仅在第一个参数为 true 时执行给定的闭包。如果第一个参数为 false，则该闭包将不会被执行。

php

$sortBy = null;

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

排序, 分组, 限制

订购

php

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

latest 和 oldest 方法允许您轻松地按日期排序结果。默认情况下，结果将按 created_at 列排序。或者，您可以传入您希望排序的列名。

php

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

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

php

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

分组

groupBy 和 having 方法可用于对查询结果进行分组。having 方法的签名与 where 方法的签名类似。

php

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

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

php

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

对于更高级的 having 语句，您可能希望使用 havingRaw 方法。

限制与偏移量

为了限制查询返回的结果数量，或者在查询中跳过给定数量的结果（OFFSET），您可以使用 skip 和 take 方法。

php

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

插入

查询构建器还提供了一个 insert 方法，用于将记录插入到数据库表中。insert 方法接受一个包含要插入的列名和值的数组：

php

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

你甚至可以通过传递一个数组的数组，使用一次对 insert 的调用向表中插入多条记录。每个数组代表一个要插入表中的行：

php

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

自增 ID

如果表格具有自增 ID，请使用 insertGetId 方法插入一条记录，然后获取该 ID：

php

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

当使用 PostgreSQL 数据库驱动时，insertGetId 方法期望自动递增列的名称为 id。如果你想从不同的"序列"中检索 ID，你可以将序列名称作为第二个参数传递给 insertGetId 方法。

更新

php

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

更新或插入

php

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

更新插入

php

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

除 SQL Server 外的所有数据库都要求 upsert 方法的第二个参数中的列具有“主键”或“唯一”索引。

更新 JSON 列

更新 JSON 列时，您应该使用 -> 语法来访问 JSON 对象中相应的键。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']);

删除

查询构建器也可以用于通过 delete 方法从表中删除记录。

php

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

你可以通过在调用 delete 方法之前添加 where 子句来限制 delete 语句。

php

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

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

php

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

悲观锁

php

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

或者，你也可以使用 lockForUpdate 方法。 “for update”锁阻止这些行被修改或被另一个共享锁选中。

php

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

缓存查询

你可以使用缓存服务轻松缓存查询结果。只需在准备查询时链式调用 remember 或 rememberForever 方法。

php

$users = Db::table('users')->remember(10)->get();

在此示例中，查询结果将被缓存十分钟。当结果被缓存时，查询将不会针对数据库运行，并且结果将从为您的应用程序指定的默认缓存驱动器加载。

调试

php

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

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

另请参阅

Laravel 查询构建器

文档导航

查询构建器

原始 SQL 示例

检索结果

提取值

分块结果

聚合函数

SELECT 语句

原始表达式

原始方法

连接

高级连接语句

子查询连接

联合体

Where 子句

或语句

更多的 Where 语句

搜索语句

复合 WHERE 子句

存在语句

JSON WHERE 语句

条件子句

排序, 分组, 限制

订购

分组

限制与偏移量

插入

自增 ID

更新

更新或插入

更新插入

更新 JSON 列

递增 / 递减

删除

悲观锁

缓存查询

调试

另请参阅

查询构建器

原始 SQL 示例

检索结果

提取值

分块结果

聚合函数

SELECT 语句

原始表达式

原始方法

连接

高级连接语句

子查询连接

联合体

Where 子句

或语句

更多的 Where 语句

搜索语句

复合 WHERE 子句

存在语句

JSON WHERE 语句

条件子句

排序, 分组, 限制

订购

分组

限制与偏移量

插入

自增 ID

更新

更新或插入

更新插入

更新 JSON 列

递增 / 递减

删除

悲观锁

缓存查询

调试

另请参阅