MediaWiki REL1_33
Wikimedia\Rdbms\LBFactory Class Reference

An interface for generating database load balancers. More...

Inheritance diagram for Wikimedia\Rdbms\LBFactory:
Collaboration diagram for Wikimedia\Rdbms\LBFactory:

Public Member Functions

 __construct (array $conf)
 Construct a manager of ILoadBalancer objects.
 
 __destruct ()
 
 appendShutdownCPIndexAsQuery ( $url, $index)
 Append ?cpPosIndex parameter to a URL for ChronologyProtector purposes if needed.
 
 beginMasterChanges ( $fname=__METHOD__)
 Flush any master transaction snapshots and set DBO_TRX (if DBO_DEFAULT is set)
 
 closeAll ()
 Close all open database connections on all open load balancers.
 
 commitAll ( $fname=__METHOD__, array $options=[])
 Commit open transactions on all connections.
 
 commitAndWaitForReplication ( $fname, $ticket, array $opts=[])
 Convenience method for safely running commitMasterChanges()/waitForReplication()
 
 commitMasterChanges ( $fname=__METHOD__, array $options=[])
 Commit changes and clear view snapshots on all master connections.
 
 destroy ()
 Disables all load balancers.
 
 disableChronologyProtection ()
 Disable the ChronologyProtector for all load balancers.
 
 flushReplicaSnapshots ( $fname=__METHOD__)
 Commit all replica DB transactions so as to flush any REPEATABLE-READ or SSI snapshot.
 
 getChronologyProtectorTouched ( $dbName)
 
 getEmptyTransactionTicket ( $fname)
 Get a token asserting that no transaction writes are active.
 
 getExternalLB ( $cluster)
 
 getLocalDomainID ()
 Get the local (and default) database domain ID of connection handles.
 
 getMainLB ( $domain=false)
 
 hasMasterChanges ()
 Determine if any master connection has pending changes.
 
 hasOrMadeRecentMasterChanges ( $age=null)
 Determine if any master connection has pending/written changes from this request.
 
 hasTransactionRound ()
 Check if an explicit transaction round is active.
 
 isReadyForRoundOperations ()
 Check if transaction rounds can be started, committed, or rolled back right now.
 
 laggedReplicaUsed ()
 Detemine if any lagged replica DB connection was used.
 
 newExternalLB ( $cluster)
 
 newMainLB ( $domain=false)
 
 redefineLocalDomain ( $domain)
 Close all connection and redefine the local domain for testing or schema creation.
 
 resolveDomainID ( $domain)
 
 rollbackMasterChanges ( $fname=__METHOD__)
 Rollback changes on all master connections.
 
 setAgentName ( $agent)
 
 setDomainPrefix ( $prefix)
 
 setIndexAliases (array $aliases)
 Convert certain index names to alternative names before querying the DB.
 
 setLocalDomainPrefix ( $prefix)
 Set a new table prefix for the existing local domain ID for testing.
 
 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.
 
 setWaitForReplicationListener ( $name, callable $callback=null)
 Add a callback to be run in every call to waitForReplication() before waiting.
 
 shutdown ( $mode=self::SHUTDOWN_CHRONPROT_SYNC, callable $workCallback=null, &$cpIndex=null, &$cpClientId=null)
 Prepare all tracked load balancers for shutdown.
 
 waitForReplication (array $opts=[])
 Waits for the replica DBs to catch up to the current master position.
 
- Public Member Functions inherited from Wikimedia\Rdbms\ILBFactory
 forEachLB ( $callback, array $params=[])
 Execute a function for each tracked load balancer The callback is called with the load balancer as the first parameter, and $params passed as the subsequent parameters.
 
 getAllExternalLBs ()
 Get cached (tracked) load balancers for all external database clusters.
 
 getAllMainLBs ()
 Get cached (tracked) load balancers for all main database clusters.
 

Static Public Member Functions

static getCPInfoFromCookieValue ( $value, $minTimestamp)
 
static makeCookieValueFromCPIndex ( $index, $time, $clientId)
 

Public Attributes

const ROUND_BEGINNING = 'within-begin'
 
const ROUND_COMMIT_CALLBACKS = 'within-commit-callbacks'
 
const ROUND_COMMITTING = 'within-commit'
 
const ROUND_CURSORY = 'cursory'
 
const ROUND_ROLLBACK_CALLBACKS = 'within-rollback-callbacks'
 
const ROUND_ROLLING_BACK = 'within-rollback'
 
