DBMasterPos class for MySQL/MariaDB. More...

Inheritance diagram for Wikimedia\Rdbms\MySQLMasterPos:

[legend]

Collaboration diagram for Wikimedia\Rdbms\MySQLMasterPos:

[legend]

Public Member Functions
	__construct ( $position, $asOfTime)

	__toString ()

	asOfTime ()

	channelsMatch (DBMasterPos $pos)

	getGTIDs ()

	getLogFile ()

	getLogName ()

	getLogPosition ()

	hasReached (DBMasterPos $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 (MySQLMasterPos $pos, MySQLMasterPos $refPos)

Public Attributes
const	BINARY_LOG = 'binary-log'

const	GTID_MARIA = 'gtid-maria'

const	GTID_MYSQL = 'gtid-mysql'

Protected Member Functions
	getActiveGtidCoordinates ()

	getBinlogCoordinates ()

	init ( $position, $asOfTime)

Static Protected Member Functions
static	parseGTID ( $id)

Private Attributes
int null	$activeDomain
	Active GTID domain ID.

int 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)

int[] null	$logPos
	Binary Log position tuple (index number, event number)

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

Detailed Description

DBMasterPos class for MySQL/MariaDB.

Note that master 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

Definition at line 19 of file MySQLMasterPos.php.

Constructor & Destructor Documentation

◆ __construct()

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

Parameters

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

Definition at line 50 of file MySQLMasterPos.php.

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

Member Function Documentation

◆ __toString()

Wikimedia\Rdbms\MySQLMasterPos::__toString ( )

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

Implements Wikimedia\Rdbms\DBMasterPos.

Definition at line 351 of file MySQLMasterPos.php.

References Wikimedia\Rdbms\MySQLMasterPos\getLogFile().

Referenced by Wikimedia\Rdbms\MySQLMasterPos\serialize().

◆ asOfTime()

Wikimedia\Rdbms\MySQLMasterPos::asOfTime ( )

Returns: float UNIX timestamp

Since: 1.25

Implements Wikimedia\Rdbms\DBMasterPos.

Definition at line 99 of file MySQLMasterPos.php.

References Wikimedia\Rdbms\MySQLMasterPos\$asOfTime.

Referenced by Wikimedia\Rdbms\MySQLMasterPos\init(), and Wikimedia\Rdbms\MySQLMasterPos\serialize().

◆ channelsMatch()

Wikimedia\Rdbms\MySQLMasterPos::channelsMatch ( DBMasterPos $pos )

Parameters

DBMasterPos $pos

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

Since: 1.27

Implements Wikimedia\Rdbms\DBMasterPos.

Definition at line 137 of file MySQLMasterPos.php.

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

◆ getActiveGtidCoordinates()

Wikimedia\Rdbms\MySQLMasterPos::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 Map of (server_uuid/gtid_domain_id => integer position); possibly empty

Definition at line 263 of file MySQLMasterPos.php.

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

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

◆ getBinlogCoordinates()

Wikimedia\Rdbms\MySQLMasterPos::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 314 of file MySQLMasterPos.php.

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

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

◆ getGTIDs()

Wikimedia\Rdbms\MySQLMasterPos::getGTIDs ( )

Returns: string[] Map of (server_uuid/gtid_domain_id => GTID)

Since: 1.31

Definition at line 188 of file MySQLMasterPos.php.

References Wikimedia\Rdbms\MySQLMasterPos\$gtids.

◆ getLogFile()

Wikimedia\Rdbms\MySQLMasterPos::getLogFile ( )

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

Since: 1.31

Definition at line 180 of file MySQLMasterPos.php.

Referenced by Wikimedia\Rdbms\MySQLMasterPos\__toString().

◆ getLogName()

Wikimedia\Rdbms\MySQLMasterPos::getLogName ( )

Returns: string|null Base name of binary log files

Since: 1.31

Definition at line 164 of file MySQLMasterPos.php.

References Wikimedia\Rdbms\MySQLMasterPos\$binLog.

◆ getLogPosition()

Wikimedia\Rdbms\MySQLMasterPos::getLogPosition ( )

Returns: int[]|null Tuple of (binary log file number, event number)

Since: 1.31

Definition at line 172 of file MySQLMasterPos.php.

References Wikimedia\Rdbms\MySQLMasterPos\$logPos.

◆ getRelevantActiveGTIDs()

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

static

Parameters

MySQLMasterPos	$pos
MySQLMasterPos	$refPos

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

Since: 1.34

Definition at line 250 of file MySQLMasterPos.php.

References Wikimedia\Rdbms\MySQLMasterPos\getActiveGtidCoordinates().

◆ hasReached()

Wikimedia\Rdbms\MySQLMasterPos::hasReached ( DBMasterPos $pos )

Parameters

DBMasterPos $pos

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

Since: 1.27

