3 * Simple generator of database connections that always returns the same object.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
25 * An LBFactory class that always returns a single database object.
27 class LBFactorySingle
extends LBFactory
{
28 /** @var LoadBalancerSingle */
32 * @param array $conf An associative array with one member:
33 * - connection: The DatabaseBase connection object
35 public function __construct( array $conf ) {
36 parent
::__construct( $conf );
38 $this->lb
= new LoadBalancerSingle( [
39 'readOnlyReason' => $this->readOnlyReason
,
40 'trxProfiler' => $this->trxProfiler
,
41 'srvCache' => $this->srvCache
,
42 'wanCache' => $this->wanCache
47 * @param bool|string $wiki
48 * @return LoadBalancerSingle
50 public function newMainLB( $wiki = false ) {
55 * @param bool|string $wiki
56 * @return LoadBalancerSingle
58 public function getMainLB( $wiki = false ) {
63 * @param string $cluster External storage cluster, or false for core
64 * @param bool|string $wiki Wiki ID, or false for the current wiki
65 * @return LoadBalancerSingle
67 protected function newExternalLB( $cluster, $wiki = false ) {
72 * @param string $cluster External storage cluster, or false for core
73 * @param bool|string $wiki Wiki ID, or false for the current wiki
74 * @return LoadBalancerSingle
76 public function &getExternalLB( $cluster, $wiki = false ) {
81 * @param string|callable $callback
82 * @param array $params
84 public function forEachLB( $callback, array $params = [] ) {
85 call_user_func_array( $callback, array_merge( [ $this->lb
], $params ) );
90 * Helper class for LBFactorySingle.
92 class LoadBalancerSingle
extends LoadBalancer
{
93 /** @var DatabaseBase */
97 * @param array $params
99 public function __construct( array $params ) {
100 $this->db
= $params['connection'];
102 parent
::__construct( [
105 'type' => $this->db
->getType(),
106 'host' => $this->db
->getServer(),
107 'dbname' => $this->db
->getDBname(),
111 'trxProfiler' => isset( $params['trxProfiler'] ) ?
$params['trxProfiler'] : null,
112 'srvCache' => isset( $params['srvCache'] ) ?
$params['srvCache'] : null,
113 'wanCache' => isset( $params['wanCache'] ) ?
$params['wanCache'] : null
116 if ( isset( $params['readOnlyReason'] ) ) {
117 $this->db
->setLBInfo( 'readOnlyReason', $params['readOnlyReason'] );
123 * @param string $server
124 * @param bool $dbNameOverride
126 * @return DatabaseBase
128 protected function reallyOpenConnection( $server, $dbNameOverride = false ) {