Go to the documentation of this file.
56 static $typesWithSchema = [
'postgres',
'msssql' ];
60 $mainConfig->
get(
'DBname' ),
61 $mainConfig->
get(
'DBmwschema' ),
62 $mainConfig->
get(
'DBprefix' )
64 'profiler' =>
function (
$section ) {
68 'replLogger' => LoggerFactory::getInstance(
'DBReplication' ),
69 'queryLogger' => LoggerFactory::getInstance(
'DBQuery' ),
70 'connLogger' => LoggerFactory::getInstance(
'DBConnection' ),
71 'perfLogger' => LoggerFactory::getInstance(
'DBPerformance' ),
76 'readOnlyReason' => $readOnlyMode->
getReason(),
77 'defaultGroup' => $mainConfig->
get(
'DBDefaultGroup' ),
85 $httpMethod = $_SERVER[
'REQUEST_METHOD'] ??
null;
89 $isReadRequest = in_array( $httpMethod, [
'GET',
'HEAD',
'OPTIONS',
'TRACE' ] );
91 if ( isset( $lbConf[
'servers'] ) ) {
93 } elseif ( is_array( $mainConfig->
get(
'DBservers' ) ) ) {
94 $lbConf[
'servers'] = [];
95 foreach ( $mainConfig->
get(
'DBservers' )
as $i => $server ) {
96 if ( $server[
'type'] ===
'sqlite' ) {
98 'dbDirectory' => $mainConfig->
get(
'SQLiteDataDir' ),
99 'trxMode' => $isReadRequest ?
'DEFERRED' :
'IMMEDIATE'
101 } elseif ( $server[
'type'] ===
'postgres' ) {
103 'port' => $mainConfig->
get(
'DBport' ),
105 'keywordTableMap' => [
'user' =>
'mwuser',
'text' =>
'pagecontent' ]
107 } elseif ( $server[
'type'] ===
'mssql' ) {
109 'port' => $mainConfig->
get(
'DBport' ),
110 'useWindowsAuth' => $mainConfig->
get(
'DBWindowsAuthentication' )
114 if ( in_array( $server[
'type'], $typesWithSchema,
true ) ) {
115 $server += [
'schema' => $mainConfig->
get(
'DBmwschema' ) ];
119 'tablePrefix' => $mainConfig->
get(
'DBprefix' ),
121 'sqlMode' => $mainConfig->
get(
'SQLMode' ),
124 $lbConf[
'servers'][$i] = $server;
128 $flags |= $mainConfig->
get(
'DebugDumpSql' ) ?
DBO_DEBUG : 0;
129 $flags |= $mainConfig->
get(
'DBssl' ) ?
DBO_SSL : 0;
132 'host' => $mainConfig->
get(
'DBserver' ),
133 'user' => $mainConfig->
get(
'DBuser' ),
134 'password' => $mainConfig->
get(
'DBpassword' ),
135 'dbname' => $mainConfig->
get(
'DBname' ),
136 'tablePrefix' => $mainConfig->
get(
'DBprefix' ),
137 'type' => $mainConfig->
get(
'DBtype' ),
140 'sqlMode' => $mainConfig->
get(
'SQLMode' ),
141 'trxMode' => $isReadRequest ?
'DEFERRED' :
'IMMEDIATE'
143 if ( in_array( $server[
'type'], $typesWithSchema,
true ) ) {
144 $server += [
'schema' => $mainConfig->
get(
'DBmwschema' ) ];
146 if ( $server[
'type'] ===
'sqlite' ) {
147 $server[
'dbDirectory'] = $mainConfig->
get(
'SQLiteDataDir' );
148 } elseif ( $server[
'type'] ===
'postgres' ) {
149 $server[
'port'] = $mainConfig->
get(
'DBport' );
151 $server[
'keywordTableMap'] = [
'user' =>
'mwuser',
'text' =>
'pagecontent' ];
152 } elseif ( $server[
'type'] ===
'mssql' ) {
153 $server[
'port'] = $mainConfig->
get(
'DBport' );
154 $server[
'useWindowsAuth'] = $mainConfig->
get(
'DBWindowsAuthentication' );
156 $lbConf[
'servers'] = [ $server ];
158 if ( !isset( $lbConf[
'externalClusters'] ) ) {
159 $lbConf[
'externalClusters'] = $mainConfig->
get(
'ExternalServers' );
162 $serversCheck = $lbConf[
'servers'];
164 if ( isset( $lbConf[
'serverTemplate'] ) ) {
165 if ( in_array( $lbConf[
'serverTemplate'][
'type'], $typesWithSchema,
true ) ) {
166 $lbConf[
'serverTemplate'][
'schema'] = $mainConfig->
get(
'DBmwschema' );
168 $lbConf[
'serverTemplate'][
'sqlMode'] = $mainConfig->
get(
'SQLMode' );
170 $serversCheck = $lbConf[
'serverTemplate'] ?? [];
190 if ( $sCache->
getQoS( $sCache::ATTR_EMULATION ) > $sCache::QOS_EMULATION_SQL ) {
191 $lbConf[
'srvCache'] = $sCache;
193 if ( $mStash->
getQoS( $mStash::ATTR_EMULATION ) > $mStash::QOS_EMULATION_SQL ) {
194 $lbConf[
'memStash'] = $mStash;
196 if ( $wCache->
getQoS( $wCache::ATTR_EMULATION ) > $wCache::QOS_EMULATION_SQL ) {
197 $lbConf[
'wanCache'] = $wCache;
208 $ldDB = $mainConfig->
get(
'DBname' );
209 $ldTP = $mainConfig->
get(
'DBprefix' );
211 foreach ( $servers
as $server ) {
212 $type = $server[
'type'] ??
null;
213 $srvDB = $server[
'dbname'] ??
null;
214 $srvTP = $server[
'tablePrefix'] ??
'';
216 if (
$type ===
'mysql' ) {
219 if ( $srvDB !==
null && $srvDB !== $ldDB ) {
222 } elseif (
$type ===
'postgres' ) {
223 if ( $srvTP !==
'' ) {
228 if ( $srvTP !==
'' && $srvTP !== $ldTP ) {
239 $e =
new UnexpectedValueException(
240 "\$wgDBprefix is set to '$prefix' but the database type is '$dbType'. " .
241 "MediaWiki does not support using a table prefix with this RDBMS type."
252 $e =
new UnexpectedValueException(
253 "\$wgDBservers has dbname='$srvDB' but \$wgDBname='$ldDB'. " .
254 "Set \$wgDBname to the database used by this wiki project. " .
255 "There is rarely a need to set 'dbname' in \$wgDBservers. " .
256 "Cross-wiki database access, use of WikiMap::getCurrentWikiDbDomain(), " .
257 "use of Database::getDomainId(), and other features are not reliable when " .
258 "\$wgDBservers does not match the local wiki database/prefix."
269 $e =
new UnexpectedValueException(
270 "\$wgDBservers has tablePrefix='$srvTP' but \$wgDBprefix='$ldTP'. " .
271 "Set \$wgDBprefix to the table prefix used by this wiki project. " .
272 "There is rarely a need to set 'tablePrefix' in \$wgDBservers. " .
273 "Cross-wiki database access, use of WikiMap::getCurrentWikiDbDomain(), " .
274 "use of Database::getDomainId(), and other features are not reliable when " .
275 "\$wgDBservers does not match the local wiki database/prefix."
293 'LBFactory_Simple' =>
'LBFactorySimple',
294 'LBFactory_Single' =>
'LBFactorySingle',
295 'LBFactory_Multi' =>
'LBFactoryMulti'
298 $class = $config[
'class'];
300 if ( isset( $bcClasses[$class] ) ) {
301 $class = $bcClasses[$class];
303 '$wgLBFactoryConf must be updated. See RELEASE-NOTES for details',
315 if ( isset( $compat[$class] ) ) {
316 $class = $compat[$class];
323 if ( $config->
get(
'DBtype' ) ===
'mysql' ) {
339 'ar_usertext_timestamp' =>
'usertext_timestamp',
340 'un_user_id' =>
'user_id',
341 'un_user_ip' =>
'user_ip',
353 if ( isset( self::$loggedDeprecations[$msg] ) ) {
356 self::$loggedDeprecations[$msg] =
true;
359 trigger_error( $msg, E_USER_DEPRECATED );
MediaWiki-specific class for generating database load balancers.
static reportMismatchedDBs( $srvDB, $ldDB)
static instance()
Singleton.
static applyDefaultConfig(array $lbConf, Config $mainConfig, ConfiguredReadOnlyMode $readOnlyMode, BagOStuff $srvCace, BagOStuff $mainStash, WANObjectCache $wanCache)
wfHostname()
Fetch server name for use in error reporting etc.
Class representing a cache/ephemeral data store.
static logDeprecation( $msg)
Log a database deprecation warning.
wfDebugLog( $logGroup, $text, $dest='all', array $context=[])
Send a line to a supplementary debug log file, if configured, or main debug log if not.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
static reportMismatchedPrefixes( $srvTP, $ldTP)
static array $loggedDeprecations
Cache of already-logged deprecation messages.
Interface for configuration instances.
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
static sanityCheckServerConfig(array $servers, Config $mainConfig)
get( $name)
Get a configuration variable such as "Sitename" or "UploadMaintenance.".
global $wgCommandLineMode
static getLBFactoryClass(array $config)
Returns the LBFactory class to use and the load balancer configuration.
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
static setSchemaAliases(LBFactory $lbFactory, Config $config)
Multi-datacenter aware caching interface.
$wgDevelopmentWarnings
If set to true MediaWiki will throw notices for some possible error conditions and for deprecated fun...
static applyDefaultCaching(array $lbConf, BagOStuff $sCache, BagOStuff $mStash, WANObjectCache $wCache)
static output( $e, $mode, $eNew=null)
usually copyright or history_copyright This message must be in HTML not wikitext if the section is included from a template $section
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
MediaWiki Logger LoggerFactory implements a PSR[0] compatible message logging system Named Psr Log LoggerInterface instances can be obtained from the MediaWiki Logger LoggerFactory::getInstance() static method. MediaWiki\Logger\LoggerFactory expects a class implementing the MediaWiki\Logger\Spi interface to act as a factory for new Psr\Log\LoggerInterface instances. The "Spi" in MediaWiki\Logger\Spi stands for "service provider interface". An SPI is an API intended to be implemented or extended by a third party. This software design pattern is intended to enable framework extension and replaceable components. It is specifically used in the MediaWiki\Logger\LoggerFactory service to allow alternate PSR-3 logging implementations to be easily integrated with MediaWiki. The service provider interface allows the backend logging library to be implemented in multiple ways. The $wgMWLoggerDefaultSpi global provides the classname of the default MediaWiki\Logger\Spi implementation to be loaded at runtime. This can either be the name of a class implementing the MediaWiki\Logger\Spi with a zero argument const ructor or a callable that will return an MediaWiki\Logger\Spi instance. Alternately the MediaWiki\Logger\LoggerFactory MediaWiki Logger LoggerFactory
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Class to handle database/prefix specification for IDatabase domains.
static reportIfPrefixSet( $prefix, $dbType)