- Public Attributes inherited from Wikimedia\Rdbms\ILBFactory
const SHUTDOWN_CHRONPROT_ASYNC = 1
 
const SHUTDOWN_CHRONPROT_SYNC = 2
 
const SHUTDOWN_NO_CHRONPROT = 0
 

Protected Member Functions

 baseLoadBalancerParams ()
 Base parameters to ILoadBalancer::__construct()
 
 forEachLBCallMethod ( $methodName, array $args=[])
 Call a method of each tracked load balancer.
 
 getChronologyProtector ()
 
 initLoadBalancer (ILoadBalancer $lb)
 
 shutdownChronologyProtector (ChronologyProtector $cp, $workCallback, $mode, &$cpIndex=null)
 Get and record all of the staged DB positions into persistent memory storage.
 

Protected Attributes

DatabaseDomain $localDomain
 Local domain.
 
int null $maxLag
 
BagOStuff $memStash
 
string bool $readOnlyReason = false
 Reason all LBs are read-only or false if not.
 
BagOStuff $srvCache
 
WANObjectCache $wanCache
 

Private Member Functions

 assertTransactionRoundStage ( $stage)
 
 executePostTransactionCallbacks ()
 
 logIfMultiDbTransaction ()
 Log query info if multi DB transactions are going to be committed now.
 

Private Attributes

string $agent
 Agent name for query profiling.
 
ChronologyProtector $chronProt
 
bool $cliMode
 Whether this PHP instance is for a CLI script.
 
LoggerInterface $connLogger
 
string null $defaultGroup = null
 
callable $deprecationLogger
 Deprecation logger.
 
callable $errorLogger
 Error logger.
 
string $hostname
 Local hostname of the app server.
 
string[] $indexAliases = []
 Map of (index alias => index)
 
LoggerInterface $perfLogger
 
object string $profiler
 Class name or object With profileIn/profileOut methods.
 
LoggerInterface $queryLogger
 
callable[] $replicationWaitCallbacks = []
 
LoggerInterface $replLogger
 
array $requestInfo
 Web request information about the client.
 
 $tableAliases = []
 
mixed $ticket
 
TransactionProfiler $trxProfiler
 
string bool $trxRoundId = false
 String if a requested DBO_TRX transaction round is active.
 
string $trxRoundStage = self::ROUND_CURSORY
 One of the ROUND_* class constants.
 

Static Private Attributes

static $loggerFields
 

Detailed Description

An interface for generating database load balancers.

Definition at line 39 of file LBFactory.php.

Constructor & Destructor Documentation

◆ __construct()

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

Construct a manager of ILoadBalancer objects.

Sub-classes will extend the required keys in $conf with additional parameters

Parameters
array$confArray with keys:
  • localDomain: A DatabaseDomain or domain ID string.
  • readOnlyReason: Reason the master DB is read-only if so [optional]
  • srvCache: BagOStuff object for server cache [optional]
  • memStash: BagOStuff object for cross-datacenter memory storage [optional]
  • wanCache: WANObjectCache object [optional]
  • hostname: The name of the current server [optional]
  • cliMode: Whether the execution context is a CLI script. [optional]
  • maxLag: Try to avoid DB replicas with lag above this many seconds [optional]
  • profiler: Class name or instance with profileIn()/profileOut() methods. [optional]
  • trxProfiler: TransactionProfiler instance. [optional]
  • replLogger: PSR-3 logger instance. [optional]
  • connLogger: PSR-3 logger instance. [optional]
  • queryLogger: PSR-3 logger instance. [optional]
  • perfLogger: PSR-3 logger instance. [optional]
  • errorLogger: Callback that takes an Exception and logs it. [optional]
  • deprecationLogger: Callback to log a deprecation warning. [optional]
Exceptions
InvalidArgumentException

Implements Wikimedia\Rdbms\ILBFactory.

Reimplemented in Wikimedia\Rdbms\LBFactoryMulti, Wikimedia\Rdbms\LBFactorySimple, and Wikimedia\Rdbms\LBFactorySingle.

Definition at line 111 of file LBFactory.php.

References $e, as, Wikimedia\Rdbms\DatabaseDomain\newFromId(), and Wikimedia\Rdbms\DatabaseDomain\newUnspecified().

◆ __destruct()

Wikimedia\Rdbms\LBFactory::__destruct ( )

Definition at line 733 of file LBFactory.php.

References Wikimedia\Rdbms\LBFactory\destroy().

Member Function Documentation

◆ appendShutdownCPIndexAsQuery()

Wikimedia\Rdbms\LBFactory::appendShutdownCPIndexAsQuery (   $url,
  $index 
)

