1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
|
<?php
/*
* Ties together the batch update components to provide a composable
* method of batch updating rows in a database. To use create a class
* implementing the RowUpdateGenerator interface and configure the
* BatchRowIterator and BatchRowWriter for access to the correct table.
* The components will handle reading, writing, and waiting for replica DBs
* while the generator implementation handles generating update arrays
* for singular rows.
*
* Instantiate:
* $updater = new BatchRowUpdate(
* new BatchRowIterator( $dbr, 'some_table', 'primary_key_column', 500 ),
* new BatchRowWriter( $dbw, 'some_table', 'clusterName' ),
* new MyImplementationOfRowUpdateGenerator
* );
*
* Run:
* $updater->execute();
*
* An example maintenance script utilizing the BatchRowUpdate can be
* located in the Echo extension file maintenance/updateSchema.php
*
* 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
*/
class BatchRowUpdate {
/**
* @var BatchRowIterator $reader Iterator that returns an array of
* database rows
*/
protected $reader;
/**
* @var BatchRowWriter $writer Writer capable of pushing row updates
* to the database
*/
protected $writer;
/**
* @var RowUpdateGenerator $generator Generates single row updates
* based on the rows content
*/
protected $generator;
/**
* @var callable $output Output callback
*/
protected $output;
/**
* @param BatchRowIterator $reader Iterator that returns an
* array of database rows
* @param BatchRowWriter $writer Writer capable of pushing
* row updates to the database
* @param RowUpdateGenerator $generator Generates single row updates
* based on the rows content
*/
public function __construct(
BatchRowIterator $reader, BatchRowWriter $writer, RowUpdateGenerator $generator
) {
$this->reader = $reader;
$this->writer = $writer;
$this->generator = $generator;
$this->output = function () {
}; // nop
}
/**
* Runs the batch update process
*/
public function execute() {
foreach ( $this->reader as $rows ) {
$updates = [];
foreach ( $rows as $row ) {
$update = $this->generator->update( $row );
if ( $update ) {
$updates[] = [
'primaryKey' => $this->reader->extractPrimaryKeys( $row ),
'changes' => $update,
];
}
}
if ( $updates ) {
$this->output( "Processing " . count( $updates ) . " rows\n" );
$this->writer->write( $updates );
}
}
$this->output( "Completed\n" );
}
/**
* Accepts a callable which will receive a single parameter
* containing string status updates
*
* @param callable $output A callback taking a single string
* parameter to output
*/
public function setOutput( callable $output ) {
$this->output = $output;
}
/**
* Write out a status update
*
* @param string $text The value to print
*/
protected function output( $text ) {
call_user_func( $this->output, $text );
}
}
|
