Movatterモバイル変換

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

Parameters

array

$conf

Array with keys: localDomain: A DatabaseDomain or database domain ID string virtualDomains: List of virtual database domain ID strings [optional]. These can be passed to {

See also

ILBFactory::getPrimaryDatabase()} and {

ILBFactory::getReplicaDatabase()}, with the actual cluster and database domain being automatically resolved via "virtualDomainsMapping". Virtual database domains not defined there will resolve to the local database domain.

• virtualDomainsMapping: Map of (virtual database domain ID => config map) [optional]. Each config map has a "db" key and an optional "cluster" key. The "db" key specifies the actual database domain configured for use, with false indicating that the local database domain is configured for use. The "cluster" key,if provided, specifies the name of the external cluster configured for use, otherwise, the main cluster for the actual database domain will be used.
• chronologyProtector: ChronologyProtector instance [optional]
• readOnlyReason: Reason the primary server is read-only (falseif not)
• srvCache: BagOStuff instance for server cache [optional]
• cpStash: BagOStuff instance for ChronologyProtector store [optional]. SeeChronologyProtector requirements.
• wanCache: WANObjectCache instance [optional]
• cliMode: Whether the execution context is a CLI script [optional]
• profiler: Callback that takes a profile section name and returns a ScopedCallback that ends the profile section in its destructor [optional]
• trxProfiler: TransactionProfiler instance [optional]
• logger: PSR-3 logger instance [optional]
• errorLogger: Callback that takes an Exception and logs it [optional]
• deprecationLogger: Callback to log a deprecation warning [optional]
• secret: Secret string to use for HMAC hashing [optional]
• criticalSectionProvider: CriticalSectionProvider instance [optional]
• statsFactory: StatsFactory instance [optional]

Implemented inWikimedia\Rdbms\LBFactory,Wikimedia\Rdbms\LBFactoryMulti,Wikimedia\Rdbms\LBFactorySimple, andWikimedia\Rdbms\LBFactorySingle.

Reload the configuration if necessary.

This may or may not have any effect.

Implemented inWikimedia\Rdbms\LBFactory.

Wrap subsequent queries for all transaction round aware primary connections in a transaction.

Each of these transactions will be owned by this ILBFactory instance such that direct calls toIDatabase::commit() orIDatabase::rollback() will be disabled. These transactions get resolved by a single call to eithercommitPrimaryChanges() orrollbackPrimaryChanges(), after which, the transaction wrapping and ownership behavior revert back to the default. When there are multiple connections involved, these methods perform best-effort distributed transactions. When using distributed transactions, the RDBMS should be configured to used pessimistic concurrency control such that the commit step of each transaction is unlikely to fail.

Transactions on replication connections are flushed so that future reads will not keep using the same point-in-time view snapshots (e.g. from MySQL REPEATABLE-READ). However, this does not wait for replication to catch up, so subsequent reads from replicas might not reflect recently committed changes.

This only applies to the tracked load balancer instances.

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

Parameters

string

$fname

Exceptions

DBTransactionError

Since

1.37

Implemented inWikimedia\Rdbms\LBFactory.

Close all connections on instantiated tracked load balancer instances.

Parameters

string

$fname

Caller name (e.g.METHOD)

Implemented inWikimedia\Rdbms\LBFactory.

Commit all primary connection transactions and flush all replica connection transactions.

Transactions on replication connections are flushed so that future reads will not keep using the same point-in-time view snapshots (e.g. from MySQL REPEATABLE-READ). However, this does not wait for replication to catch up, so subsequent reads from replicas might not reflect the committed changes.

This only applies to the instantiated tracked load balancer instances.

Parameters

string	$fname	Caller name
int	$maxWriteDuration	abort if more than this much time was spent in write queries

Exceptions

DBTransactionError

Since

1.37

Implemented inWikimedia\Rdbms\LBFactory.

Close all connections and make further attempts to open connections result in DBAccessError.

This only applies to the tracked load balancer instances.

See also

ILoadBalancer::disable()

Implemented inWikimedia\Rdbms\LBFactory.

Disable the ChronologyProtector on all instantiated tracked load balancer instances.

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

Implemented inWikimedia\Rdbms\LBFactory.

