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
23 use Wikimedia\Rdbms\IDatabase;
24 use \MediaWiki\MediaWikiServices;
26 class BatchRowWriter {
28 * @var IDatabase $db The database to write to
33 * @var string $table The name of the table to update
38 * @var string $clusterName A cluster name valid for use with LBFactory
40 protected $clusterName;
43 * @param IDatabase $db The database to write to
44 * @param string $table The name of the table to update
45 * @param string|bool $clusterName A cluster name valid for use with LBFactory
47 public function __construct( IDatabase $db, $table, $clusterName = false ) {
49 $this->table = $table;
50 $this->clusterName = $clusterName;
54 * @param array $updates Array of arrays each containing two keys, 'primaryKey'
55 * and 'changes'. primaryKey must contain a map of column names to values
56 * sufficient to uniquely identify the row changes must contain a map of column
57 * names to update values to apply to the row.
59 public function write( array $updates ) {
60 $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
61 $ticket = $lbFactory->getEmptyTransactionTicket( __METHOD__ );
63 foreach ( $updates as $update ) {
67 $update['primaryKey'],
72 $lbFactory->commitAndWaitForReplication( __METHOD__, $ticket );