資料庫：入門指南

簡介
- 組態設定
- 讀取和寫入連線
執行 SQL 查詢
資料庫交易
連接到資料庫 CLI
檢視您的資料庫
監控您的資料庫

簡介

幾乎每個現代網頁應用程式都與資料庫互動。Laravel 通過使用原始 SQL、流暢查詢建構器和 Eloquent ORM 在各種支援的資料庫上極其簡單地進行資料庫互動。目前，Laravel 提供對五種資料庫的官方支援：

MariaDB 10.3+（版本政策）
MySQL 5.7+（版本政策）
PostgreSQL 10.0+（版本政策）
SQLite 3.26.0+
SQL Server 2017+（版本政策）

此外，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 環境變數中：

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

預設情況下，SQLite 連線啟用外部鍵約束。如果您想要停用它們，您應該將 DB_FOREIGN_KEYS 環境變數設置為 false：

DB_FOREIGN_KEYS=false

Note

如果您使用 Laravel 安裝程式建立 Laravel 應用程式並選擇 SQLite 作為您的資料庫，Laravel 將自動建立一個 database/database.sqlite 檔案並為您執行預設的資料庫遷移。

Microsoft SQL Server 設定

若要使用 Microsoft SQL Server 資料庫，您應確保已安裝 sqlsrv 和 pdo_sqlsrv PHP 擴充功能，以及可能需要的任何相依性，如 Microsoft SQL ODBC 驅動程式。

使用 URL 進行設定

通常，資料庫連線是使用多個設定值配置的，如 host、database、username、password 等。每個這些設定值都有對應的環境變數。這意味著在正式伺服器上配置資料庫連線資訊時，您需要管理多個環境變數。

一些托管資料庫提供者，如 AWS 和 Heroku，提供了一個包含資料庫所有連線資訊的單一資料庫 "URL"。一個範例資料庫 URL 可能看起來像以下這樣：

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

這些 URL 通常遵循標準的架構約定：

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

為了方便起見，Laravel 支援這些 URL 作為配置資料庫的替代方案，而不是使用多個配置選項。如果存在 url（或對應的 DB_URL 環境變數）配置選項，將用於提取資料庫連線和憑證資訊。

讀取和寫入連線

有時您可能希望使用一個資料庫連線來進行 SELECT 語句，另一個用於 INSERT、UPDATE 和 DELETE 語句。Laravel 讓這變得輕而易舉，無論您使用原始查詢、查詢建構器還是 Eloquent ORM，都將始終使用正確的連線。

要查看如何配置讀取/寫入連線，讓我們看一下這個範例：

'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'),
    ]) : [],
],

請注意，已將三個鍵添加到配置陣列中：read、write 和 sticky。read 和 write 鍵具有包含單一鍵 host 的陣列值。read 和 write 連線的其餘資料庫選項將從主 mysql 配置陣列合併。

只有在希望覆蓋主 mysql 陣列中的值時，才需要將項目放在 read 和 write 陣列中。因此，在這種情況下，192.168.1.1 將用作 "read" 連線的主機，而 192.168.1.3 將用於 "write" 連線。主 mysql 陣列中的資料庫憑證、前綴、字元集和所有其他選項將在兩個連線之間共享。當 host 配置陣列中存在多個值時，將為每個請求隨機選擇一個資料庫主機。

`sticky` 選項

sticky 選項是一個可選值，可用於允許立即讀取在當前請求週期中寫入到數據庫的記錄。如果啟用了 sticky 選項並且在當前請求週期中對數據庫執行了 "寫入" 操作，任何進一步的 "讀取" 操作將使用 "寫入" 連接。這確保了在請求週期中寫入的任何數據可以立即從數據庫中讀取回來。您可以決定這是否是應用程式所需的行為。

執行 SQL 查詢

一旦您配置了數據庫連接，您可以使用 DB 門面運行查詢。DB 門面為每種類型的查詢提供方法：select、update、insert、delete 和 statement。

執行選擇查詢

要運行基本的 SELECT 查詢，您可以在 DB 門面上使用 select 方法：

<?php

namespace App\Http\Controllers;

use App\Http\Controllers\Controller;
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::select('select * from users where active = ?', [1]);

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

傳遞給 select 方法的第一個參數是 SQL 查詢，而第二個參數是需要綁定到查詢的任何參數綁定。通常，這些是 where 子句約束的值。參數綁定提供了對抗 SQL 注入的保護。

