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
|
<?php
use MediaWiki\MediaWikiServices;
use Wikimedia\Rdbms\IDatabase;
use Wikimedia\Rdbms\ILoadBalancer;
/**
* Base class for objects that allow access to other wiki's databases using
* the foreign database access mechanism implemented by LBFactoryMulti.
*
* Avoid extending this class; instead, inject a load balancer (factory) and,
* if needed, DB domain into your class as constructor arguments,
* then call {@link ILoadBalancer::getConnectionRef()} directly.
*
* 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
*
* @since 1.21
* @deprecated since 1.37
*
* @file
* @ingroup Database
*
* @license GPL-2.0-or-later
* @author Daniel Kinzler
*/
abstract class DBAccessBase implements IDBAccessObject {
/** @var ILoadBalancer */
private $lb;
/** @var string|bool The target wiki's DB domain */
protected $dbDomain = false;
/**
* @param string|bool $dbDomain The target wiki's DB domain
*/
public function __construct( $dbDomain = false ) {
wfDeprecated( __CLASS__, '1.37' );
$this->dbDomain = $dbDomain;
$this->lb = MediaWikiServices::getInstance()->getDBLoadBalancerFactory()
->getMainLB( $dbDomain );
}
/**
* Returns a database connection.
*
* @see LoadBalancer::getConnection()
*
* @since 1.21
*
* @param int $id Which connection to use
* @param array $groups Query groups
*
* @return IDatabase
*/
protected function getConnection( $id, array $groups = [] ) {
return $this->getLoadBalancer()->getConnectionRef( $id, $groups, $this->dbDomain );
}
/**
* Releases a database connection and makes it available for recycling.
*
* @see LoadBalancer::reuseConnection()
*
* @since 1.21
*
* @param IDatabase $db The database connection to release.
* @deprecated Since 1.34
*/
protected function releaseConnection( IDatabase $db ) {
// no-op
}
/**
* Get the database type used for read operations.
*
* @see MediaWikiServices::getInstance()->getDBLoadBalancer
*
* @since 1.21
*
* @return ILoadBalancer The database load balancer object
*/
protected function getLoadBalancer() {
return $this->lb;
}
}
|
