includes/utils/BatchRowWriter.php

   1 <?php
   2 /**
   3  * Updates database rows by primary key in batches.
   4  *
   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.
   9  *
  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.
  14  *
  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
  19  *
  20  * @file
  21  * @ingroup Maintenance
  22  */
  23 use Wikimedia\Rdbms\IDatabase;
  24 use \MediaWiki\MediaWikiServices;
  25
  26 class BatchRowWriter {
  27         /**
  28          * @var IDatabase $db The database to write to
  29          */
  30         protected $db;
  31
  32         /**
  33          * @var string $table The name of the table to update
  34          */
  35         protected $table;
  36
  37         /**
  38          * @var string $clusterName A cluster name valid for use with LBFactory
  39          */
  40         protected $clusterName;
  41
  42         /**
  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
  46          */
  47         public function __construct( IDatabase $db, $table, $clusterName = false ) {
  48                 $this->db = $db;
  49                 $this->table = $table;
  50                 $this->clusterName = $clusterName;
  51         }
  52
  53         /**
  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.
  58          */
  59         public function write( array $updates ) {
  60                 $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
  61                 $ticket = $lbFactory->getEmptyTransactionTicket( __METHOD__ );
  62
  63                 foreach ( $updates as $update ) {
  64                         $this->db->update(
  65                                 $this->table,
  66                                 $update['changes'],
  67                                 $update['primaryKey'],
  68                                 __METHOD__
  69                         );
  70                 }
  71
  72                 $lbFactory->commitAndWaitForReplication( __METHOD__, $ticket );
  73         }
  74 }