select 方法將始終返回一個結果的 array。數組中的每個結果將是一個 PHP stdClass 物件，代表來自數據庫的記錄：

use Illuminate\Support\Facades\DB;

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

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

選擇純量值

有時您的數據庫查詢可能導致單個純量值。 Laravel 允許您直接使用 scalar 方法檢索此值，而不需要從記錄對象中檢索查詢的純量結果：

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

選擇多個結果集

如果您的應用程序調用返回多個結果集的存儲過程，您可以使用 selectResultSets 方法檢索存儲過程返回的所有結果集：

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

使用命名綁定

不使用 ? 來表示參數綁定，您可以使用命名綁定來執行查詢：

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

執行插入語句

要執行 insert 語句，您可以在 DB Facade 上使用 insert 方法。與 select 類似，此方法將 SQL 查詢作為第一個參數並將綁定作為第二個參數：

use Illuminate\Support\Facades\DB;

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

執行更新語句

應使用 update 方法來更新資料庫中的現有記錄。該方法返回語句影響的行數：

use Illuminate\Support\Facades\DB;

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

執行刪除語句

應使用 delete 方法來從資料庫中刪除記錄。與 update 類似，該方法將返回受影響的行數：

use Illuminate\Support\Facades\DB;

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

執行一般語句

某些資料庫語句不會返回任何值。對於這些類型的操作，您可以在 DB Facade 上使用 statement 方法：

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

執行未準備的語句

有時您可能希望執行一個 SQL 語句而不綁定任何值。您可以使用 DB Facade 的 unprepared 方法來實現此目的：

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

Warning

由於未準備的語句不會綁定參數，因此可能會受到 SQL 注入的影響。永遠不要在未準備的語句中使用使用者可控的值。

隱含提交

在交易中使用 DB 門面的 statement 和 unprepared 方法時，您必須小心避免觸發隱含提交的語句。這些語句將導致資料庫引擎間接提交整個交易，使 Laravel 不知道資料庫的交易層級。一個例子是創建資料庫表的語句：

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

請參考 MySQL 手冊中所有觸發隱含提交的語句清單。

使用多個資料庫連線

如果您的應用程式在 config/database.php 組態檔中定義了多個連線，您可以通過 DB 門面提供的 connection 方法訪問每個連線。傳遞給 connection 方法的連線名應對應於 config/database.php 組態檔中列出的連線之一，或者在運行時使用 config 助手配置：

use Illuminate\Support\Facades\DB;

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

您可以使用連線實例上的 getPdo 方法訪問連線的原始 PDO 實例：

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

監聽查詢事件

如果您想為應用程式執行的每個 SQL 查詢指定一個閉包，您可以使用 DB 門面的 listen 方法。這個方法對於記錄查詢或進行調試非常有用。您可以在服務提供者的 boot 方法中註冊您的查詢監聽器閉包：

<?php

namespace App\Providers;

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

class AppServiceProvider extends ServiceProvider
{
    /**
     * Register any application services.
     */
    public function register(): void
    {
        // ...
    }

    /**
     * Bootstrap any application services.
     */
    public function boot(): void
    {
        DB::listen(function (QueryExecuted $query) {
            // $query->sql;
            // $query->bindings;
            // $query->time;
            // $query->toRawSql();
        });
    }
}

監控累計查詢時間

現代 Web 應用程式的常見性能瓶頸是它們在查詢資料庫時花費的時間。幸運的是，當 Laravel 在單個請求期間花費太多時間查詢資料庫時，您可以指定一個閉包或回呼函式。要開始，請提供一個查詢時間閾值（以毫秒為單位）和閉包給 whenQueryingForLongerThan 方法。您可以在服務提供者的 boot 方法中調用此方法：

<?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
{
    /**
     * Register any application services.
     */
    public function register(): void
    {
        // ...
    }

    /**
     * Bootstrap any application services.
     */
    public function boot(): void
    {
        DB::whenQueryingForLongerThan(500, function (Connection $connection, QueryExecuted $event) {
            // Notify development team...
        });
    }
}

資料庫交易

您可以使用DB Facades提供的transaction方法在資料庫交易中執行一組操作。如果在交易閉包中拋出異常，則交易將自動回滾並重新拋出異常。如果閉包成功執行，則交易將自動提交。在使用transaction方法時，您無需擔心手動回滾或提交：