Release important session-level state (named lock, table locks) as post-rollback cleanup.

This only applies to the instantiated tracked load balancer instances.

This should only be called by application entry point functions, since there must be no chance that a future caller will still be expecting some of the lost session state.

Parameters

string

$fname

Caller name

Since

1.38

Implemented inWikimedia\Rdbms\LBFactory.

Commit all replica database server transactions, clearing any point-in-time view snapshots.

This only applies to the instantiated tracked load balancer instances.

This is useful for getting rid of stale data from an implicit transaction round

Parameters

string

$fname

Caller name

Deprecated

Since 1.43

Implemented inWikimedia\Rdbms\LBFactory.

Get the tracked load balancer instances for all external clusters.

If no tracked instance exists for a cluster, then one will be instantiated

Returns

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

Since

1.29

Implemented inWikimedia\Rdbms\LBFactoryMulti,Wikimedia\Rdbms\LBFactorySimple, andWikimedia\Rdbms\LBFactorySingle.

Get all tracked load balancer instances (generator)

Returns

Generator|ILoadBalancer[]

Since

1.39

Implemented inWikimedia\Rdbms\LBFactory.

Get the tracked load balancer instances for all main clusters.

If no tracked instance exists for a cluster, then one will be instantiated

Note that default main cluster name is ILoadBalancer::CLUSTER_MAIN_DEFAULT

Returns

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

Since

1.29

Implemented inWikimedia\Rdbms\LBFactoryMulti,Wikimedia\Rdbms\LBFactorySimple, andWikimedia\Rdbms\LBFactorySingle.

LikeIConnectionProvider::getPrimaryDatabase() but with AUTOCOMMIT mode.

This is useful for whether the caller needs to use AUTOCOMMIT (no transaction wrapping) or it needs a new connection outside of the current transaction to bypass REPEATABLE READ isolation.

This method accepts virtual domains ({

See also

\MediaWiki\MainConfigSchema::VirtualDomainsMapping}).

Since

1.44

Parameters

string | false

$domain

Domain ID, or false for the current domain

Returns

IDatabase

Implemented inWikimedia\Rdbms\LBFactory.

Get the tracked load balancer instance for an external cluster.

If no tracked instances exists, then one will be instantiated

Parameters

string

$cluster

External cluster name

Exceptions

InvalidArgumentException

If $cluster is not recognized

Returns

ILoadBalancer

Implemented inWikimedia\Rdbms\LBFactoryMulti,Wikimedia\Rdbms\LBFactorySimple, andWikimedia\Rdbms\LBFactorySingle.

Get the tracked load balancer instance for a given domain.

If no tracked instances exists, then one will be instantiated.

This method accepts virtual domains ({

See also

\MediaWiki\MainConfigSchema::VirtualDomainsMapping}).

Since

1.43

Parameters

string | false

$domain

Domain ID, or false for the current domain

Returns

ILoadBalancer

Implemented inWikimedia\Rdbms\LBFactory.

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

Implemented inWikimedia\Rdbms\LBFactory.

Get the tracked load balancer instance for the main cluster that handles the given domain.

If no tracked instances exists, then one will be instantiated

Note

The local/default database domain used by the load balancer instance will still inherit from this ILBFactory instance, regardless of the $domain parameter.

Parameters

string | false

$domain

Domain ID, or false for the current domain

Returns

ILoadBalancer

Implemented inWikimedia\Rdbms\LBFactoryMulti,Wikimedia\Rdbms\LBFactorySimple, andWikimedia\Rdbms\LBFactorySingle.

Referenced byMediaWiki\User\UserFactory\__construct().

Get the TransactionProfiler used by this instance.

Returns

TransactionProfiler

Since

1.35

Implemented inWikimedia\Rdbms\LBFactory.

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

This only applies to the instantiated tracked load balancer instances.

Parameters

float | null

$age

How many seconds ago is "recent" [defaults to LB lag wait timeout]

Returns

bool

Implemented inWikimedia\Rdbms\LBFactory.

Determine if any primary connection has pending changes.

This only applies to the instantiated tracked load balancer instances.

Returns

bool

Since

1.37

Implemented inWikimedia\Rdbms\LBFactory.

Whether it has streaming replica servers.

Since

1.41

Returns