Append ?cpPosIndex parameter to a URL for ChronologyProtector purposes if needed.

Note that unlike cookies, this works across domains

Parameters
string$url
int$indexWrite counter index
Returns
string

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 664 of file LBFactory.php.

References Wikimedia\Rdbms\ILBFactory\forEachLB(), Wikimedia\Rdbms\ILoadBalancer\getServerCount(), and use.

◆ assertTransactionRoundStage()

Wikimedia\Rdbms\LBFactory::assertTransactionRoundStage (   $stage)
private
Parameters
string$stage

Definition at line 724 of file LBFactory.php.

Referenced by Wikimedia\Rdbms\LBFactory\beginMasterChanges(), and Wikimedia\Rdbms\LBFactory\commitMasterChanges().

◆ baseLoadBalancerParams()

◆ beginMasterChanges()

Wikimedia\Rdbms\LBFactory::beginMasterChanges (   $fname = __METHOD__)
final

Flush any master transaction snapshots and set DBO_TRX (if DBO_DEFAULT is set)

The DBO_TRX setting will be reverted to the default in each of these methods:

  • commitMasterChanges()
  • rollbackMasterChanges()
  • commitAll()

This allows for custom transaction rounds from any outer transaction scope.

Parameters
string$fname
Exceptions
DBTransactionError

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 239 of file LBFactory.php.

References $fname, Wikimedia\Rdbms\LBFactory\assertTransactionRoundStage(), Wikimedia\Rdbms\LBFactory\forEachLBCallMethod(), Wikimedia\Rdbms\LBFactory\ROUND_BEGINNING, and Wikimedia\Rdbms\LBFactory\ROUND_CURSORY.

Referenced by Wikimedia\Rdbms\LBFactory\commitAndWaitForReplication(), JobRunner\executeJob(), and DeferredUpdates\runUpdate().

◆ closeAll()

Wikimedia\Rdbms\LBFactory::closeAll ( )

Close all open database connections on all open load balancers.

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 656 of file LBFactory.php.

References Wikimedia\Rdbms\LBFactory\forEachLBCallMethod().

Referenced by Wikimedia\Rdbms\LBFactory\redefineLocalDomain().

◆ commitAll()

Wikimedia\Rdbms\LBFactory::commitAll (   $fname = __METHOD__,
array  $options = [] 
)
final

Commit open transactions on all connections.

This is useful for two main cases:

  • a) To commit changes to the masters.
  • b) To release the snapshot on all connections, master and replica DBs.
    Parameters
    string$fnameCaller name
    array$optionsOptions map:
  • maxWriteDuration: abort if more than this much time was spent in write queries

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 233 of file LBFactory.php.

References $fname, $options, Wikimedia\Rdbms\LBFactory\commitMasterChanges(), and Wikimedia\Rdbms\LBFactory\forEachLBCallMethod().

◆ commitAndWaitForReplication()

Wikimedia\Rdbms\LBFactory::commitAndWaitForReplication (   $fname,
  $ticket,
array  $opts = [] 
)
final

Convenience method for safely running commitMasterChanges()/waitForReplication()

This will commit and wait unless $ticket indicates it is unsafe to do so

Parameters
string$fnameCaller name (e.g. METHOD)
mixed$ticketResult of getEmptyTransactionTicket()
array$optsOptions to waitForReplication()
Returns
bool True if the wait was successful, false on timeout

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 461 of file LBFactory.php.

References $fname, Wikimedia\Rdbms\LBFactory\$ticket, Wikimedia\Rdbms\LBFactory\$trxRoundId, Wikimedia\Rdbms\LBFactory\beginMasterChanges(), Wikimedia\Rdbms\LBFactory\commitMasterChanges(), and Wikimedia\Rdbms\LBFactory\waitForReplication().

Referenced by CategoryMembershipChangeJob\notifyUpdatesForRevision().

◆ commitMasterChanges()

◆ destroy()

Wikimedia\Rdbms\LBFactory::destroy ( )

Disables all load balancers.

All connections are closed, and any attempt to open a new connection will result in a DBAccessError.

See also
ILoadBalancer::disable()

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 155 of file LBFactory.php.

References Wikimedia\Rdbms\LBFactory\forEachLBCallMethod(), and Wikimedia\Rdbms\LBFactory\shutdown().

Referenced by Wikimedia\Rdbms\LBFactory\__destruct().

◆ disableChronologyProtection()

Wikimedia\Rdbms\LBFactory::disableChronologyProtection ( )

