wiki.techinc.nl/includes/utils/BatchRowWriter.php
Holger Knust 471d2371ab doxygen: Changed Doxygen tags causing warnings during documentation generation
Updated Doxygen markup in several .php files triggering warnings when mwdocgen.php is executed. Removed
obsolete settings MSCGEN_PATH and TCL_SUBST from Doxyfile. The former would generate a warning in 1.8.16
while TCL support was removed in 1.8.18. Since TCL_SUBST was blank anyway, it was removed prior to getting
to .18 in production. Increased DOT_GRAPH_MAX_NODES from 50 to 200 since Doxygen complained about it being
too low for API and Maintenance.

Bug: T248706
Change-Id: I9c67f0807d1b43089d351263d4f591dee5501f36
2020-04-14 03:25:19 +00:00

76 lines
2.3 KiB
PHP

<?php
/**
* Updates database rows by primary key in batches.
*
* 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 Maintenance
*/
use MediaWiki\MediaWikiServices;
use Wikimedia\Rdbms\IDatabase;
class BatchRowWriter {
/**
* @var IDatabase The database to write to
*/
protected $db;
/**
* @var string The name of the table to update
*/
protected $table;
/**
* @var string|false A cluster name valid for use with LBFactory
*/
protected $clusterName;
/**
* @param IDatabase $db The database to write to
* @param string $table The name of the table to update
* @param string|false $clusterName A cluster name valid for use with LBFactory
*/
public function __construct( IDatabase $db, $table, $clusterName = false ) {
$this->db = $db;
$this->table = $table;
$this->clusterName = $clusterName;
}
/**
* @param array[][] $updates Array of arrays each containing two keys, 'primaryKey'
* and 'changes'. primaryKey must contain a map of column names to values
* sufficient to uniquely identify the row. changes must contain a map of column
* names to update values to apply to the row.
* @phan-param array<int,array{primaryKey:array,changes:array}> $updates
*/
public function write( array $updates ) {
$lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
$ticket = $lbFactory->getEmptyTransactionTicket( __METHOD__ );
foreach ( $updates as $update ) {
$this->db->update(
$this->table,
$update['changes'],
$update['primaryKey'],
__METHOD__
);
}
$lbFactory->commitAndWaitForReplication( __METHOD__, $ticket );
}
}