X-Git-Url: https://git.cyclocoop.org/%27.%24link.%27?a=blobdiff_plain;f=includes%2Flibs%2Frdbms%2Floadbalancer%2FILoadBalancer.php;h=fec496e45591fb12fd3d0056cdc180131ff860eb;hb=c91a71c5f608675df6205a945bdc4be29d81d21e;hp=715f4e4d297268d0b98e229d7624f80abfdc0bb1;hpb=48a6894abbb26e5e93437bf30cf0fee54db052a4;p=lhc%2Fweb%2Fwiklou.git

diff --git a/includes/libs/rdbms/loadbalancer/ILoadBalancer.php b/includes/libs/rdbms/loadbalancer/ILoadBalancer.php
index 715f4e4d29..fec496e455 100644
--- a/includes/libs/rdbms/loadbalancer/ILoadBalancer.php
+++ b/includes/libs/rdbms/loadbalancer/ILoadBalancer.php
@@ -85,6 +85,8 @@ interface ILoadBalancer {
 	const DOMAIN_ANY = '';
 
 	/** @var int DB handle should have DBO_TRX disabled and the caller will leave it as such */
+	const CONN_TRX_AUTOCOMMIT = 1;
+	/** @var int Alias for CONN_TRX_AUTOCOMMIT for b/c; deprecated since 1.31 */
 	const CONN_TRX_AUTO = 1;
 
 	/**
@@ -99,7 +101,7 @@ interface ILoadBalancer {
 	 *  - maxLag: Avoid replica DB servers with more lag than this [optional]
 	 *  - srvCache : BagOStuff object for server cache [optional]
 	 *  - wanCache : WANObjectCache object [optional]
-	 *  - chronologyProtector: ChronologyProtector object [optional]
+	 *  - chronologyCallback: Callback to run before the first connection attempt [optional]
 	 *  - hostname : The name of the current server [optional]
 	 *  - cliMode: Whether the execution context is a CLI script. [optional]
 	 *  - profiler : Class name or instance with profileIn()/profileOut() methods. [optional]
@@ -165,23 +167,26 @@ interface ILoadBalancer {
 	/**
 	 * Get any open connection to a given server index, local or foreign
 	 *
+	 * Use CONN_TRX_AUTOCOMMIT to only look for connections opened with that flag
+	 *
 	 * @param int $i Server index or DB_MASTER/DB_REPLICA
+	 * @param int $flags Bitfield of CONN_* class constants
 	 * @return Database|bool False if no such connection is open
 	 */
-	public function getAnyOpenConnection( $i );
+	public function getAnyOpenConnection( $i, $flags = 0 );
 
 	/**
 	 * Get a connection handle by server index
 	 *
-	 * The CONN_TRX_AUTO flag is ignored for databases with ATTR_DB_LEVEL_LOCKING
+	 * The CONN_TRX_AUTOCOMMIT flag is ignored for databases with ATTR_DB_LEVEL_LOCKING
 	 * (e.g. sqlite) in order to avoid deadlocks. ILoadBalancer::getServerAttributes()
 	 * can be used to check such flags beforehand.
 	 *
-	 * If the caller uses $domain or sets CONN_TRX_AUTO in $flags, then it must also
+	 * If the caller uses $domain or sets CONN_TRX_AUTOCOMMIT in $flags, then it must also
 	 * call ILoadBalancer::reuseConnection() on the handle when finished using it.
 	 * In all other cases, this is not necessary, though not harmful either.
 	 *
-	 * @param int $i Server index or DB_MASTER/DB_REPLICA
+	 * @param int $i Server index (overrides $groups) or DB_MASTER/DB_REPLICA
 	 * @param array|string|bool $groups Query group(s), or false for the generic reader
 	 * @param string|bool $domain Domain ID, or false for the current domain
 	 * @param int $flags Bitfield of CONN_* class constants
@@ -209,7 +214,7 @@ interface ILoadBalancer {
 	 *
 	 * The handle's methods simply wrap those of a Database handle
 	 *
-	 * The CONN_TRX_AUTO flag is ignored for databases with ATTR_DB_LEVEL_LOCKING
+	 * The CONN_TRX_AUTOCOMMIT flag is ignored for databases with ATTR_DB_LEVEL_LOCKING
 	 * (e.g. sqlite) in order to avoid deadlocks. ILoadBalancer::getServerAttributes()
 	 * can be used to check such flags beforehand.
 	 *
@@ -218,7 +223,7 @@ interface ILoadBalancer {
 	 * @param int $i Server index or DB_MASTER/DB_REPLICA
 	 * @param array|string|bool $groups Query group(s), or false for the generic reader
 	 * @param string|bool $domain Domain ID, or false for the current domain
-	 * @param int $flags Bitfield of CONN_* class constants (e.g. CONN_TRX_AUTO)
+	 * @param int $flags Bitfield of CONN_* class constants (e.g. CONN_TRX_AUTOCOMMIT)
 	 * @return DBConnRef
 	 */
 	public function getConnectionRef( $i, $groups = [], $domain = false, $flags = 0 );
@@ -228,7 +233,7 @@ interface ILoadBalancer {
 	 *
 	 * The handle's methods simply wrap those of a Database handle
 	 *
-	 * The CONN_TRX_AUTO flag is ignored for databases with ATTR_DB_LEVEL_LOCKING
+	 * The CONN_TRX_AUTOCOMMIT flag is ignored for databases with ATTR_DB_LEVEL_LOCKING
 	 * (e.g. sqlite) in order to avoid deadlocks. ILoadBalancer::getServerAttributes()
 	 * can be used to check such flags beforehand.
 	 *
@@ -237,7 +242,7 @@ interface ILoadBalancer {
 	 * @param int $i Server index or DB_MASTER/DB_REPLICA
 	 * @param array|string|bool $groups Query group(s), or false for the generic reader
 	 * @param string|bool $domain Domain ID, or false for the current domain
-	 * @param int $flags Bitfield of CONN_* class constants (e.g. CONN_TRX_AUTO)
+	 * @param int $flags Bitfield of CONN_* class constants (e.g. CONN_TRX_AUTOCOMMIT)
 	 * @return DBConnRef
 	 */
 	public function getLazyConnectionRef( $i, $groups = [], $domain = false, $flags = 0 );
@@ -247,7 +252,7 @@ interface ILoadBalancer {
 	 *
 	 * The handle's methods simply wrap those of a Database handle
 	 *
-	 * The CONN_TRX_AUTO flag is ignored for databases with ATTR_DB_LEVEL_LOCKING
+	 * The CONN_TRX_AUTOCOMMIT flag is ignored for databases with ATTR_DB_LEVEL_LOCKING
 	 * (e.g. sqlite) in order to avoid deadlocks. ILoadBalancer::getServerAttributes()
 	 * can be used to check such flags beforehand.
 	 *
@@ -256,7 +261,7 @@ interface ILoadBalancer {
 	 * @param int $db Server index or DB_MASTER/DB_REPLICA
 	 * @param array|string|bool $groups Query group(s), or false for the generic reader
 	 * @param string|bool $domain Domain ID, or false for the current domain
-	 * @param int $flags Bitfield of CONN_* class constants (e.g. CONN_TRX_AUTO)
+	 * @param int $flags Bitfield of CONN_* class constants (e.g. CONN_TRX_AUTOCOMMIT)
 	 * @return MaintainableDBConnRef
 	 */
 	public function getMaintenanceConnectionRef( $db, $groups = [], $domain = false, $flags = 0 );
@@ -267,11 +272,11 @@ interface ILoadBalancer {
 	 * The index must be an actual index into the array. If a connection to the server is
 	 * already open and not considered an "in use" foreign connection, this simply returns it.
 	 *
-	 * Avoid using CONN_TRX_AUTO for databases with ATTR_DB_LEVEL_LOCKING (e.g. sqlite) in
+	 * Avoid using CONN_TRX_AUTOCOMMIT for databases with ATTR_DB_LEVEL_LOCKING (e.g. sqlite) in
 	 * order to avoid deadlocks. ILoadBalancer::getServerAttributes() can be used to check
 	 * such flags beforehand.
 	 *
-	 * If the caller uses $domain or sets CONN_TRX_AUTO in $flags, then it must also
+	 * If the caller uses $domain or sets CONN_TRX_AUTOCOMMIT in $flags, then it must also
 	 * call ILoadBalancer::reuseConnection() on the handle when finished using it.
 	 * In all other cases, this is not necessary, though not harmful either.
 	 *
@@ -279,7 +284,7 @@ interface ILoadBalancer {
 	 *
 	 * @param int $i Server index (does not support DB_MASTER/DB_REPLICA)
 	 * @param string|bool $domain Domain ID, or false for the current domain
-	 * @param int $flags Bitfield of CONN_* class constants (e.g. CONN_TRX_AUTO)
+	 * @param int $flags Bitfield of CONN_* class constants (e.g. CONN_TRX_AUTOCOMMIT)
 	 * @return Database|bool Returns false on errors
 	 * @throws DBAccessError
 	 */