rdbms: add transaction comment to IDatabase::masterPosWait()
authorAaron Schulz <aschulz@wikimedia.org>
Tue, 23 Oct 2018 04:08:44 +0000 (21:08 -0700)
committerAaron Schulz <aschulz@wikimedia.org>
Thu, 25 Oct 2018 22:07:02 +0000 (22:07 +0000)
Change-Id: I95aa3b678b76cd06439d1feaba7f09a9c13f8931

includes/libs/rdbms/database/IDatabase.php

index 1973322..6d78dfc 100644 (file)
@@ -1478,6 +1478,10 @@ interface IDatabase {
        /**
         * Wait for the replica DB to catch up to a given master position
         *
+        * Note that this does not start any new transactions. If any existing transaction
+        * is flushed, and this is called, then queries will reflect the point the DB was synced
+        * up to (on success) without interference from REPEATABLE-READ snapshots.
+        *
         * @param DBMasterPos $pos
         * @param int $timeout The maximum number of seconds to wait for synchronisation
         * @return int|null Zero if the replica DB was past that position already,