An LBFactory class that always returns a single database object. More...

Inheritance diagram for Wikimedia\Rdbms\LBFactorySingle:

Collaboration diagram for Wikimedia\Rdbms\LBFactorySingle:

[legend]

Public Member Functions
	__construct (array $conf)

	__destruct ()

	forEachLB ( $callback, array $params=[])
	Execute a function for each currently tracked (instantiated) load balancer. More...

	getAllExternalLBs ()
	Get cached (tracked) load balancers for all external database clusters. More...

	getAllMainLBs ()
	Get cached (tracked) load balancers for all main database clusters. More...

	getExternalLB ( $cluster)
	Get a cached (tracked) load balancer for external storage. More...

	getMainLB ( $domain=false)
	Get a cached (tracked) load balancer object. More...

	newExternalLB ( $cluster, $owner=null)
	Create a new load balancer for external storage. More...

	newMainLB ( $domain=false, $owner=null)
	Create a new load balancer object. More...

Public Member Functions inherited from Wikimedia\Rdbms\LBFactory
	appendShutdownCPIndexAsQuery ( $url, $index)
	Append ?cpPosIndex parameter to a URL for ChronologyProtector purposes if needed. More...

	beginMasterChanges ( $fname=__METHOD__)
	Flush any master transaction snapshots and set DBO_TRX (if DBO_DEFAULT is set) More...

	closeAll ()
	Close all open database connections on all open load balancers. More...

	commitAll ( $fname=__METHOD__, array $options=[])
	Commit open transactions on all connections. More...

	commitAndWaitForReplication ( $fname, $ticket, array $opts=[])
	Convenience method for safely running commitMasterChanges()/waitForReplication() More...

	commitMasterChanges ( $fname=__METHOD__, array $options=[])
	Commit changes and clear view snapshots on all master connections. More...

	destroy ()
	Disables all load balancers. More...

	disableChronologyProtection ()
	Disable the ChronologyProtector for all load balancers. More...

	flushReplicaSnapshots ( $fname=__METHOD__)
	Commit all replica DB transactions so as to flush any REPEATABLE-READ or SSI snapshot. More...

	getChronologyProtectorClientId ()
	Get the client ID of the ChronologyProtector instance. More...

	getChronologyProtectorTouched ( $domain=false)
	Get the UNIX timestamp when the client last touched the DB, if they did so recently. More...

	getEmptyTransactionTicket ( $fname)
	Get a token asserting that no transaction writes are active. More...

	getLocalDomainID ()
	Get the local (and default) database domain ID of connection handles. More...

	getTransactionProfiler ()
	Get a TransactionProfiler used by this instance. More...

	hasMasterChanges ()
	Determine if any master connection has pending changes. More...

	hasOrMadeRecentMasterChanges ( $age=null)
	Determine if any master connection has pending/written changes from this request. More...

	hasTransactionRound ()
	Check if an explicit transaction round is active. More...

	isReadyForRoundOperations ()
	Check if transaction rounds can be started, committed, or rolled back right now. More...

	laggedReplicaUsed ()
	Detemine if any lagged replica DB connection was used. More...

	redefineLocalDomain ( $domain)
	Close all connection and redefine the local domain for testing or schema creation. More...

	resolveDomainID ( $domain)

	rollbackMasterChanges ( $fname=__METHOD__)
	Rollback changes on all master connections. More...

	setAgentName ( $agent)

	setDefaultReplicationWaitTimeout ( $seconds)

	setDomainAliases (array $aliases)
	Convert certain database domains to alternative ones. More...

	setIndexAliases (array $aliases)
	Convert certain index names to alternative names before querying the DB. More...

	setLocalDomainPrefix ( $prefix)
	Set a new table prefix for the existing local domain ID for testing. More...

	setMockTime (&$time)

	setRequestInfo (array $info)

	setTableAliases (array $aliases)
	Make certain table names use their own database, schema, and table prefix when passed into SQL queries pre-escaped and without a qualified database name. More...

	setWaitForReplicationListener ( $name, callable $callback=null)
	Add a callback to be run in every call to waitForReplication() before waiting. More...

	shutdown ( $flags=self::SHUTDOWN_NORMAL, callable $workCallback=null, &$cpIndex=null, &$cpClientId=null)
	Prepare all currently tracked (instantiated) load balancers for shutdown. More...

	waitForReplication (array $opts=[])
	Waits for the replica DBs to catch up to the current master position. More...

