Skip to content

数据库:入门指南

介绍

几乎每个现代 web 应用程序都与数据库交互。Laravel 通过原始 SQL、流式查询构建器Eloquent ORM 使与数据库的交互变得极其简单。目前,Laravel 为五种数据库提供了第一方支持:

此外,MongoDB 通过 mongodb/laravel-mongodb 包获得支持,该包由 MongoDB 官方维护。有关更多信息,请查看 Laravel MongoDB 文档。

配置

Laravel 的数据库服务配置位于您应用程序的 config/database.php 配置文件中。在此文件中,您可以定义所有数据库连接,并指定默认使用哪个连接。此文件中的大多数配置选项由您应用程序的环境变量值驱动。此文件中提供了大多数 Laravel 支持的数据库系统的示例。

默认情况下,Laravel 的示例 环境配置 已准备好与 Laravel Sail 一起使用,这是一个用于在本地计算机上开发 Laravel 应用程序的 Docker 配置。但是,您可以根据需要修改数据库配置以适应您的本地数据库。

SQLite 配置

SQLite 数据库包含在文件系统中的单个文件中。您可以使用终端中的 touch 命令创建新的 SQLite 数据库:touch database/database.sqlite。创建数据库后,您可以轻松配置环境变量以指向此数据库,通过将数据库的绝对路径放入 DB_DATABASE 环境变量中:

ini
DB_CONNECTION=sqlite
DB_DATABASE=/absolute/path/to/database.sqlite

默认情况下,SQLite 连接的外键约束是启用的。如果您希望禁用它们,您应该将 DB_FOREIGN_KEYS 环境变量设置为 false

ini
DB_FOREIGN_KEYS=false
lightbulb

如果您使用 Laravel 安装程序 创建 Laravel 应用程序并选择 SQLite 作为数据库,Laravel 将自动创建 database/database.sqlite 文件并为您运行默认的 数据库迁移

Microsoft SQL Server 配置

要使用 Microsoft SQL Server 数据库,您应确保已安装 sqlsrvpdo_sqlsrv PHP 扩展以及它们可能需要的任何依赖项,例如 Microsoft SQL ODBC 驱动程序。

使用 URL 配置

通常,数据库连接是使用多个配置值进行配置的,例如 hostdatabaseusernamepassword 等。每个配置值都有其对应的环境变量。这意味着在生产服务器上配置数据库连接信息时,您需要管理多个环境变量。

一些托管数据库提供商,例如 AWS 和 Heroku,提供一个包含所有连接信息的单一数据库“URL”。示例数据库 URL 可能如下所示:

html
mysql://root:password@127.0.0.1/forge?charset=UTF-8

这些 URL 通常遵循标准的模式约定:

html
driver://username:password@host:port/database?options

为了方便起见,Laravel 支持将这些 URL 作为配置数据库的替代方案,而不是使用多个配置选项。如果存在 url(或相应的 DB_URL 环境变量)配置选项,它将用于提取数据库连接和凭据信息。

读写连接

有时您可能希望使用一个数据库连接进行 SELECT 语句,而使用另一个连接进行 INSERT、UPDATE 和 DELETE 语句。Laravel 使这变得轻而易举,无论您使用原始查询、查询构建器还是 Eloquent ORM,都会始终使用正确的连接。

要查看如何配置读/写连接,让我们看一下这个示例:

php
'mysql' => [
    'read' => [
        'host' => [
            '192.168.1.1',
            '196.168.1.2',
        ],
    ],
    'write' => [
        'host' => [
            '196.168.1.3',
        ],
    ],
    'sticky' => true,

    'database' => env('DB_DATABASE', 'laravel'),
    'username' => env('DB_USERNAME', 'root'),
    'password' => env('DB_PASSWORD', ''),
    'unix_socket' => env('DB_SOCKET', ''),
    'charset' => env('DB_CHARSET', 'utf8mb4'),
    'collation' => env('DB_COLLATION', 'utf8mb4_unicode_ci'),
    'prefix' => '',
    'prefix_indexes' => true,
    'strict' => true,
    'engine' => null,
    'options' => extension_loaded('pdo_mysql') ? array_filter([
        PDO::MYSQL_ATTR_SSL_CA => env('MYSQL_ATTR_SSL_CA'),
    ]) : [],
],

请注意,配置数组中添加了三个键:readwritestickyreadwrite 键具有包含单个键 host 的数组值。readwrite 连接的其余数据库选项将从主 mysql 配置数组中合并。

您只需在 readwrite 数组中放置项目,如果您希望覆盖主 mysql 数组中的值。因此,在这种情况下,192.168.1.1 将用作“读”连接的主机,而 192.168.1.3 将用作“写”连接的主机。主 mysql 数组中的数据库凭据、前缀、字符集和所有其他选项将在两个连接之间共享。当 host 配置数组中存在多个值时,将随机选择一个数据库主机进行每个请求。

sticky 选项

sticky 选项是一个可选值,可用于允许在当前请求周期内立即读取已写入数据库的记录。如果启用 sticky 选项,并且在当前请求周期内对数据库执行了“写”操作,则任何后续的“读”操作将使用“写”连接。这确保在同一请求中可以立即读取在请求周期内写入的数据。您可以决定这是否是您应用程序所需的行为。

