MWLBFactory Class Reference

MediaWiki-specific class for generating database load balancers. More...

Static Public Member Functions
static	applyDefaultConfig (array $lbConf, ServiceOptions $options, ConfiguredReadOnlyMode $readOnlyMode, BagOStuff $srvCache, BagOStuff $mainStash, WANObjectCache $wanCache)
static	getLBFactoryClass (array $config)
	Returns the LBFactory class to use and the load balancer configuration.
static	logDeprecation ( $msg)
	Log a database deprecation warning.

Static Private Member Functions
static	assertValidServerConfigs (array $servers, $ldDB, $ldTP)
static	getDbTypesWithSchemas ()
static	initServerInfo (array $server, ServiceOptions $options)
static	injectObjectCaches (array $lbConf, BagOStuff $sCache, BagOStuff $mStash, WANObjectCache $wCache)
static	reportIfPrefixSet ( $prefix, $dbType)
static	reportMismatchedDBs ( $srvDB, $ldDB)
static	reportMismatchedPrefixes ( $srvTP, $ldTP)

Static Private Attributes
static array	$loggedDeprecations = []
	Cache of already-logged deprecation messages.

Detailed Description

MediaWiki-specific class for generating database load balancers.

Definition at line 32 of file MWLBFactory.php.

Member Function Documentation

applyDefaultConfig()

static MWLBFactory::applyDefaultConfig ( array  $lbConf, ServiceOptions  $options, ConfiguredReadOnlyMode  $readOnlyMode, BagOStuff  $srvCache, BagOStuff  $mainStash, WANObjectCache  $wanCache  )

static

Parameters

array	$lbConf	Config for LBFactory::__construct()
ServiceOptions	$options
ConfiguredReadOnlyMode	$readOnlyMode
BagOStuff	$srvCache
BagOStuff	$mainStash
WANObjectCache	$wanCache

Returns

array

Definition at line 72 of file MWLBFactory.php.

References $wgCommandLineMode, MediaWiki\Config\ServiceOptions\assertRequiredOptions(), assertValidServerConfigs(), DBO_COMPRESS, DBO_SSL, MediaWiki\Config\ServiceOptions\get(), getDbTypesWithSchemas(), ConfiguredReadOnlyMode\getReason(), initServerInfo(), injectObjectCaches(), and wfHostname().

assertValidServerConfigs()

static MWLBFactory::assertValidServerConfigs ( array  $servers,   $ldDB,   $ldTP  )

staticprivate

Parameters

array	$servers
string	$ldDB	Local domain database name
string	$ldTP	Local domain prefix

Definition at line 247 of file MWLBFactory.php.

References $type, reportIfPrefixSet(), reportMismatchedDBs(), and reportMismatchedPrefixes().

Referenced by applyDefaultConfig().

getDbTypesWithSchemas()

static MWLBFactory::getDbTypesWithSchemas ( )

staticprivate

Returns

array

Definition at line 167 of file MWLBFactory.php.

Referenced by applyDefaultConfig().

getLBFactoryClass()

static MWLBFactory::getLBFactoryClass ( array  $config )

static

Returns the LBFactory class to use and the load balancer configuration.

Todo:

instead of this, use a ServiceContainer for managing the different implementations.

Parameters

array

$config

(e.g. $wgLBFactoryConf)

Returns

string Class name

Definition at line 327 of file MWLBFactory.php.

References wfDeprecated().

initServerInfo()

static MWLBFactory::initServerInfo ( array  $server, ServiceOptions  $options  )

staticprivate

Parameters

array	$server
ServiceOptions	$options

Returns

array

Definition at line 176 of file MWLBFactory.php.

References DBO_DEBUG, DBO_DEFAULT, and MediaWiki\Config\ServiceOptions\get().

Referenced by applyDefaultConfig().

injectObjectCaches()

static MWLBFactory::injectObjectCaches ( array  $lbConf, BagOStuff  $sCache, BagOStuff  $mStash, WANObjectCache  $wCache  )

staticprivate

Parameters

array	$lbConf
BagOStuff	$sCache
BagOStuff	$mStash
WANObjectCache	$wCache

Returns

array

Definition at line 220 of file MWLBFactory.php.

References BagOStuff\getQoS(), and WANObjectCache\getQoS().

Referenced by applyDefaultConfig().

logDeprecation()

static MWLBFactory::logDeprecation (   $msg )

static

Log a database deprecation warning.

Parameters

string

$msg

Deprecation message

Definition at line 365 of file MWLBFactory.php.

References $wgDevelopmentWarnings, and wfDebugLog().

reportIfPrefixSet()

static MWLBFactory::reportIfPrefixSet (   $prefix,   $dbType  )

staticprivate

Parameters

string	$prefix	Table prefix
string	$dbType	Database type

Definition at line 275 of file MWLBFactory.php.

References MWExceptionRenderer\AS_PRETTY, and MWExceptionRenderer\output().

Referenced by assertValidServerConfigs().

reportMismatchedDBs()

static MWLBFactory::reportMismatchedDBs (   $srvDB,   $ldDB  )

staticprivate

Parameters

string	$srvDB	Server config database
string	$ldDB	Local DB domain database

Definition at line 288 of file MWLBFactory.php.

References MWExceptionRenderer\AS_PRETTY, and MWExceptionRenderer\output().

Referenced by assertValidServerConfigs().

reportMismatchedPrefixes()

static MWLBFactory::reportMismatchedPrefixes (   $srvTP,   $ldTP  )

staticprivate

Parameters

string	$srvTP	Server config table prefix
string	$ldTP	Local DB domain database

Definition at line 305 of file MWLBFactory.php.

References MWExceptionRenderer\AS_PRETTY, and MWExceptionRenderer\output().

Referenced by assertValidServerConfigs().

Member Data Documentation

$loggedDeprecations

array MWLBFactory::$loggedDeprecations = []

staticprivate

Cache of already-logged deprecation messages.

Definition at line 35 of file MWLBFactory.php.

---

The documentation for this class was generated from the following file:

• includes/db/MWLBFactory.php