Disable the ChronologyProtector for all load balancers.

This can be called at the start of special API entry points

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 492 of file LBFactory.php.

References Wikimedia\Rdbms\LBFactory\getChronologyProtector().

◆ executePostTransactionCallbacks()

◆ flushReplicaSnapshots()

Wikimedia\Rdbms\LBFactory::flushReplicaSnapshots (   $fname = __METHOD__)

Commit all replica DB transactions so as to flush any REPEATABLE-READ or SSI snapshot.

Parameters
string$fnameCaller name

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 229 of file LBFactory.php.

References $fname, and Wikimedia\Rdbms\LBFactory\forEachLBCallMethod().

Referenced by JobRunner\executeJob().

◆ forEachLBCallMethod()

Wikimedia\Rdbms\LBFactory::forEachLBCallMethod (   $methodName,
array  $args = [] 
)
protected

◆ getChronologyProtector()

◆ getChronologyProtectorTouched()

Wikimedia\Rdbms\LBFactory::getChronologyProtectorTouched (   $dbName)
Parameters
string$dbNameDB master name (e.g. "db1052")
Returns
float|bool UNIX timestamp when client last touched the DB or false if not recent

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 488 of file LBFactory.php.

References Wikimedia\Rdbms\LBFactory\getChronologyProtector().

◆ getCPInfoFromCookieValue()

static Wikimedia\Rdbms\LBFactory::getCPInfoFromCookieValue (   $value,
  $minTimestamp 
)
static
Parameters
string$valuePossible result of LBFactory::makeCookieValueFromCPIndex()
int$minTimestampLowest UNIX timestamp that a non-expired value can have
Returns
array (index: int or null, clientId: string or null)
Since
1.32

Definition at line 694 of file LBFactory.php.

References $value, and null.

◆ getEmptyTransactionTicket()

Wikimedia\Rdbms\LBFactory::getEmptyTransactionTicket (   $fname)

Get a token asserting that no transaction writes are active.

Parameters
string$fnameCaller name (e.g. METHOD)
Returns
mixed A value to pass to commitAndWaitForReplication()

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 450 of file LBFactory.php.

References Wikimedia\Rdbms\LBFactory\$ticket, and Wikimedia\Rdbms\LBFactory\hasMasterChanges().

◆ getExternalLB()

Wikimedia\Rdbms\LBFactory::getExternalLB (   $cluster)
abstract
See also
ILBFactory::getExternalLB()
Parameters
string$cluster
Returns
ILoadBalancer

Implements Wikimedia\Rdbms\ILBFactory.

Reimplemented in Wikimedia\Rdbms\LBFactoryMulti, Wikimedia\Rdbms\LBFactorySimple, and Wikimedia\Rdbms\LBFactorySingle.

Referenced by Wikimedia\Rdbms\LBFactory\waitForReplication().

◆ getLocalDomainID()

Wikimedia\Rdbms\LBFactory::getLocalDomainID ( )

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

See also
DatabaseDomain
Returns
string Database domain ID; this specifies DB name, schema, and table prefix
Since
1.32

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 160 of file LBFactory.php.

Referenced by Wikimedia\Rdbms\LBFactory\resolveDomainID().

◆ getMainLB()

Wikimedia\Rdbms\LBFactory::getMainLB (   $domain = false)
abstract
See also
ILBFactory::getMainLB()
Parameters
bool$domain
Returns
ILoadBalancer

Implements Wikimedia\Rdbms\ILBFactory.

Reimplemented in Wikimedia\Rdbms\LBFactoryMulti, Wikimedia\Rdbms\LBFactorySimple, and Wikimedia\Rdbms\LBFactorySingle.

Referenced by JobRunner\commitMasterChanges(), and Wikimedia\Rdbms\LBFactory\waitForReplication().

◆ hasMasterChanges()

Wikimedia\Rdbms\LBFactory::hasMasterChanges ( )

◆ hasOrMadeRecentMasterChanges()

Wikimedia\Rdbms\LBFactory::hasOrMadeRecentMasterChanges (   $age = null)

Determine if any master connection has pending/written changes from this request.

Parameters
float | null$ageHow many seconds ago is "recent" [defaults to LB lag wait timeout]
Returns
bool

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 370 of file LBFactory.php.

References $ret, Wikimedia\Rdbms\ILBFactory\forEachLB(), Wikimedia\Rdbms\ILoadBalancer\hasOrMadeRecentMasterChanges(), and use.

◆ hasTransactionRound()

Wikimedia\Rdbms\LBFactory::hasTransactionRound ( )