Static Public Member Functions
static	newFromConnection (IDatabase $db, array $params=[])

Static Public Member Functions inherited from Wikimedia\Rdbms\LBFactory
static	getCPInfoFromCookieValue ( $value, $minTimestamp)

static	makeCookieValueFromCPIndex ( $index, $time, $clientId)

Private Attributes
LoadBalancerSingle	$lb

Additional Inherited Members
Public Attributes inherited from Wikimedia\Rdbms\ILBFactory
const	SHUTDOWN_NO_CHRONPROT = 1
	Do not save "session consistency" DB replication positions. More...

const	SHUTDOWN_NORMAL = 0
	Idion for "no special shutdown flags". More...

Protected Member Functions inherited from Wikimedia\Rdbms\LBFactory
	baseLoadBalancerParams ( $owner)
	Get parameters to ILoadBalancer::__construct() More...

	forEachLBCallMethod ( $methodName, array $args=[])
	Call a method of each tracked load balancer. More...

	getChronologyProtector ()

	getOwnershipId ()

	initLoadBalancer (ILoadBalancer $lb)

	resolveDomainInstance ( $domain)

	shutdownChronologyProtector (ChronologyProtector $cp, $workCallback, &$cpIndex=null)
	Get and record all of the staged DB positions into persistent memory storage. More...

Protected Attributes inherited from Wikimedia\Rdbms\LBFactory
BagOStuff	$cpStash

DatabaseDomain	$localDomain
	Local domain. More...

int null	$maxLag

string bool	$readOnlyReason = false
	Reason all LBs are read-only or false if not. More...

BagOStuff	$srvCache

WANObjectCache	$wanCache

Detailed Description

An LBFactory class that always returns a single database object.

Definition at line 32 of file LBFactorySingle.php.

Constructor & Destructor Documentation

◆ __construct()

Wikimedia\Rdbms\LBFactorySingle::__construct ( array $conf )

Parameters

array

$conf

An associative array with one member:

connection: The IDatabase connection object

Reimplemented from Wikimedia\Rdbms\LBFactory.

Definition at line 40 of file LBFactorySingle.php.

References Wikimedia\Rdbms\LBFactorySingle\$lb, Wikimedia\Rdbms\LBFactory\baseLoadBalancerParams(), Wikimedia\Rdbms\LBFactory\getOwnershipId(), and Wikimedia\Rdbms\LBFactory\initLoadBalancer().

◆ __destruct()

Wikimedia\Rdbms\LBFactorySingle::__destruct ( )

Reimplemented from Wikimedia\Rdbms\LBFactory.

Definition at line 100 of file LBFactorySingle.php.

Member Function Documentation

◆ forEachLB()

Wikimedia\Rdbms\LBFactorySingle::forEachLB	(		$callback,
		array	$params = `[]`
	)

Execute a function for each currently tracked (instantiated) load balancer.

The callback is called with the load balancer as the first parameter, and $params passed as the subsequent parameters.

Parameters

callable	$callback
array	$params

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 94 of file LBFactorySingle.php.

◆ getAllExternalLBs()

Wikimedia\Rdbms\LBFactorySingle::getAllExternalLBs ( )

Get cached (tracked) load balancers for all external database clusters.

Returns: ILoadBalancer[] Map of (cluster name => ILoadBalancer)

Since: 1.29

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 90 of file LBFactorySingle.php.

