Bug #92443 Documentation for system Name should mention get_system_name()
Submitted: 16 Sep 2018 12:26 Modified: 9 Oct 2018 17:19
Reporter: Daniël van Eeden (OCA) Email Updates:
Status: Closed Impact on me:
None 
Category:MySQL Cluster: Documentation Severity:S3 (Non-critical)
Version:7.6 OS:Any
Assigned to: CPU Architecture:Any

[16 Sep 2018 12:26] Daniël van Eeden 
Description:
https://dev.mysql.com/doc/mysql-cluster-excerpt/5.7/en/mysql-cluster-system-definition.htm...

"Set a name for the cluster. This parameter is required for deployments with MySQL Enterprise Monitor; it is otherwise unused."

This is not completely true. As Ndb_cluster_connection::get_system_name() can be used to retrieve the name.

See also https://dev.mysql.com/doc/ndbapi/en/ndb-ndb-cluster-connection-get-system-name.html

How to repeat:
Compare docs and API

Suggested fix:
Mention Ndb_cluster_connection::get_system_name() in the docs for system-name.
[17 Sep 2018 4:36] MySQL Verification Team 
Hello Daniël,

Thank you for the report and feedback!

regards,
Umesh
[18 Sep 2018 12:04] Daniël van Eeden 
Please also consider mentioning the status var:
SHOW GLOBAL STATUS LIKE 'Ndb_system_name';
[9 Oct 2018 17:19] Jon Stephens 
Fixed in mysqldoc rev 59390-59391. Closed.
[9 Oct 2018 17:44] Jon Stephens 
Also added a note to the method description in the NDB API guide.