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)

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

(

)

Returns

string

Since

1.27

Implemented in Wikimedia\Rdbms\MySQLPrimaryPos.

Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\primaryPosWait().

asOfTime()

Wikimedia\Rdbms\DBPrimaryPos::asOfTime

(

)

Returns

float UNIX timestamp

Since

1.25

Implemented in Wikimedia\Rdbms\MySQLPrimaryPos.

channelsMatch()

Wikimedia\Rdbms\DBPrimaryPos::channelsMatch

(

DBPrimaryPos

$pos

)

Parameters

DBPrimaryPos

$pos

Returns

bool Whether this position appears to be for the same channel as another

Since

1.27

Implemented in Wikimedia\Rdbms\MySQLPrimaryPos.

hasReached()

Wikimedia\Rdbms\DBPrimaryPos::hasReached

(

DBPrimaryPos

$pos

)

Parameters

DBPrimaryPos

$pos

Returns

bool Whether this position is at or higher than $pos

Since

1.27

Implemented in Wikimedia\Rdbms\MySQLPrimaryPos.

Referenced by Wikimedia\Rdbms\LoadBalancer\doWait().

---

The documentation for this interface was generated from the following file:

• includes/libs/rdbms/database/position/DBPrimaryPos.php