DBPrimaryPos class for MySQL/MariaDB. More...

Inheritance diagram for Wikimedia\Rdbms\MySQLPrimaryPos:

[legend]

Collaboration diagram for Wikimedia\Rdbms\MySQLPrimaryPos:

[legend]

Public Member Functions
	__construct ( $position, $asOfTime)

	__serialize ()

	__toString ()

	__unserialize ( $data)

	asOfTime ()

	channelsMatch (DBPrimaryPos $pos)

	getGTIDs ()

	getLogFile ()

	getLogName ()

	getLogPosition ()

	hasReached (DBPrimaryPos $pos)

	serialize ()

	setActiveDomain ( $id)
	Set the GTID domain known to be used in new commits on a replication stream of interest.

	setActiveOriginServerId ( $id)
	Set the server ID known to be used in new commits on a replication stream of interest.

	setActiveOriginServerUUID ( $id)
	Set the server UUID known to be used in new commits on a replication stream of interest.

	unserialize ( $serialized)

Static Public Member Functions
static	getRelevantActiveGTIDs (MySQLPrimaryPos $pos, MySQLPrimaryPos $refPos)

Protected Member Functions
	getActiveGtidCoordinates ()

	getBinlogCoordinates ()

	init ( $position, $asOfTime)

Static Protected Member Functions
static	parseGTID ( $id)

Private Attributes
string null	$activeDomain
	Active GTID domain ID.

string null	$activeServerId
	ID of the server were DB writes originate.

string null	$activeServerUUID
	UUID of the server were DB writes originate.

float	$asOfTime = 0.0
	UNIX timestamp.

string null	$binLog
	Base name of all Binary Log files.

string[]	$gtids = []
	Map of (server_uuid/gtid_domain_id => GTID)

array< int, int\|string > null	$logPos
	Binary Log position tuple (index number, event number)

string	$style
	One of (BINARY_LOG, GTID_MYSQL, GTID_MARIA)

const	BINARY_LOG = 'binary-log'

const	GTID_MARIA = 'gtid-maria'

const	GTID_MYSQL = 'gtid-mysql'

Detailed Description

DBPrimaryPos class for MySQL/MariaDB.

Note that primary positions and sync logic here make some assumptions:

Binlog-based usage assumes single-source replication and non-hierarchical replication.
GTID-based usage allows getting/syncing with multi-source replication. It is assumed that GTID sets are complete (e.g. include all domains on the server).

See also: https://mariadb.com/kb/en/library/gtid/; https://dev.mysql.com/doc/refman/5.6/en/replication-gtids-concepts.html

Since: 1.37

Definition at line 20 of file MySQLPrimaryPos.php.

Constructor & Destructor Documentation

◆ __construct()

Wikimedia\Rdbms\MySQLPrimaryPos::__construct	(	$position,
		$asOfTime
	)

Parameters

string	$position	One of (comma separated GTID list, <binlog file>/<64 bit integer>)
float	$asOfTime	UNIX timestamp

Definition at line 51 of file MySQLPrimaryPos.php.

References Wikimedia\Rdbms\MySQLPrimaryPos\$asOfTime, and Wikimedia\Rdbms\MySQLPrimaryPos\init().

Member Function Documentation

◆ __serialize()

Wikimedia\Rdbms\MySQLPrimaryPos::__serialize ( )

Definition at line 333 of file MySQLPrimaryPos.php.

◆ __toString()

Wikimedia\Rdbms\MySQLPrimaryPos::__toString ( )

Returns: string GTID set or <binary log file>/<position> (e.g db1034-bin.000976/843431247)

Implements Wikimedia\Rdbms\DBPrimaryPos.

Definition at line 367 of file MySQLPrimaryPos.php.

◆ __unserialize()

Wikimedia\Rdbms\MySQLPrimaryPos::__unserialize ( $data )

Definition at line 347 of file MySQLPrimaryPos.php.

◆ asOfTime()

Wikimedia\Rdbms\MySQLPrimaryPos::asOfTime ( )

Returns: float UNIX timestamp

Since: 1.25

Implements Wikimedia\Rdbms\DBPrimaryPos.

Definition at line 100 of file MySQLPrimaryPos.php.

References Wikimedia\Rdbms\MySQLPrimaryPos\$asOfTime.

Referenced by Wikimedia\Rdbms\MySQLPrimaryPos\init().

◆ channelsMatch()

