0b583944e4
For master connections, LoadBalancer unconditionally replaces the connection’s read-only mode with the load balancer’s, so if we don’t include the read-only reason in the parameters we pass to the parent constructor, the parameter we set on the connection has no effect. I attempted to write tests for this, but eventually had to stop wasting time on it, since I couldn’t get anywhere. Add a warning to the top of the class to discourage others from making the same mistake. Change-Id: I481553fac4f0f13a429ad4bbfdf15007c8299af9
94 lines
2.9 KiB
PHP
94 lines
2.9 KiB
PHP
<?php
|
|
/**
|
|
* Simple generator of database connections that always returns the same object.
|
|
*
|
|
* 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
|
|
* @ingroup Database
|
|
*/
|
|
|
|
namespace Wikimedia\Rdbms;
|
|
|
|
use InvalidArgumentException;
|
|
|
|
/**
|
|
* Trivial LoadBalancer that always returns an injected connection handle.
|
|
*
|
|
* Note that, while this LoadBalancer does not open any connections itself,
|
|
* it still closes the injected connection at times, including during destruction.
|
|
* It is therefore unsuitable for use in tests unless you have a Database instance
|
|
* separate from the main test database (which is expected to stay open).
|
|
*/
|
|
class LoadBalancerSingle extends LoadBalancer {
|
|
/** @var IDatabase */
|
|
private $db;
|
|
|
|
/**
|
|
* @param array $params An associative array with one member:
|
|
* - connection: An IDatabase connection object
|
|
*/
|
|
public function __construct( array $params ) {
|
|
if ( !isset( $params['connection'] ) ) {
|
|
throw new InvalidArgumentException( "Missing 'connection' argument." );
|
|
}
|
|
|
|
$this->db = $params['connection'];
|
|
|
|
parent::__construct( [
|
|
'servers' => [
|
|
[
|
|
'type' => $this->db->getType(),
|
|
'host' => $this->db->getServer(),
|
|
'dbname' => $this->db->getDBname(),
|
|
'load' => 1,
|
|
]
|
|
],
|
|
'trxProfiler' => $params['trxProfiler'] ?? null,
|
|
'srvCache' => $params['srvCache'] ?? null,
|
|
'wanCache' => $params['wanCache'] ?? null,
|
|
'localDomain' => $params['localDomain'] ?? $this->db->getDomainID(),
|
|
'readOnlyReason' => $params['readOnlyReason'] ?? false,
|
|
] );
|
|
|
|
if ( isset( $params['readOnlyReason'] ) ) {
|
|
$this->db->setLBInfo( 'readOnlyReason', $params['readOnlyReason'] );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param IDatabase $db Live connection handle
|
|
* @param array $params Parameter map to LoadBalancerSingle::__constructs()
|
|
* @return LoadBalancerSingle
|
|
* @since 1.28
|
|
*/
|
|
public static function newFromConnection( IDatabase $db, array $params = [] ) {
|
|
return new static( array_merge(
|
|
[ 'localDomain' => $db->getDomainID() ],
|
|
$params,
|
|
[ 'connection' => $db ]
|
|
) );
|
|
}
|
|
|
|
protected function reallyOpenConnection( array $server, DatabaseDomain $domain ) {
|
|
return $this->db;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @deprecated since 1.29
|
|
*/
|
|
class_alias( LoadBalancerSingle::class, 'LoadBalancerSingle' );
|