connehito/cakephp-master-replica

Provides the features for multiple database connections as master/replica and switching.

1.0.0 2019-10-13 11:22 UTC

README

The datasource for CakePHP.This plugin enables one-connection to act as two(or more) roles, like master(read-write) and replica(read-only).

Build Status codecov Latest Stable Version Total Downloads License

Supports

  • PHP 7.1+
  • CakePHP 3.6+

Usage

  1. Install plugin composer require connehito/cakephp-master-replica
  2. Set your connections(e.g. in config/app.php datasource. It requires roles property.

Example

Set up your database configuration.

  • Databse-A(for master): mysql;host=db-host,databasename=app_db,login=root,pass=password
  • Databse-B(for replica): mysql;host=db-host,databasename=app_db,login=read-only-user,pass=another-password
  • Databse-C(for replica): mysql;host=replica-host,databasename=app_db,login=read-only-user,pass=another-password
// app.php
// return [
    'Datasources' => [
        'driver' => Cake\Database\Driver\Mysql::class,
        'className' => Connehito\CakephpMasterReplica\Database\Connection\MasterReplicaConnection::class,
        'host' => 'replica-host',
        'database' => 'app_db',
        'roles' => [
            'master' => ['host' => 'db-host', 'username' => 'root', 'password' => 'password'],
            'secondary' => ['host' => 'db-host', 'username' => 'read-only-user', 'password' => 'another-password'],
            'tertiary' => ['username' => 'read-only-user', 'password' => 'another-password'],
        ]
    ]

In each roles, you can set specific values and override them.

In app, now you can connect to database master or replica db as you like 🎉

// as default, connect with `master` role.
$usersTable->save($usersTable->newEnitty(['name' => 'hoge']));

// switch to `replica` role
\Cake\Datasource\ConnectionManager::get('default')->switchRole('secondary');
// Or you can get Connection via Table
$usersTable->getConnection()->switchRole('tertiary');

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/Connehito/cakephp-master-replica

  • Please fix all problems with PHPUnit, PHPStan, PHP_CodeSniffer before send pull request 😄
  • You can build development env in local with tests/test_app/docker-compose.yml 🏇

License

The plugin is available as open source under the terms of the MIT License.