データベース：利用開始 5.1 Laravel

イントロダクション

LaravelはたとえSQLを直接使用する場合でも、FluentクエリービルダーやEloquent ORMを使う時でも、データベースとの接続、クエリーの実行をとても簡単にしてくれます。現在、Laravelは以下のデータベースシステムを使用しています。

MySQL
Postgres
SQLite
SQL Server

設定

Laravelはデータベースとの接続、クエリーの実行をとても簡単にしてくれます。データベース設定ファイルはconfig/database.phpです。このファイルで使用するデータベース接続を全部定義すると同時に、デフォルトで使用する接続も指定してください。サポートしている全データベースシステムの例がファイルの中に用意しています。

デフォルトでLaravelのサンプル環境設定は、ローカルマシーン上でLaravelでの開発を行うのに便利な仮想マシーンであるLaravel Homestead用に設定してあります。もちろん、ローカルのデータベースに合わせるため、自由に変更してくだい。

Read／Write接続

SELECT文に別のデータベース接続を利用したい場合もあると思います。INSERT、UPDATE、DELETE文では他の接続に切り替えたい場合などです。Laravelでこれを簡単に実現できます。SQLをそのまま使う場合であろうと、クエリービルダーやEloquent ORMを利用する場合であろうと、適切な接続が利用されます。

Read/Write接続を理解してもらうため、以下の例をご覧ください。

'mysql' => [
    'read' => [
        'host' => '192.168.1.1',
    ],
    'write' => [
        'host' => '196.168.1.2'
    ],
    'driver'    => 'mysql',
    'database'  => 'database',
    'username'  => 'root',
    'password'  => '',
    'charset'   => 'utf8',
    'collation' => 'utf8_unicode_ci',
    'prefix'    => '',
],

設定配列にreadとwrite、２つのキーが追加されたことに注目して下さい。２つのキーともhostというキーを一つ持っています。readとwrite接続時の残りのデータベースオプションは、メインのmysql配列からマージされます。

ですから、readとwriteの配列には、メインの配列の値をオーバーライドしたいものだけ指定してください。この場合、192.168.1.1は"read"接続に利用され、一方192.168.1.2が"write"接続に利用されます。メインのmysql配列に含まれる、データベース接続情報、プレフィックス、文字セットなどその他のオプションは、両方の接続で共有されます。

SQLクエリーの実行

データベース接続の設定を済ませれば、DBファサードを使用しクエリーを実行できます。DBファサードは select、update、insert、delete、statementのクエリータイプごとにメソッドを用意しています。

SELECTクエリーの実行

基本的なクエリーを行うには、DBファサードのselectメソッドを使います。

<?php

namespace App\Http\Controllers;

use DB;
use App\Http\Controllers\Controller;

class UserController extends Controller
{
    /**
     * アプリケーションユーザー全員のリストを表示
     *
     * @return Response
     */
    public function index()
    {
        $users = DB::select('select * from users where active = ?', [1]);

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

selectメソッドの最初の引数はSQLクエリーで、２つ目の引数はクエリーに結合する必要のあるパラメーターです。通常、パラメーターはwhere節制約の値です。パラメーター結合はSQLインジェクションを防ぐために提供されています。

selectメソッドはいつも結果の「配列」を返します。結果の値へアクセスできるように、配列に含まれる結果はそれぞれ、PHPのStdClassオブジェクトになります。

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

名前付き結合の使用

パラメーター結合に?を使う代わりに名前付きの結合でクエリーを実行できます。

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

INSERT文の実行

insert文を実行するには、DBファサードのinsertメソッドを使います。このメソッドは第１引数にSQLクエリー、結合を第２引数に取ります。

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

UPDATE文の実行

データベースの既存レコードの更新には、updateメソッドを使います。このメソッドの返却値は影響を受けたレコード数です。

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

DELETE文の実行

データベースからレコードを削除するには、deleteメソッドを使います。updateと同様に、削除したレコード数が返されます。

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

通常のSQL文を実行する

いつくかのデータベース文は値を返しません。こうしたタイプの操作には、DBファサードのstatementメソッドを使います。

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

クエリーイベントのリッスン

アプリケーションで実行される各SQLクエリーを取得したい場合は、listenメソッドがし良いうできます。このメソッドはクエリーをログしたり、デバッグしたりするときに便利です。クエリーリスナーはサービスプロバイダーの中で登録します。

<?php

namespace App\Providers;

use DB;
use Illuminate\Support\ServiceProvider;

class AppServiceProvider extends ServiceProvider
{
    /**
     * アプリケーションサービスの初期処理
     *
     * @return void
     */
    public function boot()
    {
        DB::listen(function($sql, $bindings, $time) {
            //
        });
    }

    /**
     * サービスプロバイダーの登録
     *
     * @return void
     */
    public function register()
    {
        //
    }
}

データベーストランザクション

一連の操作をデータベーストランザクション内で実行するには、DBファサードのtransactionメソッドを使用してください。トランザクション「クロージャー」の中で例外が投げられると、トランザクションは自動的にロールバックされます。「クロージャー」が正しく実行されると、自動的にコミットされます。transactionメソッドを使用すれば、ロールバックやコミットを手動で行う必要はありません。

DB::transaction(function () {
    DB::table('users')->update(['votes' => 1]);

    DB::table('posts')->delete();
});

手動トランザクション

トランザクションを自分で開始し、ロールバックとコミットを完全にコントロールしたい場合は、DBファサードのbeginTransactionメソッドを使います。

DB::beginTransaction();

rollBackメソッドにより、トランザクションをロールバックできます。

DB::rollBack();

同様に、commitメソッドにより、トランザクションをコミットできます。

DB::commit();

注目： DBファサードのトランザクションメソッドにより、クエリービルダーとEloquent ORMのトランザクションもコントロールできます。

複数接続の使用

複数の接続を使用する場合は、DBファサードのconnectionメソッドを利用し、各接続にアクセスできます。connectionメソッドに渡す「名前」は、config/database.php設定ファイルの中のconnectionsにリストされている名前を指定します。

$users = DB::connection('foo')->select(...);

裏で動作しているPDOインスタンスに直接アクセスしたい場合は、接続インスタンスにgetPdoメソッドを使います。

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

Laravel 5.1 データベース：利用開始