3 * Base code for update jobs that put some secondary data extracted
4 * from article content into the database.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19 * http://www.gnu.org/copyleft/gpl.html
25 * Abstract base class for update jobs that put some secondary data extracted
26 * from article content into the database.
28 * @note subclasses should NOT start or commit transactions in their doUpdate() method,
29 * a transaction will automatically be wrapped around the update. Starting another
30 * one would break the outer transaction bracket. If need be, subclasses can override
31 * the beginTransaction() and commitTransaction() methods.
33 * @deprecated Since 1.28 Use DataUpdate directly, injecting the database
35 abstract class SqlDataUpdate
extends DataUpdate
{
36 /** @var IDatabase Database connection reference */
39 /** @var array SELECT options to be used (array) */
40 protected $mOptions = [];
42 /** @var bool Whether a transaction is open on this object (internal use only!) */
43 private $mHasTransaction;
45 /** @var bool Whether this update should be wrapped in a transaction */
46 protected $mUseTransaction;
51 * @param bool $withTransaction Whether this update should be wrapped in a
52 * transaction (default: true). A transaction is only started if no
53 * transaction is already in progress, see beginTransaction() for details.
55 public function __construct( $withTransaction = true ) {
56 parent
::__construct();
58 $this->mDb
= wfGetLB()->getLazyConnectionRef( DB_MASTER
);
60 $this->mWithTransaction
= $withTransaction;
61 $this->mHasTransaction
= false;
65 * Begin a database transaction, if $withTransaction was given as true in
66 * the constructor for this SqlDataUpdate.
68 * Because nested transactions are not supported by the Database class,
69 * this implementation checks Database::trxLevel() and only opens a
70 * transaction if none is already active.
72 public function beginTransaction() {
73 if ( !$this->mWithTransaction
) {
77 // NOTE: nested transactions are not supported, only start a transaction if none is open
78 if ( $this->mDb
->trxLevel() === 0 ) {
79 $this->mDb
->begin( get_class( $this ) . '::beginTransaction' );
80 $this->mHasTransaction
= true;
85 * Commit the database transaction started via beginTransaction (if any).
87 public function commitTransaction() {
88 if ( $this->mHasTransaction
) {
89 $this->mDb
->commit( get_class( $this ) . '::commitTransaction' );
90 $this->mHasTransaction
= false;
95 * Abort the database transaction started via beginTransaction (if any).
97 public function abortTransaction() {
98 if ( $this->mHasTransaction
) { // XXX: actually... maybe always?
99 $this->mDb
->rollback( get_class( $this ) . '::abortTransaction' );
100 $this->mHasTransaction
= false;