107 parent::__construct(
$params );
113 $this->serverInfos = [];
114 $this->serverTags = [];
115 $this->numServers = count(
$params[
'servers'] );
117 foreach (
$params[
'servers'] as $tag => $info ) {
118 $this->serverInfos[$index] = $info;
120 $this->serverTags[$index] = $tag;
122 $this->serverTags[$index] = $info[
'host'] ??
"#$index";
127 $this->serverInfos = [
$params[
'server'] ];
128 $this->numServers = count( $this->serverInfos );
131 $this->serverInfos =
false;
132 $this->numServers = 1;
145 $this->syncTimeout =
$params[
'syncTimeout'];
147 $this->replicaOnly = !empty(
$params[
'slaveOnly'] );
157 protected function getDB( $serverIndex ) {
158 if ( !
isset( $this->conns[$serverIndex] ) ) {
159 if ( $serverIndex >= $this->numServers ) {
160 throw new MWException( __METHOD__ .
": Invalid server index \"$serverIndex\"" );
163 # Don't keep timing out trying to connect for each call if the DB is down
164 if (
isset( $this->connFailureErrors[$serverIndex] )
165 && ( time() - $this->connFailureTimes[$serverIndex] ) < 60
170 if ( $this->serverInfos ) {
173 $type = $info[
'type'] ??
'mysql';
174 $host = $info[
'host'] ??
'[unknown]';
175 $this->logger->debug( __CLASS__ .
": connecting to $host" );
176 $db = Database::factory(
$type, $info );
180 $lb = MediaWikiServices::getInstance()->getDBLoadBalancer();
182 if ( $lb->getServerType( $lb->getWriterIndex() ) !==
'sqlite' ) {
184 $db = $lb->getConnection( $index, [],
false, $lb::CONN_TRX_AUTOCOMMIT );
188 $db = $lb->getConnection( $index );
192 $this->logger->debug(
sprintf(
"Connection %s will be used for SqlBagOStuff", $db ) );
205 if ( $this->shards > 1 ) {
211 if ( $this->numServers > 1 ) {
213 ArrayUtils::consistentHashSort( $sortedServers, $key );
214 reset( $sortedServers );
215 $serverIndex =
key( $sortedServers );
228 if ( $this->shards > 1 ) {
229 $decimals =
strlen( $this->shards - 1 );
231 sprintf(
"%0{$decimals}d", $index );
237 protected function doGet( $key, $flags = 0, &$casToken =
null ) {
242 $blob = $blobs[$key];
257 foreach ( $blobs as $key =>
$blob ) {
268 foreach (
$keys as $key ) {
276 foreach ( $keysByTable as $serverIndex => $serverKeys ) {
278 $db = $this->
getDB( $serverIndex );
279 foreach ( $serverKeys as
$tableName => $tableKeys ) {
281 [
'keyname',
'value',
'exptime' ],
282 [
'keyname' => $tableKeys ],
287 $db->trxLevel() ? [
'LOCK IN SHARE MODE' ] : []
289 if (
$res ===
false ) {
292 foreach (
$res as $row ) {
295 $dataRows[$row->keyname] = $row;
303 foreach (
$keys as $key ) {
304 if (
isset( $dataRows[$key] ) ) {
305 $row = $dataRows[$key];
306 $this->
debug(
"get: retrieved data; expiry time is " . $row->exptime );
309 $db = $this->
getDB( $row->serverIndex );
310 if ( $this->
isExpired( $db, $row->exptime ) ) {
311 $this->
debug(
"get: key has expired" );
313 $values[$key] = $db->decodeBlob( $row->value );
319 $this->
debug(
'get: no matching rows' );
327 return $this->
insertMulti( $data, $expiry, $flags,
true );
340 $exptime = (
int)$expiry;
342 foreach ( $keysByTable as $serverIndex => $serverKeys ) {
345 $db = $this->
getDB( $serverIndex );
352 if ( $exptime < 0 ) {
356 if ( $exptime == 0 ) {
360 $encExpiry = $db->timestamp( $exptime );
362 foreach ( $serverKeys as
$tableName => $tableKeys ) {
364 foreach ( $tableKeys as $key ) {
367 'value' => $db->encodeBlob( $this->
serialize( $data[$key] ) ),
377 $result = ( $db->affectedRows() > 0 &&
$result );
387 if ( ( $flags & self::WRITE_SYNC ) == self::WRITE_SYNC ) {
394 public function set( $key,
$value, $exptime = 0, $flags = 0 ) {
400 public function add( $key,
$value, $exptime = 0, $flags = 0 ) {
406 protected function cas( $casToken, $key,
$value, $exptime = 0, $flags = 0 ) {
411 $db = $this->
getDB( $serverIndex );
412 $exptime =
intval( $exptime );
414 if ( $exptime < 0 ) {
418 if ( $exptime == 0 ) {
422 $encExpiry = $db->timestamp( $exptime );
430 'value' => $db->encodeBlob( $this->serialize(
$value ) ),
431 'exptime' => $encExpiry
435 'value' => $db->encodeBlob( $casToken )
445 return (
bool)$db->affectedRows();
450 foreach (
$keys as $key ) {
457 foreach ( $keysByTable as $serverIndex => $serverKeys ) {
460 $db = $this->
getDB( $serverIndex );
467 foreach ( $serverKeys as
$tableName => $tableKeys ) {
469 $db->delete(
$tableName, [
'keyname' => $tableKeys ], __METHOD__ );
478 if ( ( $flags & self::WRITE_SYNC ) == self::WRITE_SYNC ) {
485 public function delete( $key, $flags = 0 ) {
491 public function incr( $key, $step = 1 ) {
496 $db = $this->
getDB( $serverIndex );
498 $row = $db->selectRow(
500 [
'value',
'exptime' ],
501 [
'keyname' => $key ],
505 if ( $row ===
false ) {
509 $db->delete(
$tableName, [
'keyname' => $key ], __METHOD__ );
510 if ( $this->
isExpired( $db, $row->exptime ) ) {
516 $newValue = $oldValue +
$step;
521 'value' => $db->encodeBlob( $this->serialize( $newValue ) ),
522 'exptime' => $row->exptime
528 if ( $db->affectedRows() == 0 ) {
540 public function merge( $key, callable $callback, $exptime = 0, $attempts = 10, $flags = 0 ) {
541 $ok = $this->
mergeViaCas( $key, $callback, $exptime, $attempts, $flags );
542 if ( ( $flags & self::WRITE_SYNC ) == self::WRITE_SYNC ) {
549 public function changeTTL( $key, $exptime = 0, $flags = 0 ) {
554 $db = $this->
getDB( $serverIndex );
555 if ( $exptime == 0 ) {
562 [
'exptime' => $timestamp ],
563 [
'keyname' => $key,
'exptime > ' . $db->addQuotes( $db->timestamp( time() ) ) ],
566 if ( $db->affectedRows() == 0 ) {
567 $exists = (
bool)$db->selectField(
570 [
'keyname' => $key,
'exptime' => $timestamp ],
599 if ( time() > 0x7fffffff ) {
600 return $db->timestamp( 1 << 62 );
602 return $db->timestamp( 0x7fffffff );
607 if ( !$this->purgePeriod || $this->replicaOnly ) {
612 if ( $this->purgePeriod !== 1 &&
mt_rand( 0, $this->purgePeriod - 1 ) ) {
617 if ( $now > ( $this->lastExpireAll + 1 ) ) {
618 $this->lastExpireAll =
$now;
638 $db = $this->
getDB( $serverIndex );
639 $dbTimestamp = $db->timestamp( $timestamp );
640 $totalSeconds =
false;
641 $baseConds = [
'exptime < ' . $db->addQuotes( $dbTimestamp ) ];
646 if ( $maxExpTime !==
false ) {
647 $conds[] =
'exptime >= ' . $db->addQuotes( $maxExpTime );
651 [
'keyname',
'exptime' ],
654 [
'LIMIT' => 100,
'ORDER BY' =>
'exptime' ] );
659 $row =
$rows->current();
660 $minExpTime = $row->exptime;
661 if ( $totalSeconds ===
false ) {
665 foreach (
$rows as $row ) {
666 $keys[] = $row->keyname;
667 $maxExpTime = $row->exptime;
673 'exptime >= ' . $db->addQuotes( $minExpTime ),
674 'exptime < ' . $db->addQuotes( $dbTimestamp ),
679 if ( $progressCallback ) {
680 if (
intval( $totalSeconds ) === 0 ) {
683 $remainingSeconds =
wfTimestamp( TS_UNIX, $timestamp )
685 if ( $remainingSeconds > $totalSeconds ) {
690 / $this->shards * 100;
693 + ( $serverIndex / $this->numServers * 100 );
716 $db = $this->
getDB( $serverIndex );
757 if ( $decomp !==
false ) {
801 $this->logger->error(
"DBError: {$exception->getMessage()}" );
804 $this->logger->debug( __METHOD__ .
": ignoring connection error" );
807 $this->logger->debug( __METHOD__ .
": ignoring query error" );
818 unset( $this->conns[$serverIndex] );
820 if (
isset( $this->connFailureTimes[$serverIndex] ) ) {
821 if ( time() - $this->connFailureTimes[$serverIndex] >= 60 ) {
822 unset( $this->connFailureTimes[$serverIndex] );
823 unset( $this->connFailureErrors[$serverIndex] );
825 $this->logger->debug( __METHOD__ .
": Server #$serverIndex already down" );
830 $this->logger->info( __METHOD__ .
": Server #$serverIndex down until " . ( $now + 60 ) );
840 $db = $this->
getDB( $serverIndex );
841 if ( $db->getType() !==
'mysql' ) {
842 throw new MWException( __METHOD__ .
' is not supported on this DB server' );
847 'CREATE TABLE ' . $db->tableName( $this->getTableNameByShard( $i ) ) .
848 ' LIKE ' . $db->tableName(
'objectcache' ),
867 $lb = MediaWikiServices::getInstance()->getDBLoadBalancer();
868 if ( $lb->getServerCount() <= 1 ) {
874 $masterPos = $lb->getMasterPos();
879 $loop =
new WaitConditionLoop(
880 function () use ( $lb, $masterPos ) {
881 return $lb->waitForAll( $masterPos, 1 );
887 return ( $loop->invoke() === $loop::CONDITION_REACHED );
902 $trxProfiler = Profiler::instance()->getTransactionProfiler();
903 $oldSilenced = $trxProfiler->setSilenced(
true );
904 return new ScopedCallback(
function () use ( $trxProfiler, $oldSilenced ) {
905 $trxProfiler->setSilenced( $oldSilenced );
and that you know you can do these things To protect your we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights These restrictions translate to certain responsibilities for you if you distribute copies of the or if you modify it For if you distribute copies of such a whether gratis or for a you must give the recipients all the rights that you have You must make sure that receive or can get the source code And you must show them these terms so they know their rights We protect your rights with two and(2) offer you this license which gives you legal permission to copy
wfTimestampNow()
Convenience function; returns MediaWiki timestamp for the present time.
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
Class representing a cache/ephemeral data store.
convertToExpiry( $exptime)
Convert an optionally relative time to an absolute time.
mergeViaCas( $key, $callback, $exptime=0, $attempts=10, $flags=0)
callable[] $busyCallbacks
setLastError( $err)
Set the "last error" registry.
Class to store objects in the database.
setMulti(array $data, $expiry=0, $flags=0)
Batch insertion/replace.
getDB( $serverIndex)
Get a connection to the specified database.
changeTTL( $key, $exptime=0, $flags=0)
Change the expiration on a key if it exists.
string[] $serverTags
(server index => tag/host name)
LoadBalancer null $separateMainLB
deleteMulti(array $keys, $flags=0)
Batch deletion.
createTables()
Create shard tables.
getTableByKey( $key)
Get the server index and table name for a given key.
insertMulti(array $data, $expiry, $flags, $replace)
fetchBlobMulti(array $keys, $flags=0)
getMulti(array $keys, $flags=0)
Get an associative array containing the item for each of the keys that have items.
add( $key, $value, $exptime=0, $flags=0)
Insert an item if it does not already exist.
array[] $serverInfos
(server index => server config)
deleteAll()
Delete content of shard tables in every server.
__construct( $params)
Constructor.
doGet( $key, $flags=0, &$casToken=null)
isExpired( $db, $exptime)
handleWriteError(DBError $exception, IDatabase $db=null, $serverIndex)
Handle a DBQueryError which occurred during a write operation.
silenceTransactionProfiler()
Returns a ScopedCallback which resets the silence flag in the transaction profiler when it is destroy...
array $connFailureTimes
UNIX timestamps.
array $connFailureErrors
Exceptions.
deleteObjectsExpiringBefore( $timestamp, $progressCallback=false)
Delete objects from the database which expire before a certain date.
merge( $key, callable $callback, $exptime=0, $attempts=10, $flags=0)
Merge changes into the existing cache value (possibly creating a new one)
setAndLogDBError(DBError $exception)
serialize(&$data)
Serialize an object and, if possible, compress the representation.
markServerDown(DBError $exception, $serverIndex)
Mark a server down due to a DBConnectionError exception.
unserialize( $serial)
Unserialize and, if necessary, decompress an object.
getTableNameByShard( $index)
Get the table name for a given shard index.
incr( $key, $step=1)
Increase stored value of $key by $value while preserving its TTL.
handleReadError(DBError $exception, $serverIndex)
Handle a DBError which occurred during a read operation.
cas( $casToken, $key, $value, $exptime=0, $flags=0)
Check and set an item.
We use the convention $dbr for read and $dbw for write to help you keep track of whether the database object is a the world will explode Or to be a subsequent write query which succeeded on the master may fail when replicated to the slave due to a unique key collision Replication on the slave will stop and it may take hours to repair the database and get it back online Setting read_only in my cnf on the slave will avoid this but given the dire we prefer to have as many checks as possible We provide a but the wrapper functions like please read the documentation for tableName() and addQuotes(). You will need both of them. ------------------------------------------------------------------------ Basic query optimisation ------------------------------------------------------------------------ MediaWiki developers who need to write DB queries should have some understanding of databases and the performance issues associated with them. Patches containing unacceptably slow features will not be accepted. Unindexed queries are generally not welcome in MediaWiki
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
namespace being checked & $result
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction $rows
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation use $formDescriptor instead default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message key
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses & $ret
processing should stop and the error should be shown to the user * false
returning false will NOT prevent logging $e
$data
Utility to generate mapping file used in mw.Title (phpCharToUpper.json)
const QOS_SYNCWRITES_NONE
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))