cakePHP3での複数データベース接続

投稿日：2017年4月5日更新日：2020年5月9日

cakePHP3で複数のデータベースに接続することができます。

まず設定ファイルで複数のデータベースを定義します。(defaultはそのままにしておきます。)

   'Datasources' => [
       'default' => [
            'className' => 'Cake\Database\Connection',
            'driver' => 'Cake\Database\Driver\Mysql',
            'persistent' => false,
            'host' => 'host1',
            'username' => 'user1',
            'password' => 'pass1',
            'database' => 'sample_db1',
            'encoding' => 'utf8',
            'timezone' => 'UTC',
            'flags' => [],
            'cacheMetadata' => true,
            'log' => true,
            'quoteIdentifiers' => false,
            'url' => env('DATABASE_URL', null),
        ],
        'db_2' => [
            'className' => 'Cake\Database\Connection',
            'driver' => 'Cake\Database\Driver\Mysql',
            'persistent' => false,
            'host' => 'host2',
            'username' => 'user2',
            'password' => 'pass2',
            'database' => 'sample_db2',
             'encoding' => 'utf8',
             'timezone' => 'UTC',
             'flags' => [],
             'cacheMetadata' => true,
             'log' => true,
             'quoteIdentifiers' => false,
             'url' => env('DATABASE_URL', null),
        ],

'Datasources' => [

'default' => [

'className' => 'Cake\Database\Connection',

'driver' => 'Cake\Database\Driver\Mysql',

'persistent' => false,

'host' => 'host1',

'username' => 'user1',

'password' => 'pass1',

'database' => 'sample_db1',

'encoding' => 'utf8',

'timezone' => 'UTC',

'flags' => [],

'cacheMetadata' => true,

'log' => true,

'quoteIdentifiers' => false,

'url' => env('DATABASE_URL', null),

'db_2' => [

'className' => 'Cake\Database\Connection',

'driver' => 'Cake\Database\Driver\Mysql',

'persistent' => false,

'host' => 'host2',

'username' => 'user2',

'password' => 'pass2',

'database' => 'sample_db2',

'encoding' => 'utf8',

'timezone' => 'UTC',

'flags' => [],

'cacheMetadata' => true,

'log' => true,

'quoteIdentifiers' => false,

'url' => env('DATABASE_URL', null),

基本的には使用したいデータベース接続情報を下記のようにModelに書いてあげればOKです。

public static function defaultConnectionName(){
    return 'db_2';
}

public static function defaultConnectionName(){

return 'db_2';

}

私が使いたいケースはプルダウンを変更した時にPOSTでデータベースの接続先情報を投げる、という処理をしました。

POSTの情報をControoller側で受け取りSESSIONに格納します。このあとModel(Table)にこの情報を渡しますが、継承関係がAppTable ← SampleTableなっている場合、

AppTable.php

public static function defaultConnectionName(){
    return ( !empty($_SESSION['database_type']) ) ? $_SESSION['database_type'] :'default';
}

public static function defaultConnectionName(){

return ( !empty($_SESSION['database_type']) ) ? $_SESSION['database_type'] :'default';

}

SampleTable.php

public static function defaultConnectionName(){
    return parent::defaultConnectionName();
}

public static function defaultConnectionName(){

return parent::defaultConnectionName();

}

と書いておくと楽です。

【CakePHP3】複数データベース接続を実現する方法