运行 SQL 查询

配置好数据库连接后,您可以使用 DB facade 运行查询。DB facade 提供了每种类型查询的方法:selectupdateinsertdeletestatement

运行选择查询

要运行基本的 SELECT 查询,您可以在 DB facade 上使用 select 方法:

php
<?php

namespace App\Http\Controllers;

use App\Http\Controllers\Controller;
use Illuminate\Support\Facades\DB;
use Illuminate\View\View;

class UserController extends Controller
{
    /**
     * 显示应用程序所有用户的列表。
     */
    public function index(): View
    {
        $users = DB::select('select * from users where active = ?', [1]);

        return view('user.index', ['users' => $users]);
    }
}

传递给 select 方法的第一个参数是 SQL 查询,第二个参数是需要绑定到查询的任何参数绑定。通常,这些是 where 子句约束的值。参数绑定提供了对 SQL 注入的保护。

select 方法将始终返回一个结果的 array。数组中的每个结果都是一个 PHP stdClass 对象,表示数据库中的一条记录:

php
use Illuminate\Support\Facades\DB;

$users = DB::select('select * from users');

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

选择标量值

有时您的数据库查询可能会返回一个单一的标量值。Laravel 允许您直接使用 scalar 方法检索此值,而不必从记录对象中检索查询的标量结果:

php
$burgers = DB::scalar(
    "select count(case when food = 'burger' then 1 end) as burgers from menu"
);

选择多个结果集

如果您的应用程序调用返回多个结果集的存储过程,您可以使用 selectResultSets 方法检索存储过程返回的所有结果集:

php
[$options, $notifications] = DB::selectResultSets(
    "CALL get_user_options_and_notifications(?)", $request->user()->id
);

使用命名绑定

您可以使用命名绑定执行查询,而不是使用 ? 来表示您的参数绑定:

php
$results = DB::select('select * from users where id = :id', ['id' => 1]);

运行插入语句

要执行 insert 语句,您可以在 DB facade 上使用 insert 方法。与 select 一样,此方法接受 SQL 查询作为第一个参数,绑定作为第二个参数:

php
use Illuminate\Support\Facades\DB;

DB::insert('insert into users (id, name) values (?, ?)', [1, 'Marc']);

运行更新语句

update 方法应用于更新数据库中的现有记录。该方法将返回受语句影响的行数:

php
use Illuminate\Support\Facades\DB;

$affected = DB::update(
    'update users set votes = 100 where name = ?',
    ['Anita']
);

运行删除语句

delete 方法应用于从数据库中删除记录。与 update 一样,受影响的行数将由该方法返回:

php
use Illuminate\Support\Facades\DB;

$deleted = DB::delete('delete from users');

运行一般语句

某些数据库语句不返回任何值。对于这些类型的操作,您可以在 DB facade 上使用 statement 方法:

php
DB::statement('drop table users');

运行未准备的语句

有时您可能希望执行 SQL 语句而不绑定任何值。您可以使用 DB facade 的 unprepared 方法来实现这一点:

php
DB::unprepared('update users set votes = 100 where name = "Dries"');
exclamation

由于未准备的语句不绑定参数,因此可能会受到 SQL 注入的攻击。您绝不应允许用户控制的值出现在未准备的语句中。

隐式提交

在事务中使用 DB facade 的 statementunprepared 方法时,必须小心避免导致 隐式提交 的语句。这些语句将导致数据库引擎间接提交整个事务,使 Laravel 无法了解数据库的事务级别。此类语句的示例是创建数据库表:

php
DB::unprepared('create table a (col varchar(1) null)');

请参考 MySQL 手册以获取 触发隐式提交的所有语句的列表

使用多个数据库连接

如果您的应用程序在 config/database.php 配置文件中定义了多个连接,您可以通过 DB facade 提供的 connection 方法访问每个连接。传递给 connection 方法的连接名称应对应于 config/database.php 配置文件中列出的连接之一,或使用 config 辅助函数在运行时配置:

php
use Illuminate\Support\Facades\DB;

$users = DB::connection('sqlite')->select(/* ... */);

您可以使用连接实例上的 getPdo 方法访问连接的原始底层 PDO 实例:

php
$pdo = DB::connection()->getPdo();

监听查询事件

如果您希望为应用程序执行的每个 SQL 查询指定一个闭包,可以使用 DB facade 的 listen 方法。此方法对于记录查询或调试非常有用。您可以在 服务提供者boot 方法中注册查询监听器闭包:

php
<?php

namespace App\Providers;

use Illuminate\Database\Events\QueryExecuted;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\ServiceProvider;

class AppServiceProvider extends ServiceProvider
{
    /**
     * 注册任何应用程序服务。
     */
    public function register(): void
    {
        // ...
    }

    /**
     * 启动任何应用程序服务。
     */
    public function boot(): void
    {
        DB::listen(function (QueryExecuted $query) {
            // $query->sql;
            // $query->bindings;
            // $query->time;
            // $query->toRawSql();
        });
    }
}