Wikimedia\Rdbms\MySQLPrimaryPos::channelsMatch ( DBPrimaryPos $pos )

Parameters

DBPrimaryPos $pos

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

Since: 1.27

Implements Wikimedia\Rdbms\DBPrimaryPos.

Definition at line 138 of file MySQLPrimaryPos.php.

References Wikimedia\Rdbms\MySQLPrimaryPos\getActiveGtidCoordinates(), Wikimedia\Rdbms\MySQLPrimaryPos\getBinlogCoordinates(), and true.

◆ getActiveGtidCoordinates()

Wikimedia\Rdbms\MySQLPrimaryPos::getActiveGtidCoordinates ( )

protected

See also: https://mariadb.com/kb/en/mariadb/gtid; https://dev.mysql.com/doc/refman/5.6/en/replication-gtids-concepts.html

Returns: array<string,int> Map of (server_uuid/gtid_domain_id => integer position)

Definition at line 265 of file MySQLPrimaryPos.php.

References Wikimedia\Rdbms\MySQLPrimaryPos\$activeDomain, Wikimedia\Rdbms\MySQLPrimaryPos\$activeServerId, Wikimedia\Rdbms\MySQLPrimaryPos\$activeServerUUID, and Wikimedia\Rdbms\MySQLPrimaryPos\parseGTID().

Referenced by Wikimedia\Rdbms\MySQLPrimaryPos\channelsMatch(), Wikimedia\Rdbms\MySQLPrimaryPos\getRelevantActiveGTIDs(), and Wikimedia\Rdbms\MySQLPrimaryPos\hasReached().

◆ getBinlogCoordinates()

Wikimedia\Rdbms\MySQLPrimaryPos::getBinlogCoordinates ( )

protected

See also: https://dev.mysql.com/doc/refman/5.7/en/show-master-status.html; https://dev.mysql.com/doc/refman/5.7/en/show-slave-status.html

Returns: array|bool Map of (binlog:<string>, pos:(<integer>, <integer>)) or false

Definition at line 323 of file MySQLPrimaryPos.php.

References Wikimedia\Rdbms\MySQLPrimaryPos\$binLog, and Wikimedia\Rdbms\MySQLPrimaryPos\$logPos.

Referenced by Wikimedia\Rdbms\MySQLPrimaryPos\channelsMatch(), and Wikimedia\Rdbms\MySQLPrimaryPos\hasReached().

◆ getGTIDs()

Wikimedia\Rdbms\MySQLPrimaryPos::getGTIDs ( )

Returns: array<string,string> Map of (server_uuid/gtid_domain_id => GTID)

Since: 1.31

Definition at line 190 of file MySQLPrimaryPos.php.

References Wikimedia\Rdbms\MySQLPrimaryPos\$gtids.

◆ getLogFile()

Wikimedia\Rdbms\MySQLPrimaryPos::getLogFile ( )

Returns: string|null Name of the binary log file for this position

Since: 1.31

Definition at line 181 of file MySQLPrimaryPos.php.

◆ getLogName()

Wikimedia\Rdbms\MySQLPrimaryPos::getLogName ( )

Returns: string|null Base name of binary log files

Since: 1.31

Definition at line 165 of file MySQLPrimaryPos.php.

References Wikimedia\Rdbms\MySQLPrimaryPos\$binLog.

◆ getLogPosition()

Wikimedia\Rdbms\MySQLPrimaryPos::getLogPosition ( )

Returns: array<int,int|string>|null Tuple of (binary log file number, 64 bit event number)

Since: 1.31

Definition at line 173 of file MySQLPrimaryPos.php.

References Wikimedia\Rdbms\MySQLPrimaryPos\$logPos.

◆ getRelevantActiveGTIDs()

static Wikimedia\Rdbms\MySQLPrimaryPos::getRelevantActiveGTIDs	(	MySQLPrimaryPos	$pos,
		MySQLPrimaryPos	$refPos
	)

static

Parameters

MySQLPrimaryPos	$pos
MySQLPrimaryPos	$refPos

Returns: string[] List of active GTIDs from $pos that have domains in $refPos

Since: 1.34

Definition at line 252 of file MySQLPrimaryPos.php.

References Wikimedia\Rdbms\MySQLPrimaryPos\getActiveGtidCoordinates().

◆ hasReached()

Wikimedia\Rdbms\MySQLPrimaryPos::hasReached ( DBPrimaryPos $pos )

