The functions listed in this section are used for controlling position-based synchronization of source and replica servers in MySQL Replication.
Table 12.28 Positional Synchronization Functions
Deprecated alias for
This function is for control of source-replica synchronization. It blocks until the replica has read and applied all updates up to the specified position in the source's binary log.
The return value is the number of log events the replica had to wait for to advance to the specified position. The function returns
NULLif the replication SQL thread is not started, the replica's source information is not initialized, the arguments are incorrect, or an error occurs. It returns
-1if the timeout has been exceeded. If the replication SQL thread stops while
SOURCE_POS_WAIT()is waiting, the function returns
NULL. If the replica is past the specified position, the function returns immediately.
If the binary log file position has been marked as invalid, the function waits until a valid file position is known. The binary log file position can be marked as invalid when the
CHANGE REPLICATION SOURCE TOoption
GTID_ONLYis set for the replication channel, and the server is restarted or replication is stopped. The file position becomes valid after a transaction is successfully applied past the given file position. If the applier does not reach the stated position, the function waits until the timeout. Use a
SHOW REPLICA STATUSstatement to check if the binary log file position has been marked as invalid.
On a multithreaded replica, the function waits until expiry of the limit set by the
replica_checkpoint_periodsystem variable, when the checkpoint operation is called to update the status of the replica. Depending on the setting for the system variables, the function might therefore return some time after the specified position was reached.
If binary log transaction compression is in use and the transaction payload at the specified position is compressed (as a
Transaction_payload_event), the function waits until the whole transaction has been read and applied, and the positions have updated.
timeoutvalue is specified,
SOURCE_POS_WAIT()stops waiting when
timeoutseconds have elapsed.
timeoutmust be greater than or equal to 0. (When the server is running in strict SQL mode, a negative
timeoutvalue is immediately rejected with
ER_WRONG_ARGUMENTS; otherwise the function returns
NULL, and raises a warning.)
channelvalue enables you to name which replication channel the function applies to. See Section 17.2.2, “Replication Channels” for more information.
This function is unsafe for statement-based replication. A warning is logged if you use this function when
binlog_formatis set to