MWLBFactory Class Reference

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

Static Public Member Functions
static	applyDefaultConfig (array $lbConf, Config $mainConfig, ConfiguredReadOnlyMode $readOnlyMode, BagOStuff $srvCace, 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	setSchemaAliases (LBFactory $lbFactory, Config $config)

Static Private Member Functions
static	applyDefaultCaching (array $lbConf, BagOStuff $sCache, BagOStuff $mStash, WANObjectCache $wCache)
static	reportIfPrefixSet ( $prefix, $dbType)
static	reportMismatchedDBs ( $srvDB, $ldDB)
static	reportMismatchedPrefixes ( $srvTP, $ldTP)
static	sanityCheckServerConfig (array $servers, Config $mainConfig)

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

applyDefaultCaching()

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

staticprivate

Parameters

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

Returns

array

Definition at line 186 of file MWLBFactory.php.

References and().

Referenced by applyDefaultConfig().

applyDefaultConfig()

static MWLBFactory::applyDefaultConfig ( array $lbConf, Config $mainConfig, ConfiguredReadOnlyMode $readOnlyMode, BagOStuff $srvCace, BagOStuff $mainStash, WANObjectCache $wanCache )

static

Parameters

array	$lbConf	Config for LBFactory::__construct()
Config	$mainConfig	Main config object from MediaWikiServices
ConfiguredReadOnlyMode	$readOnlyMode
BagOStuff	$srvCace
BagOStuff	$mainStash
WANObjectCache	$wanCache

Returns

array

Definition at line 46 of file MWLBFactory.php.

References $section, $wgCommandLineMode, and(), applyDefaultCaching(), DBO_COMPRESS, DBO_DEBUG, DBO_DEFAULT, DBO_SSL, ConfiguredReadOnlyMode\getReason(), sanityCheckServerConfig(), and wfHostname().

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 289 of file MWLBFactory.php.

References and(), and wfDeprecated().

Referenced by LBFactoryTest\testGetLBFactoryClass().

logDeprecation()

static MWLBFactory::logDeprecation ( $msg )

static

Log a database deprecation warning.

Parameters

string

$msg

Deprecation message

Definition at line 350 of file MWLBFactory.php.

References $wgDevelopmentWarnings, and(), and wfDebugLog().

reportIfPrefixSet()

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

staticprivate

Parameters

string	$prefix	Table prefix
string	$dbType	Database type

Definition at line 238 of file MWLBFactory.php.

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

Referenced by sanityCheckServerConfig().

reportMismatchedDBs()

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

staticprivate

Parameters

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

Definition at line 251 of file MWLBFactory.php.

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

Referenced by sanityCheckServerConfig().

reportMismatchedPrefixes()

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

staticprivate

Parameters

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

Definition at line 268 of file MWLBFactory.php.

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

Referenced by sanityCheckServerConfig().

sanityCheckServerConfig()

static MWLBFactory::sanityCheckServerConfig ( array $servers, Config $mainConfig )

staticprivate

Parameters

array	$servers
Config	$mainConfig

Definition at line 207 of file MWLBFactory.php.

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

Referenced by applyDefaultConfig().

setSchemaAliases()

static MWLBFactory::setSchemaAliases ( LBFactory $lbFactory, Config $config )

static

Definition at line 322 of file MWLBFactory.php.

References Config\get(), and Wikimedia\Rdbms\LBFactory\setIndexAliases().

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