From: Aaron Schulz <aschulz@wikimedia.org>
Date: Wed, 7 Aug 2019 20:47:23 +0000 (-0700)
Subject: rdbms: update LOCK IN SHARE MODE in IDatabase to reflect the level of support
X-Git-Tag: 1.34.0-rc.0~751
X-Git-Url: http://git.cyclocoop.org/data/%24self?a=commitdiff_plain;h=0c425797f5d2e2b8378c967d5045064b749b1def;p=lhc%2Fweb%2Fwiklou.git

rdbms: update LOCK IN SHARE MODE in IDatabase to reflect the level of support

Change-Id: I45eb27ffd105e9ca2c1bd9967c6db2719c835b27
---

diff --git a/includes/libs/rdbms/database/IDatabase.php b/includes/libs/rdbms/database/IDatabase.php
index 1c42d2d350..e480530c7c 100644
--- a/includes/libs/rdbms/database/IDatabase.php
+++ b/includes/libs/rdbms/database/IDatabase.php
@@ -679,10 +679,14 @@ interface IDatabase {
 	 *     and then the first rows are taken until the limit is reached. LIMIT
 	 *     is applied to a result set after OFFSET.
 	 *
-	 *   - FOR UPDATE: Boolean: lock the returned rows so that they can't be
+	 *   - LOCK IN SHARE MODE: Boolean: lock the returned rows so that they can't be
 	 *     changed until the next COMMIT. Cannot be used with aggregate functions
 	 *     (COUNT, MAX, etc., but also DISTINCT).
 	 *
+	 *   - FOR UPDATE: Boolean: lock the returned rows so that they can't be
+	 *     changed nor read with LOCK IN SHARE MODE until the next COMMIT.
+	 *     Cannot be used with aggregate functions (COUNT, MAX, etc., but also DISTINCT).
+	 *
 	 *   - DISTINCT: Boolean: return only unique result rows.
 	 *
 	 *   - GROUP BY: May be either an SQL fragment string naming a field or
@@ -707,7 +711,6 @@ interface IDatabase {
 	 * And also the following boolean MySQL extensions, see the MySQL manual
 	 * for documentation:
 	 *
-	 *    - LOCK IN SHARE MODE
 	 *    - STRAIGHT_JOIN
 	 *    - SQL_BIG_RESULT
 	 *    - SQL_BUFFER_RESULT