Bug #26623 MASTER_POS_WAIT help topic is incomplete
Submitted: 25 Feb 2007 20:08 Modified: 27 Feb 2007 8:11
Reporter: Baron Schwartz (Basic Quality Contributor) Email Updates:
Status: Closed Impact on me:
None 
Category:MySQL Server: Documentation Severity:S3 (Non-critical)
Version:5.0.24a-Debian_9-log OS:Linux (Ubuntu)
Assigned to: MC Brown CPU Architecture:Any
Tags: qc

[25 Feb 2007 20:08] Baron Schwartz 
Description:
The online help for MASTER_POS_WAIT does not describe the timeout.

How to repeat:
The main manual has another paragraph explaining the timeout, which is not included in the online help.  It would be very helpful to have it there.

mysql> help master_pos_wait
Name: 'MASTER_POS_WAIT'
Description:
Syntax:
MASTER_POS_WAIT(log_name,log_pos[,timeout])

This function is useful for control of master/slave synchronization. It
blocks until the slave has read and applied all updates up to the
specified position in the master log. The return value is the number of
log events the slave had to wait for to advance to the specified
position. The function returns NULL if the slave SQL thread is not
started, the slave's master information is not initialized, the
arguments are incorrect, or an error occurs. It returns -1 if the
timeout has been exceeded. If the slave SQL thread stops while
MASTER_POS_WAIT() is waiting, the function returns NULL. If the slave
is past the specified position, the function returns immediately.
[26 Feb 2007 9:52] Sveta Smirnova 
Thank you for the report.

Verified as described.
[27 Feb 2007 8:11] MC Brown 
I've added the second paragraph on the timeouts into the help display.