MySQL Bugs: #80002: Server-side help information for SHOW is missing SHOW RELAYLOG EVENTS

Bug #80002	Server-side help information for SHOW is missing SHOW RELAYLOG EVENTS
Submitted:	15 Jan 2016 10:52	Modified:	4 Mar 2016 15:21
Reporter:	Ceri Williams	Email Updates:
Status:	Closed	Impact on me:	None
Category:	MySQL Server: Documentation	Severity:	S3 (Non-critical)
Version:	any	OS:	Any
Assigned to:	Paul DuBois	CPU Architecture:	Any
Tags:	Help

Description:
The reference to "show relaylog events" is missing from the description of the mysql.help_topic entry for "show" (help show); the information does exist for: "help show relaylog events"

How to repeat:
The following is for 5.7, but the same applies to 5.5 and 5.6.

mysql [localhost] {msandbox} (mysql) > select help_topic_id, name, description like '%SHOW RELAYLOG EVENTS%' as matched from help_topic where name = 'SHOW'\G
*************************** 1. row ***************************
help_topic_id: 522
         name: SHOW
      matched: 0
1 row in set (0.00 sec)

Suggested fix:
Update scripts/fill_help_tables.sql

Hello Ceri Williams,

Thank you for the report.
Please try this-

-- using help <>

mysql> help SHOW RELAYLOG EVENTS
Name: 'SHOW RELAYLOG EVENTS'
Description:
Syntax:
SHOW RELAYLOG EVENTS
   [IN 'log_name'] [FROM pos] [LIMIT [offset,] row_count]

Shows the events in the relay log of a replication slave. If you do not
specify 'log_name', the first relay log is displayed. This statement
has no effect on the master.

URL: http://dev.mysql.com/doc/refman/5.7/en/show-relaylog-events.html

mysql>

-- querying help_topic 

mysql> select * from help_topic where name LIKE 'SHOW RELAY%'\G
*************************** 1. row ***************************
   help_topic_id: 257
            name: SHOW RELAYLOG EVENTS
help_category_id: 27
     description: Syntax:
SHOW RELAYLOG EVENTS
   [IN 'log_name'] [FROM pos] [LIMIT [offset,] row_count]

Shows the events in the relay log of a replication slave. If you do not
specify 'log_name', the first relay log is displayed. This statement
has no effect on the master.

URL: http://dev.mysql.com/doc/refman/5.7/en/show-relaylog-events.html

         example:
             url: http://dev.mysql.com/doc/refman/5.7/en/show-relaylog-events.html
1 row in set (0.00 sec)

Thanks,
Umesh

Thanks for the reply. 

mysql> help show

^ This does not show SHOW RELAYLOG EVENTS
It does show SHOW BINLOG EVENTS

The description field for the help_topic for SHOW does not contain the reference to SHOW RELAYLOG EVENTS

Thank you for the feedback.

*RELAYLOG EVENTS info is missing

mysql> help SHOW
Name: 'SHOW'
Description:
SHOW has many forms that provide information about databases, tables,
columns, or status information about the server. This section describes
those following:

SHOW {BINARY | MASTER} LOGS
SHOW BINLOG EVENTS [IN 'log_name'] [FROM pos] [LIMIT [offset,] row_count]
SHOW CHARACTER SET [like_or_where]
SHOW COLLATION [like_or_where]
SHOW [FULL] COLUMNS FROM tbl_name [FROM db_name] [like_or_where]
SHOW CREATE DATABASE db_name
SHOW CREATE EVENT event_name
SHOW CREATE FUNCTION func_name
SHOW CREATE PROCEDURE proc_name
SHOW CREATE TABLE tbl_name
SHOW CREATE TRIGGER trigger_name
SHOW CREATE VIEW view_name
SHOW DATABASES [like_or_where]
SHOW ENGINE engine_name {STATUS | MUTEX}
SHOW [STORAGE] ENGINES
SHOW ERRORS [LIMIT [offset,] row_count]
SHOW EVENTS
SHOW FUNCTION CODE func_name
SHOW FUNCTION STATUS [like_or_where]
SHOW GRANTS FOR user
SHOW INDEX FROM tbl_name [FROM db_name]
SHOW MASTER STATUS
SHOW OPEN TABLES [FROM db_name] [like_or_where]
SHOW PLUGINS
SHOW PROCEDURE CODE proc_name
SHOW PROCEDURE STATUS [like_or_where]
SHOW PRIVILEGES
SHOW [FULL] PROCESSLIST
SHOW PROFILE [types] [FOR QUERY n] [OFFSET n] [LIMIT n]
SHOW PROFILES
SHOW SLAVE HOSTS
SHOW SLAVE STATUS [NONBLOCKING]
SHOW [GLOBAL | SESSION] STATUS [like_or_where]
SHOW TABLE STATUS [FROM db_name] [like_or_where]
SHOW [FULL] TABLES [FROM db_name] [like_or_where]
SHOW TRIGGERS [FROM db_name] [like_or_where]
SHOW [GLOBAL | SESSION] VARIABLES [like_or_where]
SHOW WARNINGS [LIMIT [offset,] row_count]

like_or_where:
    LIKE 'pattern'
  | WHERE expr

If the syntax for a given SHOW statement includes a LIKE 'pattern'
part, 'pattern' is a string that can contain the SQL "%" and "_"
wildcard characters. The pattern is useful for restricting statement
output to matching values.

Several SHOW statements also accept a WHERE clause that provides more
flexibility in specifying which rows to display. See
http://dev.mysql.com/doc/refman/5.7/en/extended-show.html.

URL: http://dev.mysql.com/doc/refman/5.7/en/show.html

Thank you for your bug report. This issue has been addressed in the documentation. The updated documentation will appear on our website shortly.

This problem occurred because the section in the manual for the SHOW statement did not list SHOW RELAYLOG EVENTS as one of the SHOW variants. That's been corrected, so the help table file will have the change as well.