Bug #101216 | Suggestions for improved documentation for 13.4.2.1 CHANGE MASTER TO command | ||
---|---|---|---|
Submitted: | 17 Oct 2020 9:18 | Modified: | 17 Feb 2022 19:44 |
Reporter: | Simon Mudd (OCA) | Email Updates: | |
Status: | Closed | Impact on me: | |
Category: | MySQL Server: Documentation | Severity: | S4 (Feature request) |
Version: | 8.0.21 | OS: | Any |
Assigned to: | CPU Architecture: | Any | |
Tags: | change_master_to, defaults, firsts_version, MASTER_CONNECT_RETRY, master_retry_count |
[17 Oct 2020 9:18]
Simon Mudd
[17 Oct 2020 9:19]
Simon Mudd
As asking for documentation to be improved changed to feature request. I am sure the current documentation is correct.
[17 Oct 2020 10:10]
Simon Mudd
Related to: https://bugs.mysql.com/bug.php?id=101217
[17 Oct 2020 11:36]
Simon Mudd
Related: https://bugs.mysql.com/bug.php?id=101218
[18 Oct 2020 5:54]
MySQL Verification Team
Hello Simon, Thank you for the documentation enhancement request. regards, Umesh
[17 Feb 2022 19:44]
Margaret Fisher
Posted by developer: Thanks very much for these suggestions! I started the work in parallel with the terminology changes, and have now completed it. I hope you find the restructured documentation easier to use. Specific responses to your points - 1. I put the defaults for the parameters into the descriptions themselves, and did the same with the table of value lengths. I feel this is clearest since users need this information when they go to enter the parameter, and will not necessarily know there is a separate table. I have also added the possible values from the syntax diagram to the parameter names in the text. 2. The options are now in alphabetical order with a description associated with each. 3. The examples are in a section at the end, and I have added an example showing GTID auto-positioning and the use of FOR CHANNEL, plus links to more complex procedures where the statement is used - failover, GTID implementation, multi-source replication setup, and skipping transactions. 4. Following the terminology change I doubt that the development team would be keen to introduce further aliases, but you can always submit a code enhancement request if this is important. I think now that the description of the option is easier to pick out, it should not take long to understand. 5. I have moved the channel material to a more prominent place and added what the default name is. There is a link to the concept documentation for channels and (in the examples) the setup documentation, plus an example with a channel name. 6. SOURCE_CONNECTION_AUTO_FAILOVER is really primarily intended as an underpinning for InnoDB ClusterSet. It is possible to set it up by hand, and we have documented this in the section linked from the parameter description. Its use is not required, and I don't think we need to cover the error cases here - we can assume that if users do set it up by hand they will read all the instructions rather than experimenting on the basis of this statement documentation. To help with that I've moved the reference to the full docs near the start of the option.