Laravelでテナント接続を使ってマルチテナントアプリケーションを構築する

2024-04-02

Laravelは、複数のデータベース接続を簡単に設定できるフレームワークです。複数のデータベースを使用することで、データの分離やパフォーマンスの向上など、さまざまなメリットを得ることができます。

方法

設定ファイルの編集

config/database.php ファイルを開きます。
connections 配列に、新しいデータベース接続を追加します。

'connections' => [

    'mysql' => [
        'driver' => 'mysql',
        'host' => 'localhost',
        'database' => 'laravel',
        'username' => 'root',
        'password' => '',
    ],

    'pgsql' => [
        'driver' => 'pgsql',
        'host' => 'localhost',
        'database' => 'my_database',
        'username' => 'postgres',
        'password' => 'my_password',
    ],

],

上記例では、mysql と pgsql という名前の2つのデータベース接続を定義しています。

モデルの作成

各データベース接続に対応するモデルを作成します。

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    use HasFactory;

    protected $connection = 'mysql';

    protected $fillable = [
        'name',
        'email',
        'password',
    ];
}

上記例では、mysql 接続を使用する User モデルを作成しています。

データベースへの接続

モデルを使用する際に、connection プロパティを指定することで、接続するデータベースを切り替えることができます。

$user = User::find(1);

// 'mysql' 接続を使用する

$post = Post::find(1);

// 'pgsql' 接続を使用する

データベースファサード

DB ファサードを使用することで、接続するデータベースを動的に切り替えることができます。

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

$posts = DB::connection('pgsql')->table('posts')->get();

複数データベース接続を持つモデル

複数のデータベース接続を持つモデルを作成することもできます。

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    use HasFactory;

    protected $connection = 'mysql';

    protected $fillable = [
        'name',
        'email',
        'password',
    ];

    public function posts()
    {
        return $this->hasMany(Post::class, 'user_id', 'id')->connection('pgsql');
    }
}

上記の例では、mysql 接続を使用する User モデルが、pgsql 接続を使用する Post モデルと関連付けられています。

補足

Laravel 5.7 以降では、複数データベース接続機能が標準で提供されています。
Laravel 5.6 以前を使用している場合は、laravel-multiple-database パッケージなどのサードパーティパッケージを使用する必要があります。

<?php

return [

    'default' => 'mysql',

    'connections' => [

        'mysql' => [
            'driver' => 'mysql',
            'host' => 'localhost',
            'database' => 'laravel',
            'username' => 'root',
            'password' => '',
        ],

        'pgsql' => [
            'driver' => 'pgsql',
            'host' => 'localhost',
            'database' => 'my_database',
            'username' => 'postgres',
            'password' => 'my_password',
        ],

    ],

    'migrations' => 'migrations',

    'redis' => [

        'client' => 'predis',

        'default' => [
            'host' => '127.0.0.1',
            'port' => 6379,
        ],

    ],

];

モデル (app/Models/User.php)

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    use HasFactory;

    protected $connection = 'mysql';

    protected $fillable = [
        'name',
        'email',
        'password',
    ];
}

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;

class Post extends Model
{
    use HasFactory;

    protected $connection = 'pgsql';

    protected $fillable = [
        'title',
        'content',
        'user_id',
    ];

    public function user()
    {
        return $this->belongsTo(User::class);
    }
}

コントローラー (app/Http/Controllers/UserController.php)

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

class UserController extends Controller
{
    public function show(User $user)
    {
        // 'mysql' 接続を使用する

        $posts = $user->posts;

        // 'pgsql' 接続を使用する

        return view('user.show', compact('user', 'posts'));
    }
}

ビュー (resources/views/user/show.blade.php)

@extends('layouts.app')

@section('content')
    <h1>{{ $user->name }}</h1>

    @foreach ($posts as $post)
        <h2>{{ $post->title }}</h2>

        <p>{{ $post->content }}</p>
    @endforeach
@endsection

実際のアプリケーションでは、必要に応じてコードを変更してください。

Laravelで複数のデータベースを使用するその他の方法

テナント接続を使用すると、異なるデータベースに接続する複数のアプリケーションを単一の Laravel インスタンスで実行することができます。

パッケージ

laravel-tenancy や tenancy などのサードパーティパッケージを使用することで、テナント接続機能を簡単に実装することができます。

キュー

異なるデータベースに接続するジョブをキューに登録することができます。

リモートデータベース

異なるサーバー上のデータベースに接続することができます。

シャーディングを使用すると、データを複数のデータベースに分散させることができます。

各方法のメリットとデメリット

方法	メリット	デメリット
テナント接続	複数のアプリケーションを単一の Laravel インスタンスで実行できる	設定が複雑になる可能性がある
パッケージ	テナント接続機能を簡単に実装できる	パッケージのメンテナンス状況によっては、問題が発生する可能性がある
キュー	異なるデータベースに接続するジョブを簡単に実行できる	キューの設定と管理が必要になる
リモートデータベース	異なるサーバー上のデータベースに接続できる	ネットワークの遅延が発生する可能性がある
シャーディング	データを複数のデータベースに分散させることで、パフォーマンスを向上できる	設定と管理が複雑になる可能性がある