Check if an explicit transaction round is active.

Returns
bool
Since
1.29

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 321 of file LBFactory.php.

◆ initLoadBalancer()

◆ isReadyForRoundOperations()

Wikimedia\Rdbms\LBFactory::isReadyForRoundOperations ( )

Check if transaction rounds can be started, committed, or rolled back right now.

This can be used as a recusion guard to avoid exceptions in transaction callbacks

Returns
bool
Since
1.32

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 325 of file LBFactory.php.

◆ laggedReplicaUsed()

Wikimedia\Rdbms\LBFactory::laggedReplicaUsed ( )

Detemine if any lagged replica DB connection was used.

Returns
bool

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 361 of file LBFactory.php.

References $ret, Wikimedia\Rdbms\ILBFactory\forEachLB(), Wikimedia\Rdbms\ILoadBalancer\laggedReplicaUsed(), and use.

◆ logIfMultiDbTransaction()

Wikimedia\Rdbms\LBFactory::logIfMultiDbTransaction ( )
private

◆ makeCookieValueFromCPIndex()

static Wikimedia\Rdbms\LBFactory::makeCookieValueFromCPIndex (   $index,
  $time,
  $clientId 
)
static
Parameters
int$indexWrite index
int$timeUNIX timestamp; can be used to detect stale cookies (T190082)
string$clientIdAgent ID hash from ILBFactory::shutdown()
Returns
string Timestamp-qualified write index of the form "<index>@<timestamp>#<hash>"
Since
1.32

Definition at line 684 of file LBFactory.php.

◆ newExternalLB()

Wikimedia\Rdbms\LBFactory::newExternalLB (   $cluster)
abstract
See also
ILBFactory::newExternalLB()
Parameters
string$cluster
Returns
ILoadBalancer

Implements Wikimedia\Rdbms\ILBFactory.

Reimplemented in Wikimedia\Rdbms\LBFactoryMulti, Wikimedia\Rdbms\LBFactorySimple, and Wikimedia\Rdbms\LBFactorySingle.

◆ newMainLB()

Wikimedia\Rdbms\LBFactory::newMainLB (   $domain = false)
abstract
See also
ILBFactory::newMainLB()
Parameters
bool$domain
Returns
ILoadBalancer

Implements Wikimedia\Rdbms\ILBFactory.

Reimplemented in Wikimedia\Rdbms\LBFactoryMulti, Wikimedia\Rdbms\LBFactorySimple, and Wikimedia\Rdbms\LBFactorySingle.

◆ redefineLocalDomain()

Wikimedia\Rdbms\LBFactory::redefineLocalDomain (   $domain)

Close all connection and redefine the local domain for testing or schema creation.

Parameters
DatabaseDomain | string$domain
Since
1.33

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 646 of file LBFactory.php.

References Wikimedia\Rdbms\LBFactory\closeAll(), Wikimedia\Rdbms\ILBFactory\forEachLB(), Wikimedia\Rdbms\DatabaseDomain\newFromId(), and Wikimedia\Rdbms\ILoadBalancer\redefineLocalDomain().

◆ resolveDomainID()

Wikimedia\Rdbms\LBFactory::resolveDomainID (   $domain)
Parameters
DatabaseDomain | string | bool$domainDatabase domain
Returns
string Value of $domain if provided or the local domain otherwise
Since
1.32

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 164 of file LBFactory.php.

References Wikimedia\Rdbms\LBFactory\getLocalDomainID(), and string.

◆ rollbackMasterChanges()

Wikimedia\Rdbms\LBFactory::rollbackMasterChanges (   $fname = __METHOD__)
final

◆ setAgentName()

Wikimedia\Rdbms\LBFactory::setAgentName (   $agent)
Parameters
string$agentAgent name for query profiling

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 660 of file LBFactory.php.

References Wikimedia\Rdbms\LBFactory\$agent.

◆ setDomainPrefix()

Wikimedia\Rdbms\LBFactory::setDomainPrefix (   $prefix)
Parameters
string$prefix
Deprecated:
Since 1.33

Definition at line 630 of file LBFactory.php.

References Wikimedia\Rdbms\LBFactory\setLocalDomainPrefix().

◆ setIndexAliases()

Wikimedia\Rdbms\LBFactory::setIndexAliases ( array  $aliases)

Convert certain index names to alternative names before querying the DB.

Note that this applies to indexes regardless of the table they belong to.

This can be employed when an index was renamed X => Y in code, but the new Y-named indexes were not yet built on all DBs. After all the Y-named ones are added by the DBA, the aliases can be removed, and then the old X-named indexes dropped.