监控累积查询时间

现代 web 应用程序的一个常见性能瓶颈是它们在单个请求中查询数据库所花费的时间。幸运的是,Laravel 可以在单个请求中花费过多时间查询数据库时调用您选择的闭包或回调。要开始,请提供查询时间阈值(以毫秒为单位)和闭包到 whenQueryingForLongerThan 方法。您可以在 服务提供者boot 方法中调用此方法:

php
<?php

namespace App\Providers;

use Illuminate\Database\Connection;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\ServiceProvider;
use Illuminate\Database\Events\QueryExecuted;

class AppServiceProvider extends ServiceProvider
{
    /**
     * 注册任何应用程序服务。
     */
    public function register(): void
    {
        // ...
    }

    /**
     * 启动任何应用程序服务。
     */
    public function boot(): void
    {
        DB::whenQueryingForLongerThan(500, function (Connection $connection, QueryExecuted $event) {
            // 通知开发团队...
        });
    }
}

数据库事务

您可以使用 DB facade 提供的 transaction 方法在数据库事务中运行一组操作。如果在事务闭包内抛出异常,事务将自动回滚,并重新抛出异常。如果闭包成功执行,事务将自动提交。使用 transaction 方法时,您无需担心手动回滚或提交:

php
use Illuminate\Support\Facades\DB;

DB::transaction(function () {
    DB::update('update users set votes = 1');

    DB::delete('delete from posts');
});

处理死锁

transaction 方法接受一个可选的第二个参数,该参数定义在发生死锁时应重试事务的次数。一旦这些尝试用尽,将抛出异常:

php
use Illuminate\Support\Facades\DB;

DB::transaction(function () {
    DB::update('update users set votes = 1');

    DB::delete('delete from posts');
}, 5);

手动使用事务

如果您希望手动开始事务并完全控制回滚和提交,您可以使用 DB facade 提供的 beginTransaction 方法:

php
use Illuminate\Support\Facades\DB;

DB::beginTransaction();

您可以通过 rollBack 方法回滚事务:

php
DB::rollBack();

最后,您可以通过 commit 方法提交事务:

php
DB::commit();
lightbulb

DB facade 的事务方法控制 查询构建器Eloquent ORM 的事务。

连接到数据库 CLI

如果您希望连接到数据库的 CLI,您可以使用 db Artisan 命令:

shell
php artisan db

如果需要,您可以指定数据库连接名称,以连接到非默认连接的数据库:

shell
php artisan db mysql

检查您的数据库

使用 db:showdb:table Artisan 命令,您可以获得有关数据库及其相关表的有价值的见解。要查看数据库的概述,包括其大小、类型、打开连接的数量以及表的摘要,您可以使用 db:show 命令:

shell
php artisan db:show

您可以通过提供数据库连接名称来指定要检查的数据库连接,使用 --database 选项:

shell
php artisan db:show --database=pgsql

如果您希望在命令的输出中包含表行计数和数据库视图详细信息,您可以分别提供 --counts--views 选项。在大型数据库上,检索行计数和视图详细信息可能会很慢:

shell
php artisan db:show --counts --views

此外,您可以使用以下 Schema 方法检查您的数据库:

php
use Illuminate\Support\Facades\Schema;

$tables = Schema::getTables();
$views = Schema::getViews();
$columns = Schema::getColumns('users');
$indexes = Schema::getIndexes('users');
$foreignKeys = Schema::getForeignKeys('users');

如果您希望检查非应用程序默认连接的数据库,您可以使用 connection 方法:

php
$columns = Schema::connection('sqlite')->getColumns('users');

表概述

如果您希望获取数据库中单个表的概述,您可以执行 db:table Artisan 命令。此命令提供数据库表的一般概述,包括其列、类型、属性、键和索引:

shell
php artisan db:table users

监控您的数据库

使用 db:monitor Artisan 命令,您可以指示 Laravel 在数据库管理的打开连接超过指定数量时调度 Illuminate\Database\Events\DatabaseBusy 事件。

要开始,您应该安排 db:monitor 命令以 每分钟运行。该命令接受您希望监控的数据库连接配置的名称以及在调度事件之前应容忍的最大打开连接数:

shell
php artisan db:monitor --databases=mysql,pgsql --max=100

仅调度此命令不足以触发通知,提醒您打开连接的数量。当命令遇到打开连接计数超过阈值的数据库时,将调度 DatabaseBusy 事件。您应该在应用程序的 AppServiceProvider 中监听此事件,以便向您或开发团队发送通知:

php
use App\Notifications\DatabaseApproachingMaxConnections;
use Illuminate\Database\Events\DatabaseBusy;
use Illuminate\Support\Facades\Event;
use Illuminate\Support\Facades\Notification;

/**
 * 启动任何应用程序服务。
 */
public function boot(): void
{
    Event::listen(function (DatabaseBusy $event) {
        Notification::route('mail', 'dev@example.com')
                ->notify(new DatabaseApproachingMaxConnections(
                    $event->connectionName,
                    $event->connections
                ));
    });
}