◆ getAllMainLBs()

Wikimedia\Rdbms\LBFactorySingle::getAllMainLBs ( )

Get cached (tracked) load balancers for all main database clusters.

The default cluster name is ILoadBalancer::CLUSTER_MAIN_DEFAULT

Returns: ILoadBalancer[] Map of (cluster name => ILoadBalancer)

Since: 1.29

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 86 of file LBFactorySingle.php.

References Wikimedia\Rdbms\LBFactorySingle\$lb.

◆ getExternalLB()

Wikimedia\Rdbms\LBFactorySingle::getExternalLB ( $cluster )

Get a cached (tracked) load balancer for external storage.

Parameters

string $cluster External storage cluster name

Returns: ILoadBalancer

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 82 of file LBFactorySingle.php.

◆ getMainLB()

Wikimedia\Rdbms\LBFactorySingle::getMainLB ( $domain = false )

Get a cached (tracked) load balancer object.

Parameters

bool | string $domain Domain ID, or false for the current domain

Returns: ILoadBalancer

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 74 of file LBFactorySingle.php.

References Wikimedia\Rdbms\LBFactorySingle\$lb.

◆ newExternalLB()

Wikimedia\Rdbms\LBFactorySingle::newExternalLB	(	$cluster,
		$owner = `null`
	)

Create a new load balancer for external storage.

The resulting object will be untracked, not chronology-protected, and the caller is responsible for cleaning it up.

This method is for only advanced usage and callers should almost always use getExternalLB() instead. This method can be useful when a table is used as a key/value store. In that cases, one might want to query it in autocommit mode (DBO_TRX off) but still use DBO_TRX transaction rounds on other tables.

Parameters

string	$cluster	External storage cluster name
int \| null	$owner	Owner ID of the new instance (e.g. this LBFactory ID)

Returns: ILoadBalancer

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 78 of file LBFactorySingle.php.

◆ newFromConnection()

static Wikimedia\Rdbms\LBFactorySingle::newFromConnection	(	IDatabase	$db,
		array	$params = `[]`
	)

static

Parameters

IDatabase	$db	Live connection handle
array	$params	Parameter map to LBFactorySingle::__constructs()

Returns: LBFactorySingle

Since: 1.28

Definition at line 62 of file LBFactorySingle.php.

References Wikimedia\Rdbms\IDatabase\getDomainID().

◆ newMainLB()

Wikimedia\Rdbms\LBFactorySingle::newMainLB	(	$domain = `false`,
		$owner = `null`
	)

Create a new load balancer object.

The resulting object will be untracked, not chronology-protected, and the caller is responsible for cleaning it up.

This method is for only advanced usage and callers should almost always use getMainLB() instead. This method can be useful when a table is used as a key/value store. In that cases, one might want to query it in autocommit mode (DBO_TRX off) but still use DBO_TRX transaction rounds on other tables.

Parameters

bool \| string	$domain	Domain ID, or false for the current domain
int \| null	$owner	Owner ID of the new instance (e.g. this LBFactory ID)

Returns: ILoadBalancer

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 70 of file LBFactorySingle.php.

Member Data Documentation

◆ $lb

LoadBalancerSingle Wikimedia\Rdbms\LBFactorySingle::$lb

private

Definition at line 34 of file LBFactorySingle.php.

Referenced by Wikimedia\Rdbms\LBFactorySingle\__construct(), Wikimedia\Rdbms\LBFactorySingle\getAllMainLBs(), and Wikimedia\Rdbms\LBFactorySingle\getMainLB().

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

includes/libs/rdbms/lbfactory/LBFactorySingle.php

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

◆ __destruct()

Member Function Documentation

◆ forEachLB()

◆ getAllExternalLBs()

◆ getAllMainLBs()

◆ getExternalLB()

◆ getMainLB()

◆ newExternalLB()

◆ newFromConnection()

◆ newMainLB()

Member Data Documentation

◆ $lb