Parameters

DBPrimaryPos $pos

Returns: bool Whether this position is at or higher than $pos

Since: 1.27

Implements Wikimedia\Rdbms\DBPrimaryPos.

Definition at line 104 of file MySQLPrimaryPos.php.

References Wikimedia\Rdbms\MySQLPrimaryPos\getActiveGtidCoordinates(), and Wikimedia\Rdbms\MySQLPrimaryPos\getBinlogCoordinates().

◆ init()

Wikimedia\Rdbms\MySQLPrimaryPos::init	(	$position,
		$asOfTime
	)

protected

Parameters

string	$position
float	$asOfTime

Definition at line 59 of file MySQLPrimaryPos.php.

References Wikimedia\Rdbms\MySQLPrimaryPos\$asOfTime, Wikimedia\Rdbms\MySQLPrimaryPos\$gtids, Wikimedia\Rdbms\MySQLPrimaryPos\asOfTime(), Wikimedia\Rdbms\MySQLPrimaryPos\BINARY_LOG, Wikimedia\Rdbms\MySQLPrimaryPos\GTID_MARIA, Wikimedia\Rdbms\MySQLPrimaryPos\GTID_MYSQL, and Wikimedia\Rdbms\MySQLPrimaryPos\parseGTID().

Referenced by Wikimedia\Rdbms\MySQLPrimaryPos\__construct().

◆ parseGTID()

static Wikimedia\Rdbms\MySQLPrimaryPos::parseGTID ( $id )

staticprotected

Parameters

string $id GTID

Returns: string[]|null (domain ID, event number, source server ID) for MariaDB, (source server UUID, event number, source server UUID) for MySQL, or null

Definition at line 296 of file MySQLPrimaryPos.php.

Referenced by Wikimedia\Rdbms\MySQLPrimaryPos\getActiveGtidCoordinates(), and Wikimedia\Rdbms\MySQLPrimaryPos\init().

◆ serialize()

Wikimedia\Rdbms\MySQLPrimaryPos::serialize ( )

Definition at line 329 of file MySQLPrimaryPos.php.

◆ setActiveDomain()

Wikimedia\Rdbms\MySQLPrimaryPos::setActiveDomain ( $id )

Set the GTID domain known to be used in new commits on a replication stream of interest.

This makes getRelevantActiveGTIDs() filter out GTIDs from other domains

See also: MySQLPrimaryPos::getRelevantActiveGTIDs(); https://mariadb.com/kb/en/library/gtid/#gtid_domain_id

Parameters

string | int | null $id @gtid_domain_id of the active replication stream

Returns: MySQLPrimaryPos This instance (since 1.34)

Since: 1.31

Definition at line 206 of file MySQLPrimaryPos.php.

◆ setActiveOriginServerId()

Wikimedia\Rdbms\MySQLPrimaryPos::setActiveOriginServerId ( $id )

Set the server ID known to be used in new commits on a replication stream of interest.

This makes getRelevantActiveGTIDs() filter out GTIDs from other origin servers

See also: MySQLPrimaryPos::getRelevantActiveGTIDs()

Parameters

string | int | null $id @server_id of the server were writes originate

Returns: MySQLPrimaryPos This instance (since 1.34)

Since: 1.31

Definition at line 223 of file MySQLPrimaryPos.php.

◆ setActiveOriginServerUUID()

Wikimedia\Rdbms\MySQLPrimaryPos::setActiveOriginServerUUID ( $id )

Set the server UUID known to be used in new commits on a replication stream of interest.

This makes getRelevantActiveGTIDs() filter out GTIDs from other origin servers

See also: MySQLPrimaryPos::getRelevantActiveGTIDs()

Parameters

string | null $id @server_uuid of the server were writes originate

Returns: MySQLPrimaryPos This instance (since 1.34)

Since: 1.31

Definition at line 240 of file MySQLPrimaryPos.php.

◆ unserialize()

Wikimedia\Rdbms\MySQLPrimaryPos::unserialize ( $serialized )

Definition at line 343 of file MySQLPrimaryPos.php.

Member Data Documentation

◆ $activeDomain

string null Wikimedia\Rdbms\MySQLPrimaryPos::$activeDomain

private

Active GTID domain ID.

Definition at line 30 of file MySQLPrimaryPos.php.

Referenced by Wikimedia\Rdbms\MySQLPrimaryPos\getActiveGtidCoordinates().