Parameters
string[]$aliases
Since
1.31

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 622 of file LBFactory.php.

Referenced by MWLBFactory\setSchemaAliases().

◆ setLocalDomainPrefix()

Wikimedia\Rdbms\LBFactory::setLocalDomainPrefix (   $prefix)

Set a new table prefix for the existing local domain ID for testing.

Parameters
string$prefix
Since
1.33

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 634 of file LBFactory.php.

References Wikimedia\Rdbms\ILBFactory\forEachLB(), Wikimedia\Rdbms\ILoadBalancer\setLocalDomainPrefix(), and use.

Referenced by Wikimedia\Rdbms\LBFactory\setDomainPrefix().

◆ setRequestInfo()

Wikimedia\Rdbms\LBFactory::setRequestInfo ( array  $info)
Parameters
array$infoMap of fields, including:
  • IPAddress : IP address
  • UserAgent : User-Agent HTTP header
  • ChronologyProtection : cookie/header value specifying ChronologyProtector usage
  • ChronologyPositionIndex: timestamp used to get up-to-date DB positions for the agent

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 713 of file LBFactory.php.

References Wikimedia\Rdbms\LBFactory\$requestInfo.

◆ setTableAliases()

Wikimedia\Rdbms\LBFactory::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.

For example, "user" can be converted to "myschema.mydbname.user" for convenience. Appearances like user, somedb.user, somedb.someschema.user will used literally.

Calling this twice will completely clear any old table aliases. Also, note that callers are responsible for making sure the schemas and databases actually exist.

Parameters
array[]$aliasesMap of (table => (dbname, schema, prefix) map)
Since
1.31

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 618 of file LBFactory.php.

◆ setWaitForReplicationListener()

Wikimedia\Rdbms\LBFactory::setWaitForReplicationListener (   $name,
callable  $callback = null 
)

Add a callback to be run in every call to waitForReplication() before waiting.

Callbacks must clear any transactions that they start

Parameters
string$nameCallback name
callable | null$callbackUse null to unset a callback

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 442 of file LBFactory.php.

References $name.

◆ shutdown()

Wikimedia\Rdbms\LBFactory::shutdown (   $mode = self::SHUTDOWN_CHRONPROT_SYNC,
callable  $workCallback = null,
$cpIndex = null,
$cpClientId = null 
)

Prepare all tracked load balancers for shutdown.

Parameters
int$modeOne of the class SHUTDOWN_* constants
callable | null$workCallbackWork to mask ChronologyProtector writes
int | null&$cpIndexPosition key write counter for ChronologyProtector
string | null&$cpClientIdClient ID hash for ChronologyProtector

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 168 of file LBFactory.php.

References Wikimedia\Rdbms\LBFactory\$chronProt, Wikimedia\Rdbms\LBFactory\commitMasterChanges(), Wikimedia\Rdbms\LBFactory\getChronologyProtector(), Wikimedia\Rdbms\ChronologyProtector\getClientId(), and Wikimedia\Rdbms\LBFactory\shutdownChronologyProtector().

Referenced by Wikimedia\Rdbms\LBFactory\destroy().

◆ shutdownChronologyProtector()

Wikimedia\Rdbms\LBFactory::shutdownChronologyProtector ( ChronologyProtector  $cp,
  $workCallback,
  $mode,
$cpIndex = null 
)
protected

Get and record all of the staged DB positions into persistent memory storage.

Parameters
ChronologyProtector$cp
callable | null$workCallbackWork to do instead of waiting on syncing positions
string$modeOne of (sync, async); whether to wait on remote datacenters
int | null&$cpIndexDB position key write counter; incremented on update

Definition at line 541 of file LBFactory.php.

References Wikimedia\Rdbms\ILBFactory\forEachLB(), Wikimedia\Rdbms\ILoadBalancer\getServerName(), Wikimedia\Rdbms\ILoadBalancer\getWriterIndex(), Wikimedia\Rdbms\ChronologyProtector\shutdown(), Wikimedia\Rdbms\ChronologyProtector\shutdownLB(), use, and Wikimedia\Rdbms\ILoadBalancer\waitForAll().

Referenced by Wikimedia\Rdbms\LBFactory\shutdown().

◆ waitForReplication()

Wikimedia\Rdbms\LBFactory::waitForReplication ( array  $opts = [])

Waits for the replica DBs to catch up to the current master position.

Use this when updating very large numbers of rows, as in maintenance scripts, to avoid causing too much lag. Of course, this is a no-op if there are no replica DBs.