use Illuminate\Support\Facades\DB;

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

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

處理死結

transaction方法接受一個可選的第二個引數，該引數定義了當發生死結時應重試交易的次數。一旦這些嘗試耗盡，將拋出異常：

use Illuminate\Support\Facades\DB;

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

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

手動使用交易

如果您想要手動開始一個交易並完全控制回滾和提交，您可以使用DB Facades提供的beginTransaction方法：

use Illuminate\Support\Facades\DB;

DB::beginTransaction();

您可以通過rollBack方法回滾交易：

DB::rollBack();

最後，您可以通過commit方法提交交易：

DB::commit();

Note

DB Facades的交易方法控制著查詢生成器和Eloquent ORM的交易。

連接到資料庫 CLI

如果您想要連接到資料庫的 CLI，您可以使用db Artisan 指令：

php artisan db

如果需要，您可以指定要連接到非默認連接的資料庫連接名稱：

php artisan db mysql

檢視您的資料庫

使用db:show和db:table Artisan 指令，您可以深入了解您的資料庫及其相關表格。要查看資料庫的概述，包括其大小、類型、開放連接數量以及表格摘要，您可以使用db:show指令：

php artisan db:show

您可以通過在命令中使用 --database 選項並提供數據庫連接名稱來指定要檢查的數據庫連接：

php artisan db:show --database=pgsql

如果您希望在命令的輸出中包含表格行數和數據庫視圖詳細信息，您可以分別提供 --counts 和 --views 選項。在大型數據庫中，檢索行數和視圖詳細信息可能會很慢：

php artisan db:show --counts --views

此外，您可以使用以下 Schema 方法來檢查您的數據庫：

use Illuminate\Support\Facades\Schema;

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

如果您想要檢查一個不是應用程序默認連接的數據庫連接，您可以使用 connection 方法：

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

表格概覽

如果您想要獲取數據庫中個別表格的概覽，您可以執行 db:table Artisan 命令。此命令提供了數據庫表格的一般概覽，包括其列、類型、屬性、鍵和索引：

php artisan db:table users

監控您的數據庫

使用 db:monitor Artisan 命令，您可以指示 Laravel 在您的數據庫管理的開放連接數超過指定數量時發送一個 Illuminate\Database\Events\DatabaseBusy 事件。

要開始，您應該安排 db:monitor 命令每分鐘運行。該命令接受您希望監控的數據庫連接配置名稱以及在發送事件之前應容忍的最大開放連接數：

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

僅安排此命令並不足以觸發通知警報，告知您開放連接數量。當命令遇到一個具有超出閾值的開放連接數的數據庫時，將會發送一個 DatabaseBusy 事件。您應該在應用程序的 AppServiceProvider 中聆聽此事件，以便向您或您的開發團隊發送通知：

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

/**
 * Bootstrap any application services.
 */
public function boot(): void
{
    Event::listen(function (DatabaseBusy $event) {
        Notification::route('mail', 'dev@example.com')
            ->notify(new DatabaseApproachingMaxConnections(
                $event->connectionName,
                $event->connections
            ));
    });
}

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

database.md

database.md

資料庫：入門指南

簡介

組態設定

SQLite 設定

Microsoft SQL Server 設定

使用 URL 進行設定

讀取和寫入連線

`sticky` 選項

執行 SQL 查詢

執行選擇查詢

選擇純量值

選擇多個結果集

使用命名綁定

執行插入語句

執行更新語句

執行刪除語句

執行一般語句

執行未準備的語句

隱含提交

使用多個資料庫連線

監聽查詢事件

監控累計查詢時間

資料庫交易

處理死結

手動使用交易

連接到資料庫 CLI

檢視您的資料庫

表格概覽

監控您的數據庫

Files

database.md

Latest commit

History

database.md

File metadata and controls

資料庫：入門指南

簡介

組態設定

SQLite 設定

Microsoft SQL Server 設定

使用 URL 進行設定

讀取和寫入連線

sticky 選項

執行 SQL 查詢

執行選擇查詢

選擇純量值

選擇多個結果集

使用命名綁定

執行插入語句

執行更新語句

執行刪除語句

執行一般語句

執行未準備的語句

隱含提交

使用多個資料庫連線

監聽查詢事件

監控累計查詢時間

資料庫交易

處理死結

手動使用交易

連接到資料庫 CLI

檢視您的資料庫

表格概覽

監控您的數據庫

`sticky` 選項