◆ $activeServerId

string null Wikimedia\Rdbms\MySQLPrimaryPos::$activeServerId

private

ID of the server were DB writes originate.

Definition at line 32 of file MySQLPrimaryPos.php.

Referenced by Wikimedia\Rdbms\MySQLPrimaryPos\getActiveGtidCoordinates().

◆ $activeServerUUID

string null Wikimedia\Rdbms\MySQLPrimaryPos::$activeServerUUID

private

UUID of the server were DB writes originate.

Definition at line 34 of file MySQLPrimaryPos.php.

Referenced by Wikimedia\Rdbms\MySQLPrimaryPos\getActiveGtidCoordinates().

◆ $asOfTime

float Wikimedia\Rdbms\MySQLPrimaryPos::$asOfTime = 0.0

private

UNIX timestamp.

Definition at line 36 of file MySQLPrimaryPos.php.

Referenced by Wikimedia\Rdbms\MySQLPrimaryPos\__construct(), Wikimedia\Rdbms\MySQLPrimaryPos\asOfTime(), and Wikimedia\Rdbms\MySQLPrimaryPos\init().

◆ $binLog

string null Wikimedia\Rdbms\MySQLPrimaryPos::$binLog

private

Base name of all Binary Log files.

Definition at line 24 of file MySQLPrimaryPos.php.

Referenced by Wikimedia\Rdbms\MySQLPrimaryPos\getBinlogCoordinates(), and Wikimedia\Rdbms\MySQLPrimaryPos\getLogName().

◆ $gtids

string [] Wikimedia\Rdbms\MySQLPrimaryPos::$gtids = []

private

Map of (server_uuid/gtid_domain_id => GTID)

Definition at line 28 of file MySQLPrimaryPos.php.

Referenced by Wikimedia\Rdbms\MySQLPrimaryPos\getGTIDs(), and Wikimedia\Rdbms\MySQLPrimaryPos\init().

◆ $logPos

array<int,int|string> null Wikimedia\Rdbms\MySQLPrimaryPos::$logPos

private

Binary Log position tuple (index number, event number)

Definition at line 26 of file MySQLPrimaryPos.php.

Referenced by Wikimedia\Rdbms\MySQLPrimaryPos\getBinlogCoordinates(), and Wikimedia\Rdbms\MySQLPrimaryPos\getLogPosition().

◆ $style

string Wikimedia\Rdbms\MySQLPrimaryPos::$style

private

One of (BINARY_LOG, GTID_MYSQL, GTID_MARIA)

Definition at line 22 of file MySQLPrimaryPos.php.

◆ BINARY_LOG

const Wikimedia\Rdbms\MySQLPrimaryPos::BINARY_LOG = 'binary-log'

private

Definition at line 38 of file MySQLPrimaryPos.php.

Referenced by Wikimedia\Rdbms\MySQLPrimaryPos\init().

◆ GTID_MARIA

const Wikimedia\Rdbms\MySQLPrimaryPos::GTID_MARIA = 'gtid-maria'

private

Definition at line 39 of file MySQLPrimaryPos.php.

Referenced by Wikimedia\Rdbms\MySQLPrimaryPos\init().

◆ GTID_MYSQL

const Wikimedia\Rdbms\MySQLPrimaryPos::GTID_MYSQL = 'gtid-mysql'

private

Definition at line 40 of file MySQLPrimaryPos.php.

Referenced by Wikimedia\Rdbms\MySQLPrimaryPos\init().

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

includes/libs/rdbms/database/position/MySQLPrimaryPos.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __serialize()

◆ __toString()

◆ __unserialize()

◆ asOfTime()

◆ channelsMatch()

◆ getActiveGtidCoordinates()

◆ getBinlogCoordinates()

◆ getGTIDs()

◆ getLogFile()

◆ getLogName()

◆ getLogPosition()

◆ getRelevantActiveGTIDs()

◆ hasReached()

◆ init()

◆ parseGTID()

◆ serialize()

◆ setActiveDomain()

◆ setActiveOriginServerId()

◆ setActiveOriginServerUUID()

◆ unserialize()

Member Data Documentation

◆ $activeDomain

◆ $activeServerId

◆ $activeServerUUID

◆ $asOfTime

◆ $binLog

◆ $gtids

◆ $logPos

◆ $style

◆ BINARY_LOG

◆ GTID_MARIA

◆ GTID_MYSQL