By default this waits on all DB clusters actually used in this request. This makes sense when lag being waiting on is caused by the code that does this check. In that case, setting "ifWritesSince" can avoid the overhead of waiting for clusters that were not changed since the last wait check. To forcefully wait on a specific cluster for a given domain, use the 'domain' parameter. To forcefully wait on an "external" cluster, use the "cluster" parameter.

Never call this function after a large DB write that is still in a transaction. It only makes sense to call this after the possible lag inducing changes were committed.

Parameters
array$optsOptional fields that include:
  • domain : wait on the load balancer DBs that handles the given domain ID
  • cluster : wait on the given external load balancer DBs
  • timeout : Max wait time. Default: 60 seconds for CLI, 1 second for web.
  • ifWritesSince: Only wait if writes were done since this UNIX timestamp
Returns
bool True on success, false if a timeout or error occurred while waiting

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 378 of file LBFactory.php.

References as, Wikimedia\Rdbms\ILBFactory\forEachLB(), Wikimedia\Rdbms\LBFactory\getExternalLB(), Wikimedia\Rdbms\LBFactory\getMainLB(), null, and use.

Referenced by Wikimedia\Rdbms\LBFactory\commitAndWaitForReplication().

Member Data Documentation

◆ $agent

string Wikimedia\Rdbms\LBFactory::$agent
private

Agent name for query profiling.

Definition at line 76 of file LBFactory.php.

Referenced by Wikimedia\Rdbms\LBFactory\baseLoadBalancerParams(), and Wikimedia\Rdbms\LBFactory\setAgentName().

◆ $chronProt

ChronologyProtector Wikimedia\Rdbms\LBFactory::$chronProt
private

◆ $cliMode

bool Wikimedia\Rdbms\LBFactory::$cliMode
private

Whether this PHP instance is for a CLI script.

Definition at line 74 of file LBFactory.php.

Referenced by Wikimedia\Rdbms\LBFactory\baseLoadBalancerParams().

◆ $connLogger

LoggerInterface Wikimedia\Rdbms\LBFactory::$connLogger
private

Definition at line 49 of file LBFactory.php.

Referenced by Wikimedia\Rdbms\LBFactory\baseLoadBalancerParams().

◆ $defaultGroup

string null Wikimedia\Rdbms\LBFactory::$defaultGroup = null
private

Definition at line 96 of file LBFactory.php.

Referenced by Wikimedia\Rdbms\LBFactory\baseLoadBalancerParams().

◆ $deprecationLogger

callable Wikimedia\Rdbms\LBFactory::$deprecationLogger
private

Deprecation logger.

Definition at line 57 of file LBFactory.php.

Referenced by Wikimedia\Rdbms\LBFactory\baseLoadBalancerParams().

◆ $errorLogger

callable Wikimedia\Rdbms\LBFactory::$errorLogger
private

Error logger.

Definition at line 55 of file LBFactory.php.

Referenced by Wikimedia\Rdbms\LBFactory\baseLoadBalancerParams().

◆ $hostname

string Wikimedia\Rdbms\LBFactory::$hostname
private

Local hostname of the app server.

Definition at line 70 of file LBFactory.php.

Referenced by Wikimedia\Rdbms\LBFactory\baseLoadBalancerParams().

◆ $indexAliases

string [] Wikimedia\Rdbms\LBFactory::$indexAliases = []
private

Map of (index alias => index)

Definition at line 81 of file LBFactory.php.

◆ $localDomain

DatabaseDomain Wikimedia\Rdbms\LBFactory::$localDomain
protected

Local domain.

Definition at line 67 of file LBFactory.php.

Referenced by Wikimedia\Rdbms\LBFactory\baseLoadBalancerParams().

◆ $loggerFields

Wikimedia\Rdbms\LBFactory::$loggerFields
staticprivate
Initial value:
=
[ 'replLogger', 'connLogger', 'queryLogger', 'perfLogger' ]

Definition at line 108 of file LBFactory.php.

◆ $maxLag

int null Wikimedia\Rdbms\LBFactory::$maxLag
protected

Definition at line 99 of file LBFactory.php.

Referenced by Wikimedia\Rdbms\LBFactory\baseLoadBalancerParams().

◆ $memStash

BagOStuff Wikimedia\Rdbms\LBFactory::$memStash
protected

Definition at line 62 of file LBFactory.php.

◆ $perfLogger

LoggerInterface Wikimedia\Rdbms\LBFactory::$perfLogger
private

