* @todo Replace calls to wfGetDB with calls to LoadBalancer::getConnection()
* on an injected instance of LoadBalancer.
*
- * @return DatabaseBase
+ * @return Database
*/
function wfGetDB( $db, $groups = [], $wiki = false ) {
return wfGetLB( $wiki )->getConnection( $db, $groups, $wiki );
}
/**
- * @return DatabaseBase
+ * @return Database
* @throws MWException
*/
private function getConnection() {
/**
* Gets a default replica DB connection object
- * @return DatabaseBase
+ * @return Database
*/
protected function getDB() {
if ( !isset( $this->mSlaveDB ) ) {
/**
* Get the database connection (read-only)
- * @return DatabaseBase
+ * @return Database
*/
protected function getDB() {
return $this->mDbSource->getDB();
* @param string $name Name to assign to the database connection
* @param int $db One of the DB_* constants
* @param array $groups Query groups
- * @return DatabaseBase
+ * @return Database
*/
public function getNamedDB( $name, $db, $groups ) {
if ( !array_key_exists( $name, $this->mNamedDB ) ) {
* which may not necessarily be the same as the local DB.
*
* TODO: allow querying non-local repos.
- * @return DatabaseBase
+ * @return Database
*/
protected function getDB() {
return $this->mRepo->getSlaveDB();
/**
* Get the Query database connection (read-only)
- * @return DatabaseBase
+ * @return Database
*/
protected function getDB() {
if ( is_null( $this->mDb ) ) {
* @param string $name Name to assign to the database connection
* @param int $db One of the DB_* constants
* @param array $groups Query groups
- * @return DatabaseBase
+ * @return Database
*/
public function selectNamedDB( $name, $db, $groups ) {
$this->mDb = $this->getQuery()->getNamedDB( $name, $db, $groups );
/**
* Get the replica DB connection to the database
* When non existing, will initialize the connection.
- * @return DatabaseBase
+ * @return Database
*/
protected function getDB() {
if ( !isset( $this->db ) ) {
* @param int $id Which connection to use
* @param array $groups Query groups
*
- * @return DatabaseBase
+ * @return Database
*/
protected function getConnection( $id, $groups = [] ) {
$loadBalancer = wfGetLB( $this->wiki );
/**
* Get a connection to the replica DB
- * @return DatabaseBase
+ * @return Database
*/
function getSlaveDB() {
return wfGetDB( DB_REPLICA );
/**
* Get a connection to the master DB
- * @return DatabaseBase
+ * @return Database
*/
function getMasterDB() {
return wfGetDB( DB_MASTER );
/**
* The database connection.
*
- * @var DatabaseBase
+ * @var Database
*/
public $db = null;
/**
* Handle to the database subclass
*
- * @var DatabaseBase
+ * @var Database
*/
protected $db;
/**
* Get a database connection to run updates
*
- * @return DatabaseBase
+ * @return Database
*/
public function getDB() {
return $this->db;
return $status;
}
/**
- * @var $conn DatabaseBase
+ * @var $conn Database
*/
$conn = $status->value;
return;
}
/**
- * @var $conn DatabaseBase
+ * @var $conn Database
*/
$conn = $status->value;
$conn->selectDB( $this->getVar( 'wgDBname' ) );
return $status;
}
/**
- * @var $conn DatabaseBase
+ * @var $conn Database
*/
$conn = $status->value;
return;
}
/**
- * @var $conn DatabaseBase
+ * @var $conn Database
*/
$conn = $status->value;
$conn->selectDB( $this->getVar( 'wgDBname' ) );
$status = $this->getConnection();
/**
- * @var $conn DatabaseBase
+ * @var $conn Database
*/
$conn = $status->value;
}
/**
- * @var $conn DatabaseBase
+ * @var $conn Database
*/
$conn = $status->value;
return $status;
}
/**
- * @var $conn DatabaseBase
+ * @var $conn Database
*/
$conn = $status->value;
if ( $status->isOK() ) {
/**
- * @var $conn DatabaseBase
+ * @var $conn Database
*/
$conn = $status->value;
$conn->clearFlag( DBO_TRX );
$status = $this->openPgConnection( 'create-schema' );
if ( $status->isOK() ) {
/**
- * @var $conn DatabaseBase
+ * @var $conn Database
*/
$conn = $status->value;
$safeRole = $conn->addIdentifierQuotes( $this->getVar( 'wgDBuser' ) );
return false;
}
/**
- * @var $conn DatabaseBase
+ * @var $conn Database
*/
$conn = $status->value;
$superuser = $this->getVar( '_InstallUser' );
}
/**
- * @var $conn DatabaseBase
+ * @var $conn Database
*/
$conn = $status->value;
return $status;
}
/**
- * @var $conn DatabaseBase
+ * @var $conn Database
*/
$conn = $status->value;
* - user : DB user
* - password : DB user password
* - tablePrefix : DB table prefix
- * - flags : DB flags (see DatabaseBase)
+ * - flags : DB flags; bitfield of IDatabase::DBO_* constants
* - dbsByBucket : Array of 1-16 consecutive integer keys, starting from 0,
* each having an odd-numbered list of DB names (peers) as values.
* - lockExpiry : Lock timeout (seconds) for dropped connections. [optional]
/**
* Get a database connection for the bot passwords database
* @param int $db Index of the connection to get, e.g. DB_MASTER or DB_REPLICA.
- * @return DatabaseBase
+ * @return Database
*/
public static function getDB( $db ) {
global $wgBotPasswordsCluster, $wgBotPasswordsDatabase;
/**
* Lock the search index
- * @param DatabaseBase &$db
+ * @param Database &$db
*/
private function lockSearchindex( $db ) {
$write = [ 'searchindex' ];
/**
* Unlock the tables
- * @param DatabaseBase &$db
+ * @param Database &$db
*/
private function unlockSearchindex( $db ) {
$db->unlockTables( __CLASS__ . '::' . __METHOD__ );
/**
* Unlock and lock again
* Since the lock is low-priority, queued reads will be able to complete
- * @param DatabaseBase &$db
+ * @param Database &$db
*/
private function relockSearchindex( $db ) {
$this->unlockSearchindex( $db );
* Perform a search index update with locking
* @param int $maxLockTime The maximum time to keep the search index locked.
* @param string $callback The function that will update the function.
- * @param DatabaseBase $dbw
+ * @param Database $dbw
* @param array $results
*/
public function updateSearchIndex( $maxLockTime, $callback, $dbw, $results ) {
/**
* Update the searchindex table for a given pageid
- * @param DatabaseBase $dbw A database write handle
+ * @param Database $dbw A database write handle
* @param int $pageId The page ID to update.
* @return null|string
*/
class UpdateLogging {
/**
- * @var DatabaseBase
+ * @var Database
*/
public $dbw;
public $batchSize = 1000;
}
/**
- * @param DatabaseBase $dbw
+ * @param Database $dbw
* @return void
*/
private function insertData( $dbw ) {
}
/**
- * @param DatabaseBase $dbw
+ * @param Database $dbw
* @return void
*/
private function delete( $dbw ) {
}
/**
- * @param DatabaseBase $dbw
+ * @param Database $dbw
* @return void
*/
private function truncate( $dbw ) {
/**
* @param ResultWrapper $res
- * @param DatabaseBase $dbw
+ * @param Database $dbw
* @return null|int
*/
function convertOptionBatch( $res, $dbw ) {
* Do this inside a transaction
*
* @param array $id Array of revision id values
- * @param DatabaseBase $dbw DatabaseBase class (needs to be a master)
+ * @param Database $dbw Database class (needs to be a master)
*/
private function deleteRevs( $id, &$dbw ) {
if ( !is_array( $id ) ) {
/**
* Callback function for each revision, child classes should override
* processRevision instead.
- * @param DatabaseBase $rev
+ * @param Database $rev
*/
public function handleRevision( $rev ) {
$title = $rev->getTitle();
protected $checkpointFiles = [];
/**
- * @var DatabaseBase
+ * @var Database
*/
protected $db;
/**
* May throw a database error if, say, the server dies during query.
- * @param DatabaseBase $db
+ * @param Database $db
* @param int $id The old_id
* @return string
*/
class NamespaceConflictChecker extends Maintenance {
/**
- * @var DatabaseBase
+ * @var Database
*/
protected $db;
/**
* Lock the appropriate tables for the script
- * @param DatabaseBase $db
+ * @param Database $db
* @param string $extraTable The name of any extra tables to lock (eg: text)
*/
private function lockTables( $db, $extraTable = [] ) {
}
}
- private function updatePageRows( DatabaseBase $dbw, $pageIds, $model ) {
+ private function updatePageRows( Database $dbw, $pageIds, $model ) {
$count = count( $pageIds );
$this->output( "Setting $count rows to $model..." );
$dbw->update(
$this->output( "done.\n" );
}
- protected function populatePage( DatabaseBase $dbw, $ns ) {
+ protected function populatePage( Database $dbw, $ns ) {
$toSave = [];
$lastId = 0;
$nsCondition = $ns === 'all' ? [] : [ 'page_namespace' => $ns ];
}
}
- private function updateRevisionOrArchiveRows( DatabaseBase $dbw, $ids, $model, $table ) {
+ private function updateRevisionOrArchiveRows( Database $dbw, $ids, $model, $table ) {
$prefix = $table === 'archive' ? 'ar' : 'rev';
$model_column = "{$prefix}_content_model";
$format_column = "{$prefix}_content_format";
$this->output( "done.\n" );
}
- protected function populateRevisionOrArchive( DatabaseBase $dbw, $table, $ns ) {
+ protected function populateRevisionOrArchive( Database $dbw, $table, $ns ) {
$prefix = $table === 'archive' ? 'ar' : 'rev';
$model_column = "{$prefix}_content_model";
$format_column = "{$prefix}_content_format";
return __CLASS__;
}
- protected function buildUpdateCondition( DatabaseBase $dbw ) {
+ protected function buildUpdateCondition( Database $dbw ) {
$rcNew = $dbw->addQuotes( RC_NEW );
$rcSrcNew = $dbw->addQuotes( RecentChange::SRC_NEW );
$rcEdit = $dbw->addQuotes( RC_EDIT );
class ImageBuilder extends Maintenance {
/**
- * @var DatabaseBase
+ * @var Database
*/
protected $dbw;
const RTI_CHUNK_SIZE = 500;
/**
- * @var DatabaseBase
+ * @var Database
*/
private $db;
class RefreshImageMetadata extends Maintenance {
/**
- * @var DatabaseBase
+ * @var Database
*/
protected $dbw;
}
/**
- * @param DatabaseBase $dbw
+ * @param Database $dbw
* @return array
*/
function getConditions( $dbw ) {
/**
* Gets a DB master connection for the given external cluster name
* @param string $cluster
- * @return DatabaseBase
+ * @return Database
*/
function getExtDB( $cluster ) {
$lb = wfGetLBFactory()->getExternalLB( $cluster );
* Return an SQL expression selecting rows which sort above the given row,
* assuming an ordering of cl_collation, cl_to, cl_type, cl_from
* @param stdClass $row
- * @param DatabaseBase $dbw
+ * @param Database $dbw
* @return string
*/
function getBatchCondition( $row, $dbw ) {