Public Member Functions |
Static Public Member Functions |
Protected Member Functions |
Private Attributes |
List of all members
Wikimedia\Rdbms\LoadBalancerSingle Class Reference
Trivial LoadBalancer that always returns an injected connection handle. More...
Inheritance diagram for Wikimedia\Rdbms\LoadBalancerSingle:
Collaboration diagram for Wikimedia\Rdbms\LoadBalancerSingle:
Public Member Functions | |
| __construct (array $params) | |
 Public Member Functions inherited from Wikimedia\Rdbms\LoadBalancer | |
| __destruct () | |
| allowLagged ( $mode=null) | |
| Disables/enables lag checks. More... | |
| approveMasterChanges (array $options) | |
| Perform all pre-commit checks for things like replication safety. More... | |
| beginMasterChanges ( $fname=__METHOD__) | |
| Flush any master transaction snapshots and set DBO_TRX (if DBO_DEFAULT is set) More... | |
| closeAll () | |
| Close all open connections. More... | |
| closeConnection (IDatabase $conn) | |
| Close a connection. More... | |
| commitAll ( $fname=__METHOD__) | |
| Commit transactions on all open connections. More... | |
| commitMasterChanges ( $fname=__METHOD__) | |
| Issue COMMIT on all open master connections to flush changes and view snapshots. More... | |
| disable () | |
| Disable this load balancer. More... | |
| finalizeMasterChanges () | |
| Run pre-commit callbacks and defer execution of post-commit callbacks. More... | |
| flushMasterSnapshots ( $fname=__METHOD__) | |
| Commit all master DB transactions so as to flush any REPEATABLE-READ or SSI snapshots. More... | |
| flushReplicaSnapshots ( $fname=__METHOD__) | |
| Commit all replica DB transactions so as to flush any REPEATABLE-READ or SSI snapshots. More... | |
| forEachOpenConnection ( $callback, array $params=[]) | |
| Call a function with each open connection object. More... | |
| forEachOpenMasterConnection ( $callback, array $params=[]) | |
| Call a function with each open connection object to a master. More... | |
| forEachOpenReplicaConnection ( $callback, array $params=[]) | |
| Call a function with each open replica DB connection object. More... | |
| getAnyOpenConnection ( $i, $flags=0) | |
| Get any open connection to a given server index, local or foreign. More... | |
| getConnection ( $i, $groups=[], $domain=false, $flags=0) | |
| Get a connection handle by server index. More... | |
| getConnectionRef ( $i, $groups=[], $domain=false, $flags=0) | |
| Get a database connection handle reference. More... | |
| getLaggedReplicaMode ( $domain=false) | |
| getLagTimes ( $domain=false) | |
| Get an estimate of replication lag (in seconds) for each server. More... | |
| getLazyConnectionRef ( $i, $groups=[], $domain=false, $flags=0) | |
| Get a database connection handle reference without connecting yet. More... | |
| getLocalDomainID () | |
| Get the local (and default) database domain ID of connection handles. More... | |
| getMaintenanceConnectionRef ( $i, $groups=[], $domain=false, $flags=0) | |
| Get a maintenance database connection handle reference for migrations and schema changes. More... | |
| getMasterPos () | |
| Get the current master position for chronology control purposes. More... | |
| getMaxLag ( $domain=false) | |
| Get the hostname and lag time of the most-lagged replica DB. More... | |
| getReaderIndex ( $group=false, $domain=false) | |
| Get the index of the reader connection, which may be a replica DB. More... | |
| getReadOnlyReason ( $domain=false, IDatabase $conn=null) | |
| getServerAttributes ( $i) | |
| getServerCount () | |
| Get the number of defined servers (not the number of open connections) More... | |
| getServerInfo ( $i) | |
| Return the server info structure for a given index, or false if the index is invalid. More... | |
| getServerName ( $i) | |
| Get the host name or IP address of the server with the specified index. More... | |
| getServerType ( $i) | |
| Get DB type of the server with the specified index. More... | |
| getTransactionRoundStage () | |
| getWriterIndex () | |
| hasMasterChanges () | |
| Whether there are pending changes or callbacks in a transaction by this thread. More... | |
| hasMasterConnection () | |
| hasOrMadeRecentMasterChanges ( $age=null) | |
| Check if this load balancer object had any recent or still pending writes issued against it by this PHP thread. More... | |
| haveIndex ( $i) | |
| Returns true if the specified index is a valid server index. More... | |
| isNonZeroLoad ( $i) | |
| Returns true if the specified index is valid and has non-zero load. More... | |
| laggedReplicaUsed () | |
| Checks whether the database for generic connections this request was both: More... | |
| laggedSlaveUsed () | |
| lastMasterChangeTimestamp () | |
| Get the timestamp of the latest write query done by this thread. More... | |
| openConnection ( $i, $domain=false, $flags=0) | |
| Open a connection to the server given by the specified index. More... | |
| pendingMasterChangeCallers () | |
| Get the list of callers that have pending master changes. More... | |
| pingAll () | |
| redefineLocalDomain ( $domain) | |
| Close all connection and redefine the local domain for testing or schema creation. More... | |
| resolveDomainID ( $domain) | |
| reuseConnection (IDatabase $conn) | |
| Mark a foreign connection as being available for reuse under a different DB domain. More... | |
| rollbackMasterChanges ( $fname=__METHOD__) | |
| Issue ROLLBACK only on master, only if queries were done on connection. More... | |
| runMasterTransactionIdleCallbacks () | |
| Consume and run all pending post-COMMIT/ROLLBACK callbacks and commit dangling transactions. More... | |
| runMasterTransactionListenerCallbacks () | |
| Run all recurring post-COMMIT/ROLLBACK listener callbacks. More... | |
| safeGetLag (IDatabase $conn) | |
| Get the lag in seconds for a given connection, or zero if this load balancer does not have replication enabled. More... | |
| safeWaitForMasterPos (IDatabase $conn, $pos=false, $timeout=null) | |
| Wait for a replica DB to reach a specified master position. More... | |
| setDomainPrefix ( $prefix) | |
| 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... | |
| 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... | |
| setTransactionListener ( $name, callable $callback=null) | |
| Set a callback via IDatabase::setTransactionListener() on all current and future master connections of this load balancer. More... | |
| waitFor ( $pos) | |
| Set the master wait position. More... | |
| waitForAll ( $pos, $timeout=null) | |
| Set the master wait position and wait for ALL replica DBs to catch up to it. More... | |
| waitForOne ( $pos, $timeout=null) | |
| Set the master wait position and wait for a "generic" replica DB to catch up to it. More... | |
Static Public Member Functions | |
| static | newFromConnection (IDatabase $db, array $params=[]) |
Protected Member Functions | |
| reallyOpenConnection (array $server, DatabaseDomain $domain) | |
| Open a new network connection to a server (uncached) More... | |
| Protected Member Functions inherited from Wikimedia\Rdbms\LoadBalancer | |
| doWait ( $index, $open=false, $timeout=null) | |
| Wait for a given replica DB to catch up to the master pos stored in $this. More... | |
Private Attributes | |
| IDatabase | $db |
Additional Inherited Members | |
| Public Attributes inherited from Wikimedia\Rdbms\LoadBalancer | |
| const | KEY_FOREIGN_FREE = 'foreignFree' |
| const | KEY_FOREIGN_FREE_NOROUND = 'foreignFreeAutoCommit' |
| const | KEY_FOREIGN_INUSE = 'foreignInUse' |
| const | KEY_FOREIGN_INUSE_NOROUND = 'foreignInUseAutoCommit' |
| const | KEY_LOCAL = 'local' |
| const | KEY_LOCAL_NOROUND = 'localAutoCommit' |
Detailed Description
Trivial LoadBalancer that always returns an injected connection handle.
Note that, while this LoadBalancer does not open any connections itself, it still closes the injected connection at times, including during destruction. It is therefore unsuitable for use in tests unless you have a Database instance separate from the main test database (which is expected to stay open).
Definition at line 36 of file LoadBalancerSingle.php.
Constructor & Destructor Documentation
◆ __construct()
| Wikimedia\Rdbms\LoadBalancerSingle::__construct | ( | array | $params | ) |
- Parameters
-
array $params An associative array with one member: - connection: An IDatabase connection object
Reimplemented from Wikimedia\Rdbms\LoadBalancer.
Definition at line 44 of file LoadBalancerSingle.php.
References $params.
Member Function Documentation
◆ newFromConnection()
|
static |
- Parameters
-
IDatabase $db Live connection handle array $params Parameter map to LoadBalancerSingle::__constructs()
- Returns
- LoadBalancerSingle
- Since
- 1.28
Definition at line 78 of file LoadBalancerSingle.php.
References Wikimedia\Rdbms\LoadBalancerSingle\$db, $params, and Wikimedia\Rdbms\IDatabase\getDomainID().
◆ reallyOpenConnection()
|
protected |
Open a new network connection to a server (uncached)
Returns a Database object whether or not the connection was successful.
- Parameters
-
array $server DatabaseDomain $domain Domain the connection is for, possibly unspecified
- Returns
- Database
- Exceptions
-
DBAccessError InvalidArgumentException
Reimplemented from Wikimedia\Rdbms\LoadBalancer.
Definition at line 86 of file LoadBalancerSingle.php.
References Wikimedia\Rdbms\LoadBalancerSingle\$db.
Member Data Documentation
◆ $db
|
private |
Definition at line 38 of file LoadBalancerSingle.php.
Referenced by Wikimedia\Rdbms\LoadBalancerSingle\newFromConnection(), and Wikimedia\Rdbms\LoadBalancerSingle\reallyOpenConnection().
The documentation for this class was generated from the following file:
- includes/libs/rdbms/loadbalancer/LoadBalancerSingle.php
