Wikimedia\Rdbms\DBAccessObjectUtils Class Reference

Helper class for DAO classes. More...

Inherits Wikimedia\Rdbms\IDBAccessObject.

Collaboration diagram for Wikimedia\Rdbms\DBAccessObjectUtils:

Static Public Member Functions
static	getDBFromIndex (IConnectionProvider $dbProvider, int $index)
	Takes $index from ::getDBOptions() and return proper Database object.
static	getDBFromRecency (IConnectionProvider $dbProvider, int $recency)
static	getDBOptions ( $bitfield)
	Get an appropriate DB index and options.
static	hasFlags ( $bitfield, $flags)

Additional Inherited Members
Public Attributes inherited from Wikimedia\Rdbms\IDBAccessObject
const	READ_EXCLUSIVE = self::READ_LOCKING | 4
	Read from the primary/quorum and lock out other writers and locking readers.
const	READ_LATEST = 1
	Read from the primary/quorum.
const	READ_LATEST_IMMUTABLE = 8
	Read from a replica DB or without a quorum, using the primary/quorum on miss.
const	READ_LOCKING = self::READ_LATEST | 2
	Read from the primary/quorum and lock out other writers.
const	READ_NONE = -1
	Convenience constant for tracking how data was loaded (higher => higher QoS)
const	READ_NORMAL = 0
	Constants for object loading bitfield flags (higher => higher QoS)

Detailed Description

Helper class for DAO classes.

Since

1.26

Definition at line 33 of file DBAccessObjectUtils.php.

Member Function Documentation

getDBFromIndex()

static Wikimedia\Rdbms\DBAccessObjectUtils::getDBFromIndex ( IConnectionProvider $dbProvider, int $index )

static

Takes $index from ::getDBOptions() and return proper Database object.

Deprecated

since 1.42

Parameters

IConnectionProvider	$dbProvider
int	$index	either DB_REPLICA or DB_PRIMARY

Returns

IReadableDatabase

Definition at line 81 of file DBAccessObjectUtils.php.

References Wikimedia\Rdbms\IConnectionProvider\getPrimaryDatabase().

getDBFromRecency()

static Wikimedia\Rdbms\DBAccessObjectUtils::getDBFromRecency ( IConnectionProvider $dbProvider, int $recency )

static

Parameters

IConnectionProvider	$dbProvider
int	$recency	IDBAccessObject::READ_* constant

Returns

IReadableDatabase

Since

1.42

Definition at line 98 of file DBAccessObjectUtils.php.

References Wikimedia\Rdbms\IConnectionProvider\getPrimaryDatabase().

getDBOptions()

static Wikimedia\Rdbms\DBAccessObjectUtils::getDBOptions ( $bitfield )

static

Get an appropriate DB index and options.

Deprecated

since 1.43

Parameters

int

$bitfield

Bitfield of IDBAccessObject::READ_* constants

Returns

array List of DB indexes and options in this order:

• DB_PRIMARY or DB_REPLICA constant for the initial query
• SELECT options array for the initial query

Definition at line 52 of file DBAccessObjectUtils.php.

References DB_PRIMARY, DB_REPLICA, Wikimedia\Rdbms\IDBAccessObject\READ_EXCLUSIVE, Wikimedia\Rdbms\IDBAccessObject\READ_LATEST, Wikimedia\Rdbms\IDBAccessObject\READ_LATEST_IMMUTABLE, Wikimedia\Rdbms\IDBAccessObject\READ_LOCKING, and wfDeprecated().

hasFlags()

static Wikimedia\Rdbms\DBAccessObjectUtils::hasFlags ( $bitfield, $flags )

static

Parameters

int	$bitfield
int	$flags	IDBAccessObject::READ_* constant

Returns

bool Bitfield has flag $flag set

Definition at line 39 of file DBAccessObjectUtils.php.

---

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

• includes/libs/rdbms/DBAccessObjectUtils.php