Wikimedia\Rdbms\DBPrimaryPos Interface Reference
An object representing a primary or replica DB position in a replicated setup. More...
Inheritance diagram for Wikimedia\Rdbms\DBPrimaryPos:
Collaboration diagram for Wikimedia\Rdbms\DBPrimaryPos:
Public Member Functions | |
| __toString () | |
| asOfTime () | |
| channelsMatch (DBPrimaryPos $pos) | |
| hasReached (DBPrimaryPos $pos) | |
| toArray () | |
| Serialization for storage. | |
Static Public Member Functions | |
| static | newFromArray (array $data) |
| Deserialization from storage. | |
Detailed Description
An object representing a primary or replica DB position in a replicated setup.
The implementation details of this opaque type are up to the database subclass.
- Since
- 1.37
- Stability: stable
- to implement
Definition at line 15 of file DBPrimaryPos.php.
Member Function Documentation
◆ __toString()
| Wikimedia\Rdbms\DBPrimaryPos::__toString | ( | ) |
- Since
- 1.27
- Returns
- string
Implemented in Wikimedia\Rdbms\MySQLPrimaryPos.
Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\primaryPosWait().
◆ asOfTime()
| Wikimedia\Rdbms\DBPrimaryPos::asOfTime | ( | ) |
◆ channelsMatch()
| Wikimedia\Rdbms\DBPrimaryPos::channelsMatch | ( | DBPrimaryPos | $pos | ) |
- Since
- 1.27
- Parameters
-
DBPrimaryPos $pos
- Returns
- bool Whether this position appears to be for the same channel as another
Implemented in Wikimedia\Rdbms\MySQLPrimaryPos.
◆ hasReached()
| Wikimedia\Rdbms\DBPrimaryPos::hasReached | ( | DBPrimaryPos | $pos | ) |
- Since
- 1.27
- Parameters
-
DBPrimaryPos $pos
- Returns
- bool Whether this position is at or higher than $pos
Implemented in Wikimedia\Rdbms\MySQLPrimaryPos.
◆ newFromArray()
|
static |
Deserialization from storage.
- Since
- 1.39
- Parameters
-
array $data Representation as returned from ::toArray()
- Returns
- DBPrimaryPos
Implemented in Wikimedia\Rdbms\MySQLPrimaryPos.
◆ toArray()
| Wikimedia\Rdbms\DBPrimaryPos::toArray | ( | ) |
Serialization for storage.
- Since
- 1.39
- Returns
- array Representation for use by ::newFromArray()
Implemented in Wikimedia\Rdbms\MySQLPrimaryPos.
The documentation for this interface was generated from the following file:
- includes/libs/rdbms/database/position/DBPrimaryPos.php
