3 * Updates database rows by primary key in batches.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
21 * @ingroup Maintenance
24 use MediaWiki\MediaWikiServices
;
25 use Wikimedia\Rdbms\IDatabase
;
27 class BatchRowWriter
{
29 * @var IDatabase $db The database to write to
34 * @var string $table The name of the table to update
39 * @var string $clusterName A cluster name valid for use with LBFactory
41 protected $clusterName;
44 * @param IDatabase $db The database to write to
45 * @param string $table The name of the table to update
46 * @param string|bool $clusterName A cluster name valid for use with LBFactory
48 public function __construct( IDatabase
$db, $table, $clusterName = false ) {
50 $this->table
= $table;
51 $this->clusterName
= $clusterName;
55 * @param array $updates Array of arrays each containing two keys, 'primaryKey'
56 * and 'changes'. primaryKey must contain a map of column names to values
57 * sufficient to uniquely identify the row changes must contain a map of column
58 * names to update values to apply to the row.
60 public function write( array $updates ) {
61 $lbFactory = MediaWikiServices
::getInstance()->getDBLoadBalancerFactory();
62 $ticket = $lbFactory->getEmptyTransactionTicket( __METHOD__
);
64 foreach ( $updates as $update ) {
68 $update['primaryKey'],
73 $lbFactory->commitAndWaitForReplication( __METHOD__
, $ticket );