Definition at line 53 of file LBFactory.php.

◆ $profiler

object string Wikimedia\Rdbms\LBFactory::$profiler
private

Class name or object With profileIn/profileOut methods.

Definition at line 43 of file LBFactory.php.

Referenced by Wikimedia\Rdbms\LBFactory\baseLoadBalancerParams().

◆ $queryLogger

LoggerInterface Wikimedia\Rdbms\LBFactory::$queryLogger
private

Definition at line 51 of file LBFactory.php.

Referenced by Wikimedia\Rdbms\LBFactory\baseLoadBalancerParams().

◆ $readOnlyReason

string bool Wikimedia\Rdbms\LBFactory::$readOnlyReason = false
protected

◆ $replicationWaitCallbacks

callable [] Wikimedia\Rdbms\LBFactory::$replicationWaitCallbacks = []
private

Definition at line 83 of file LBFactory.php.

◆ $replLogger

LoggerInterface Wikimedia\Rdbms\LBFactory::$replLogger
private

Definition at line 47 of file LBFactory.php.

Referenced by Wikimedia\Rdbms\LBFactory\baseLoadBalancerParams().

◆ $requestInfo

array Wikimedia\Rdbms\LBFactory::$requestInfo
private

Web request information about the client.

Definition at line 72 of file LBFactory.php.

Referenced by Wikimedia\Rdbms\LBFactory\setRequestInfo().

◆ $srvCache

BagOStuff Wikimedia\Rdbms\LBFactory::$srvCache
protected

Definition at line 60 of file LBFactory.php.

Referenced by Wikimedia\Rdbms\LBFactory\baseLoadBalancerParams().

◆ $tableAliases

Wikimedia\Rdbms\LBFactory::$tableAliases = []
private

Definition at line 79 of file LBFactory.php.

◆ $ticket

mixed Wikimedia\Rdbms\LBFactory::$ticket
private

◆ $trxProfiler

TransactionProfiler Wikimedia\Rdbms\LBFactory::$trxProfiler
private

Definition at line 45 of file LBFactory.php.

Referenced by Wikimedia\Rdbms\LBFactory\baseLoadBalancerParams().

◆ $trxRoundId

string bool Wikimedia\Rdbms\LBFactory::$trxRoundId = false
private

String if a requested DBO_TRX transaction round is active.

Definition at line 88 of file LBFactory.php.

Referenced by Wikimedia\Rdbms\LBFactory\commitAndWaitForReplication().

◆ $trxRoundStage

string Wikimedia\Rdbms\LBFactory::$trxRoundStage = self::ROUND_CURSORY
private

One of the ROUND_* class constants.

Definition at line 90 of file LBFactory.php.

◆ $wanCache

WANObjectCache Wikimedia\Rdbms\LBFactory::$wanCache
protected

Definition at line 64 of file LBFactory.php.

Referenced by Wikimedia\Rdbms\LBFactory\baseLoadBalancerParams().

◆ ROUND_BEGINNING

const Wikimedia\Rdbms\LBFactory::ROUND_BEGINNING = 'within-begin'

Definition at line 102 of file LBFactory.php.

Referenced by Wikimedia\Rdbms\LBFactory\beginMasterChanges().

◆ ROUND_COMMIT_CALLBACKS

const Wikimedia\Rdbms\LBFactory::ROUND_COMMIT_CALLBACKS = 'within-commit-callbacks'

Definition at line 105 of file LBFactory.php.

Referenced by Wikimedia\Rdbms\LBFactory\commitMasterChanges().

◆ ROUND_COMMITTING

const Wikimedia\Rdbms\LBFactory::ROUND_COMMITTING = 'within-commit'

Definition at line 103 of file LBFactory.php.

Referenced by Wikimedia\Rdbms\LBFactory\commitMasterChanges().

◆ ROUND_CURSORY

const Wikimedia\Rdbms\LBFactory::ROUND_CURSORY = 'cursory'

◆ ROUND_ROLLBACK_CALLBACKS

const Wikimedia\Rdbms\LBFactory::ROUND_ROLLBACK_CALLBACKS = 'within-rollback-callbacks'

Definition at line 106 of file LBFactory.php.

Referenced by Wikimedia\Rdbms\LBFactory\rollbackMasterChanges().

◆ ROUND_ROLLING_BACK

const Wikimedia\Rdbms\LBFactory::ROUND_ROLLING_BACK = 'within-rollback'

Definition at line 104 of file LBFactory.php.

Referenced by Wikimedia\Rdbms\LBFactory\rollbackMasterChanges().


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