MediaWiki master
BatchRowWriter Class Reference
Collaboration diagram for BatchRowWriter:

Public Member Functions

 __construct (IDatabase $db, $table, $clusterName=false)
 
 setCaller ( $caller)
 Use ->setCaller( METHOD ) to indicate which code is using this class.
 
 write (array $updates)
 

Protected Attributes

string null $caller
 For debugging which method is using this class.
 
string false $clusterName
 A cluster name valid for use with LBFactory.
 
IDatabase $db
 The database to write to.
 
string $table
 The name of the table to update.
 

Detailed Description

Definition at line 27 of file BatchRowWriter.php.

Constructor & Destructor Documentation

◆ __construct()

BatchRowWriter::__construct ( IDatabase $db,
$table,
$clusterName = false )
Parameters
IDatabase$dbThe database to write to
string$tableThe name of the table to update
string | false$clusterNameA cluster name valid for use with LBFactory

Definition at line 53 of file BatchRowWriter.php.

References $clusterName, $db, and $table.

Member Function Documentation

◆ setCaller()

BatchRowWriter::setCaller ( $caller)

Use ->setCaller( METHOD ) to indicate which code is using this class.

Only used in debugging output.

Since
1.36
Parameters
string$caller
Returns
self

Definition at line 67 of file BatchRowWriter.php.

References $caller.

◆ write()

BatchRowWriter::write ( array $updates)
Parameters
array[][]$updatesArray of arrays each containing two keys, 'primaryKey' and 'changes'. primaryKey must contain a map of column names to values sufficient to uniquely identify the row. changes must contain a map of column names to update values to apply to the row.

Definition at line 79 of file BatchRowWriter.php.

References $caller.

Member Data Documentation

◆ $caller

string null BatchRowWriter::$caller
protected

For debugging which method is using this class.

Definition at line 46 of file BatchRowWriter.php.

Referenced by setCaller(), and write().

◆ $clusterName

string false BatchRowWriter::$clusterName
protected

A cluster name valid for use with LBFactory.

Definition at line 41 of file BatchRowWriter.php.

Referenced by __construct().

◆ $db

IDatabase BatchRowWriter::$db
protected

The database to write to.

Definition at line 31 of file BatchRowWriter.php.

Referenced by __construct().

◆ $table

string BatchRowWriter::$table
protected

The name of the table to update.

Definition at line 36 of file BatchRowWriter.php.

Referenced by __construct().


The documentation for this class was generated from the following file: