1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
|
<?php
/**
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
namespace Wikimedia\Rdbms;
use InvalidArgumentException;
/**
* Database connection manager.
*
* This manages access to primary and replica databases.
*
* @since 1.29
* @ingroup Database
* @author Addshore
*/
class ConnectionManager {
/**
* @var ILoadBalancer
*/
private $loadBalancer;
/**
* The symbolic name of the target database, or false for the local wiki's database.
*
* @var string|false
*/
private $domain;
/**
* @var string[]
*/
private $groups = [];
/**
* @param ILoadBalancer $loadBalancer
* @param string|false $domain Optional logical DB name, defaults to current wiki.
* This follows the convention for database names used by $loadBalancer.
* @param string[] $groups see LoadBalancer::getConnection
*
* @throws InvalidArgumentException
*/
public function __construct( ILoadBalancer $loadBalancer, $domain = false, array $groups = [] ) {
if ( !is_string( $domain ) && $domain !== false ) {
throw new InvalidArgumentException( '$dbName must be a string, or false.' );
}
$this->loadBalancer = $loadBalancer;
$this->domain = $domain;
$this->groups = $groups;
}
/**
* @param int $i
* @param string[]|null $groups
* @param int $flags
* @return IDatabase
*/
private function getConnection( $i, ?array $groups = null, int $flags = 0 ) {
$groups ??= $this->groups;
return $this->loadBalancer->getConnection( $i, $groups, $this->domain, $flags );
}
/**
* Returns a connection to the primary DB, for updating.
*
* @since 1.29
* @since 1.37 Added optional $flags parameter
* @param int $flags
* @return IDatabase
*/
public function getWriteConnection( int $flags = 0 ) {
return $this->getConnection( DB_PRIMARY, null, $flags );
}
/**
* Returns a database connection for reading.
*
* @since 1.29
* @since 1.37 Added optional $flags parameter
* @param string[]|null $groups
* @param int $flags
* @return IReadableDatabase
*/
public function getReadConnection( ?array $groups = null, int $flags = 0 ) {
$groups ??= $this->groups;
return $this->getConnection( DB_REPLICA, $groups, $flags );
}
}
|
