Bug #71489 command help doesn't list parameter description

• Submitted: 27 Jan 2014 9:28
• Modified: 30 Sep 2015 4:32
• Reporter: Jan Kneschke
• Status: Closed
• Category: MySQL Fabric
• Severity: S3 (Non-critical)
• Version: 1.4.1
• OS: Any
• CPU Architecture: Any

[27 Jan 2014 9:28] Jan Kneschke

Description:
Getting help as described in:

http://dev.mysql.com/doc/mysql-utilities/1.4/en/fabric-util-help-commands.html

gives a one line description of each command, but it doesn't explain what the different parameters mean or expect.

How to repeat:
$ ./mysqlfabric help group lookup_servers
group lookup_servers(group_id, uuid, status, mode): Return information on existing server(s) in a group.

Suggested fix:
* what information is returned? provide an example.
* what is expected as input for the parameters? Types, value, ranges
* what possible errors can be returned?

In the above case of group.lookup_servers:

Parameters:
* group_id (string): name of the group to inspect
* uuid (string, uuid, optional): uuid of a server in the group
* status (enum ["FAULTY", "SPARE", "SECONDARY", "PRIMARY"], optional): status of the server in the group
* mode (enum ["OFFLINE", "READ_ONLY", "WRITE_ONLY", "READ_WRITE"], optional): mode of the server in the group

$ mysqlfabric group lookup_servers <group-id>

returns servers of the named group

$ mysqlfabric group lookup_servers <group-id> <server-uuid>

returns server-info of the server in the group.

[27 Jan 2014 12:03] MySQL Verification Team

Hello Jan,

Thank you for the bug report.
Verified as described.

// 1.4.1
D:\ushastry\MySQL Utilities>mysqlfabric help group lookup_servers
group lookup_servers(group_id, uuid, status, mode): Return information on existing server(s) in a group.

Thanks,
Umesh

[30 Sep 2015 4:32] Philip Olson

Posted by developer:
 
Fixed as of the upcoming MySQL Fabric 1.6.2 release, and here's the changelog entry:

The mysqlfabric help contents and formatting was improved.

And related to this, the online Fabric documentation is also being improved.

Also, this bug's changelog entry was merged with the related MySQL Bug #71807

Thank you for the bug report.