bool

Implemented inWikimedia\Rdbms\LBFactory.

Check if an explicit transaction round is active.

Returns

bool

Since

1.29

Implemented inWikimedia\Rdbms\LBFactory.

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

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

Returns

bool

Since

1.32

Implemented inWikimedia\Rdbms\LBFactory.

Determine if any lagged replica database server connection was used.

This only applies to the instantiated tracked load balancer instances.

Returns

bool

Implemented inWikimedia\Rdbms\LBFactory.

Create a new load balancer instance for an external cluster.

The resulting object will be untracked and the caller is responsible for cleaning it up. Database replication positions will not be saved by ChronologyProtector.

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 cluster name

Exceptions

InvalidArgumentException

If $cluster is not recognized

Returns

ILoadBalancerForOwner

Implemented inWikimedia\Rdbms\LBFactoryMulti,Wikimedia\Rdbms\LBFactorySimple, andWikimedia\Rdbms\LBFactorySingle.

Create a new load balancer instance for the main cluster that handles the given domain.

The resulting object is considered to be owned by the caller. Namely, it will be untracked, the caller is responsible for cleaning it up, and replication positions from it will not be saved by ChronologyProtector.

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.

Note

The local/default database domain used by the load balancer instance will still inherit from this ILBFactory instance, regardless of the $domain parameter.

Parameters

string | false

$domain

Domain ID, or false for the current domain

Returns

ILoadBalancerForOwner

Implemented inWikimedia\Rdbms\LBFactoryMulti,Wikimedia\Rdbms\LBFactorySimple, andWikimedia\Rdbms\LBFactorySingle.

Close all connections and redefine the local database domain.

This only applies to the tracked load balancer instances.

This method is only intended for use with schema creation or integration testing

Parameters

DatabaseDomain | string

$domain

Since

1.33

Implemented inWikimedia\Rdbms\LBFactory.

Rollback all primary connection transactions and flush all replica connection transactions.

This only applies to the instantiated tracked load balancer instances.

Parameters

string

$fname

Caller name

Since

1.37

Implemented inWikimedia\Rdbms\LBFactory.

Parameters

string

$agent

Agent name for query profiling

Implemented inWikimedia\Rdbms\LBFactory.

Set the default timeout for replication wait checks.

Parameters

int

$seconds

Timeout, in seconds

Returns

int The previous default timeout

Since

1.35

Implemented inWikimedia\Rdbms\LBFactory.

Convert certain database domains to alternative ones.

This can be used for backwards compatibility logic.

Parameters

DatabaseDomain[] | string[]

$aliases

Map of (domain alias => domain)

Since

1.35

Implemented inWikimedia\Rdbms\LBFactory.

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

Parameters

string

$prefix

Since

1.33

Implemented inWikimedia\Rdbms\LBFactory.

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 likeuser, 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[]

$aliases

Map of (table => (dbname, schema, prefix) map)

Since

1.31

Implemented inWikimedia\Rdbms\LBFactory.

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

Callbacks must clear any transactions that they start.

Parameters

string	$name	Callback name
callable | null	$callback	Use null to unset a callback

Deprecated

Since 1.44

Implemented inWikimedia\Rdbms\LBFactory.

Prepare all instantiated tracked load balancer instances for shutdown.

Parameters

int	$flags	Bit field of ILBFactory::SHUTDOWN_* constants
callable | null	$workCallback	Work to mask ChronologyProtector writes
int | null	&$cpIndex	Position key write counter for ChronologyProtector [returned]
string | null	&$cpClientId	Client ID hash for ChronologyProtector [returned]

Implemented inWikimedia\Rdbms\LBFactory.

Waits for the replica database server to catch up to the current primary position.

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

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.

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

This only applies to the instantiated tracked load balancer instances.

Parameters

array

$opts

Optional fields that include: 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

Implemented inWikimedia\Rdbms\LBFactory.

Default main cluster name (do not change this)

Definition at line53 of fileILBFactory.php.

Referenced byWikimedia\Rdbms\LBFactoryMulti\__construct().

Do not save "session consistency" DB replication positions.

Definition at line50 of fileILBFactory.php.

Idiom for "no special shutdown flags".

Definition at line48 of fileILBFactory.php.