Implements Wikimedia\Rdbms\DBMasterPos.

Definition at line 103 of file MySQLMasterPos.php.

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

◆ init()

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

protected

Parameters

string	$position
float	$asOfTime

Definition at line 58 of file MySQLMasterPos.php.

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

Referenced by Wikimedia\Rdbms\MySQLMasterPos\__construct(), and Wikimedia\Rdbms\MySQLMasterPos\unserialize().

◆ parseGTID()

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

staticprotected

Parameters

string $id GTID

Returns: array|null [domain ID or server UUID, sequence number, server ID/UUID] or null

Definition at line 293 of file MySQLMasterPos.php.

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

◆ serialize()

Wikimedia\Rdbms\MySQLMasterPos::serialize ( )

Definition at line 320 of file MySQLMasterPos.php.

References Wikimedia\Rdbms\MySQLMasterPos\__toString(), Wikimedia\Rdbms\MySQLMasterPos\asOfTime(), and Wikimedia\Rdbms\MySQLMasterPos\serialize().

Referenced by Wikimedia\Rdbms\MySQLMasterPos\serialize().

◆ setActiveDomain()

Wikimedia\Rdbms\MySQLMasterPos::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: MySQLMasterPos::getRelevantActiveGTIDs(); https://mariadb.com/kb/en/library/gtid/#gtid_domain_id

Parameters

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

Returns: MySQLMasterPos This instance (since 1.34)

Since: 1.31

Definition at line 204 of file MySQLMasterPos.php.

Referenced by Wikimedia\Rdbms\MySQLMasterPos\unserialize().

◆ setActiveOriginServerId()

Wikimedia\Rdbms\MySQLMasterPos::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: MySQLMasterPos::getRelevantActiveGTIDs()

Parameters

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

Returns: MySQLMasterPos This instance (since 1.34)

Since: 1.31

Definition at line 221 of file MySQLMasterPos.php.

Referenced by Wikimedia\Rdbms\MySQLMasterPos\unserialize().

◆ setActiveOriginServerUUID()

Wikimedia\Rdbms\MySQLMasterPos::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: MySQLMasterPos::getRelevantActiveGTIDs()

Parameters

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

Returns: MySQLMasterPos This instance (since 1.34)

Since: 1.31

Definition at line 238 of file MySQLMasterPos.php.

Referenced by Wikimedia\Rdbms\MySQLMasterPos\unserialize().

◆ unserialize()

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

Definition at line 330 of file MySQLMasterPos.php.

References $serialized, Wikimedia\Rdbms\MySQLMasterPos\init(), Wikimedia\Rdbms\MySQLMasterPos\setActiveDomain(), Wikimedia\Rdbms\MySQLMasterPos\setActiveOriginServerId(), Wikimedia\Rdbms\MySQLMasterPos\setActiveOriginServerUUID(), and Wikimedia\Rdbms\MySQLMasterPos\unserialize().

Referenced by Wikimedia\Rdbms\MySQLMasterPos\unserialize().

Member Data Documentation

◆ $activeDomain

int null Wikimedia\Rdbms\MySQLMasterPos::$activeDomain

private

Active GTID domain ID.

Definition at line 29 of file MySQLMasterPos.php.

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

◆ $activeServerId

int null Wikimedia\Rdbms\MySQLMasterPos::$activeServerId

private

ID of the server were DB writes originate.

Definition at line 31 of file MySQLMasterPos.php.

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

◆ $activeServerUUID

string null Wikimedia\Rdbms\MySQLMasterPos::$activeServerUUID

private

UUID of the server were DB writes originate.

Definition at line 33 of file MySQLMasterPos.php.

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

◆ $asOfTime

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

private

UNIX timestamp.

Definition at line 35 of file MySQLMasterPos.php.

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

◆ $binLog

string null Wikimedia\Rdbms\MySQLMasterPos::$binLog

private

Base name of all Binary Log files.

Definition at line 23 of file MySQLMasterPos.php.

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

◆ $gtids

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

private

Map of (server_uuid/gtid_domain_id => GTID)

Definition at line 27 of file MySQLMasterPos.php.

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

◆ $logPos

int [] null Wikimedia\Rdbms\MySQLMasterPos::$logPos

private

Binary Log position tuple (index number, event number)

Definition at line 25 of file MySQLMasterPos.php.

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

◆ $style

string Wikimedia\Rdbms\MySQLMasterPos::$style

private

One of (BINARY_LOG, GTID_MYSQL, GTID_MARIA)

Definition at line 21 of file MySQLMasterPos.php.

◆ BINARY_LOG

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

Definition at line 37 of file MySQLMasterPos.php.

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

◆ GTID_MARIA

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

Definition at line 38 of file MySQLMasterPos.php.

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

◆ GTID_MYSQL

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

Definition at line 39 of file MySQLMasterPos.php.

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

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

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

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __toString()

◆ 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