PHPackages                             indievox/master-slave-db-access - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Database &amp; ORM](/categories/database)
4. /
5. indievox/master-slave-db-access

ActiveLibrary[Database &amp; ORM](/categories/database)

indievox/master-slave-db-access
===============================

簡易的 MySQL database 伺服器存取類別，使用 POD 及 singleton pattern 實作，支援 Master-Slave 架構。 / Simple MySQL database server access class use PDO and singleton pattern, support Master-Slave database cluster.

0.0.1(10y ago)4222MITPHPPHP &gt;= 5.3

Since Mar 29Pushed 10y ago4 watchersCompare

[ Source](https://github.com/indievox-inc/MasterSlaveDBAccess)[ Packagist](https://packagist.org/packages/indievox/master-slave-db-access)[ RSS](/packages/indievox-master-slave-db-access/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (1)Dependencies (3)Versions (3)Used By (0)

Master Slave DBAccess
=====================

[](#master-slave-dbaccess)

[![Latest Stable Version](https://camo.githubusercontent.com/e2ff3db3dd98b5fa7aae1d6f3185e6d0ad9decf3f648f5ed37b570d8f5dd6260/68747470733a2f2f706f7365722e707567782e6f72672f696e646965766f782f6d61737465722d736c6176652d64622d6163636573732f762f737461626c65)](https://packagist.org/packages/indievox/master-slave-db-access)[![Build Status](https://camo.githubusercontent.com/039edda5f0e2b81afde368f99f18f66955b28378c936dec80a7c6ff716f39d83/68747470733a2f2f7472617669732d63692e6f72672f696e646965766f782d696e632f4d6173746572536c61766544424163636573732e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/indievox-inc/MasterSlaveDBAccess)[![codecov.io](https://camo.githubusercontent.com/a0c50dd8ed80e56e79c089ce2f94b2041d7a5964414f4c507426f830e1e7255c/68747470733a2f2f636f6465636f762e696f2f6769746875622f696e646965766f782d696e632f4d6173746572536c61766544424163636573732f636f7665726167652e7376673f6272616e63683d6d6173746572)](https://codecov.io/github/indievox-inc/MasterSlaveDBAccess?branch=master)[![Codacy Badge](https://camo.githubusercontent.com/289aca4f57da928d4e3dae6face0f16328090f552a153f1e974603e694f677a9/68747470733a2f2f6170692e636f646163792e636f6d2f70726f6a6563742f62616467652f67726164652f6134373839303135313237303433626161366435363336616636393634383039)](https://www.codacy.com/app/hub/MasterSlaveDBAccess)

簡易的 MySQL database 伺服器存取類別，使用 POD 及 singleton pattern 實作，支援 Master-Slave 架構。

Simple MySQL database server access class use PDO and singleton pattern, support Master-Slave database cluster.

Usage
=====

[](#usage)

Install by composer
-------------------

[](#install-by-composer)

```
composer require indievox/master-slave-db-access:dev-master
```

Include auto load
-----------------

[](#include-auto-load)

```
require_once "/path/to/your/vendor/autoload.php";
use iNDIEVOX\MasterSlaveDBAccess\MasterSlaveDBAccess;
```

Config your database connections
--------------------------------

[](#config-your-database-connections)

Here's the example of database connection config

```
$db_config = array(
    "database_server" => array(
        "master"=>array(
            "db_host"=>'localhost', // change to your master host
            "db_name"=>'homestead', // change to your master database name
            "db_user"=>'root',      // change to your master database username
            "db_password"=>''       // change to your master database password
        ),
        "slave1"=>array(
            "db_host"=>'localhost', // change to your slave host
            "db_name"=>'homestead', // change to your slave database name
            "db_user"=>'root',      // change to your slave database username
            "db_password"=>''       // change to your slave database password
        ),
        "slave2"=>array(
            "db_host"=>'localhost', // change to your slave host
            "db_name"=>'homestead', // change to your slave database name
            "db_user"=>'root',      // change to your slave database username
            "db_password"=>''       // change to your slave database password
        )
    ),
    "slave_database_name" => array(
        'slave1',
        'slave2'
    )
);
```

Get database access instance
----------------------------

[](#get-database-access-instance)

```
$db_obj = MasterSlaveDBAccess::getInstance($db_config);
```

Use database access instance to excute query
--------------------------------------------

[](#use-database-access-instance-to-excute-query)

```
$select_sql = "SELECT id, email FROM user WHERE id=:id ";
$param = array(
    ":id" => '1'
);
$query_result = $db_obj->selectCommand($select_sql, $param);

foreach ($query_result as $query_result_data) {
    echo $query_result_data["id"];
    echo $query_result_data["email"];
}
```

Force read master database when you need
----------------------------------------

[](#force-read-master-database-when-you-need)

```
MasterSlaveDBAccess::forceSwitchMaster();

$select_sql = "SELECT id, email FROM user WHERE id=:id ";

$param = array(
    ":id" => '1'
);

// select query, but use master only this time
$query_result = $db_obj->selectCommand($select_sql, $param);

foreach ($query_result as $query_result_data) {
    echo $query_result_data["id"];
    echo $query_result_data["email"];
}

$select_sql = "SELECT id, email FROM user WHERE id=:id ";

$param = array(
    ":id" => '1'
);

// select query, auto switch to slave(read)
$query_result = $db_obj->selectCommand($select_sql, $param);

foreach ($query_result as $query_result_data) {
    echo $query_result_data["id"];
    echo $query_result_data["email"];
}
```

Use "right" method to excute query, the class will auto switch to right read/write connection to process the query
------------------------------------------------------------------------------------------------------------------

[](#use-right-method-to-excute-query-the-class-will-auto-switch-to-right-readwrite-connection-to-process-the-query)

```
use iNDIEVOX\MasterSlaveDBAccess\MasterSlaveDBAccess;

$db_config = array(
    "database_server" => array(
        "master"=>array(
            "db_host"=>'localhost',
            "db_name"=>'homestead',
            "db_user"=>'root',
            "db_password"=>''
        ),
        "slave1"=>array(
            "db_host"=>'localhost',
            "db_name"=>'homestead',
            "db_user"=>'root',
            "db_password"=>''
        ),
        "slave2"=>array(
            "db_host"=>'localhost',
            "db_name"=>'homestead',
            "db_user"=>'root',
            "db_password"=>''
        )
    ),
    "slave_database_name" => array(
        'slave1',
        'slave2'
    )
);

// init conneciton, use slave(read) connection
$db_obj = MasterSlaveDBAccess::getInstance($db_config);

$insert_sql = "INSERT INTO user ".
    "(id, path, is_deleted, create_time, modify_time, delete_time) ".
    "VALUES ".
    "(:id, :path, :is_deleted, :create_time, :modify_time, :delete_time);";

$param = array(
    ":id"           => '1',
    ":path"         => 'fukuball',
    ":is_deleted"   => '0',
    ":create_time"  => '2016-12-30 00:00:00',
    ":modify_time"  => '2016-12-30 16:12:18',
    ":delete_time"  => '0000-00-00 00:00:00'
);

// insert query, auto switch to master(write)
$insert_id = $db_obj->insertCommand($insert_sql, $param);

$select_sql = "SELECT * FROM user WHERE id=:id ";

$param = array(
    ":id" => '1'
);

// select query, auto switch to slave(read)
$query_result = $db_obj->selectCommand($select_sql, $param);

foreach ($query_result as $query_result_data) {
    echo $query_result_data["id"];
    echo $query_result_data["email"];
}

$update_sql = "UPDATE user SET path='fukuball-lin' WHERE id=:id ";

$param = array(
    ":id" => '1'
);

// update query, auto switch to master(write)
$affected_rows = $db_obj->updateCommand($update_sql, $param);

$delete_sql = "DELETE FROM user WHERE id=:id ";

$param = array(
    ":id" => '1'
);

// delete query, auto switch to master(write)
$affected_rows = $db_obj->deleteCommand($delete_sql, $param);
```

Sometimes you want to use master server in the whole context
------------------------------------------------------------

[](#sometimes-you-want-to-use-master-server-in-the-whole-context)

```
// init conneciton, use slave(read) connection
$db_obj = MasterSlaveDBAccess::getInstance($db_config);

// switch to master
MasterSlaveDBAccess::forceSwitchMasterWholeContext();

$select_sql = "SELECT * FROM user WHERE id=:id ";

$param = array(
    ":id" => '1'
);

// select query, but use master
$query_result = $db_obj->selectCommand($select_sql, $param);

$insert_sql = "INSERT INTO user ".
    "(id, path, is_deleted, create_time, modify_time, delete_time) ".
    "VALUES ".
    "(:id, :path, :is_deleted, :create_time, :modify_time, :delete_time);";

$param = array(
    ":id"           => '2',
    ":path"         => 'punkball',
    ":is_deleted"   => '0',
    ":create_time"  => '2016-12-31 00:00:00',
    ":modify_time"  => '2016-12-31 16:12:18',
    ":delete_time"  => '0000-00-00 00:00:00'
);

// insert query, use master
$insert_id = $db_obj->insertCommand($insert_sql, $param);

$select_sql = "SELECT * FROM user WHERE id=:id ";

$param = array(
    ":id" => '2'
);

// select query, but use master
$query_result = $db_obj->selectCommand($select_sql, $param);
```

License
=======

[](#license)

The MIT License (MIT)

Copyright (c) 2016 iNDIEVOX

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

###  Health Score

25

—

LowBetter than 37% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity12

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity49

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

3693d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/e9bcbc1f6df79716b09c4204b5ca226c59370f0631cb3cac0baecd8ba214c1cd?d=identicon)[indievox](/maintainers/indievox)

---

Top Contributors

[![fukuball](https://avatars.githubusercontent.com/u/646843?v=4)](https://github.com/fukuball "fukuball (65 commits)")

---

Tags

phpmysqlmaster-slavepodMasterSlaveDBAccess

###  Code Quality

TestsPHPUnit

Code StylePHP\_CodeSniffer

### Embed Badge

![Health badge](/badges/indievox-master-slave-db-access/health.svg)

```
[![Health](https://phpackages.com/badges/indievox-master-slave-db-access/health.svg)](https://phpackages.com/packages/indievox-master-slave-db-access)
```

###  Alternatives

[leantime/leantime

Open source project management system for non-project managers. Simple like Trello, powerful like Jira. Built with neurodiversity in mind.

9.4k2.8k](/packages/leantime-leantime)[clouddueling/mysqldump-php

PHP version of mysqldump cli that comes with MySQL

1.3k22.9k](/packages/clouddueling-mysqldump-php)[stefangabos/zebra_database

An advanced, compact and lightweight MySQL database wrapper library, built around PHP's MySQLi extension.

11812.0k](/packages/stefangabos-zebra-database)[eftec/pdoone

Minimaist procedural PDO wrapper library

1105.9k9](/packages/eftec-pdoone)[popphp/pop-db

Pop Db Component for Pop PHP Framework

1814.6k11](/packages/popphp-pop-db)[matthew-p/docker-server

Universal docker server, Nginx, PHP-FPM, MySql, Redis

112.8k](/packages/matthew-p-docker-server)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
