Bug #101534 Small changes needed in Documentation

• Submitted: 10 Nov 2020 8:40
• Modified: 12 Nov 2020 14:04
• Reporter: pon suresh pandian soundara rajan
• Status: Closed
• Category: MySQL Server: Documentation
• Severity: S3 (Non-critical)
• Version: MySQL 8.0.22
• OS: Any (centos)
• CPU Architecture: x86

[10 Nov 2020 8:40] pon suresh pandian soundara rajan

Description:
Hi Team,

I am testing the mysql shell utilities I found one mistake in MySQL documentation.

Doc Link - https://dev.mysql.com/doc/mysql-shell/8.0/en/mysql-shell-utilities-dump-instance-schema.ht...

In MySQL documentation they mentioned dumpschemas in example : (shell-py> util.dump_schemas)

But actual name is (util.dumpSchemas) 
 
MySQL  localhost:3306 ssl  cart  JS > util.dump_schemas(["cart"], "/home/vagrant/production_backup",{dryRun: true,threads :3})
Invalid object member dump_schemas (AttributeError)

Then I try like this,It's working fine.

MySQL  localhost:3306 ssl  cart  JS > util.dump
dumpInstance()  dumpSchemas()   dumpTables()
 

MySQL  localhost:3306 ssl  cart  JS > util.dumpSchemas(["cart"], "/home/vagrant/production_backup",{dryRun: true,threads :3})
Acquiring global read lock
Global read lock acquired
All transactions have been started

Kindly make the necessary changes in Documentation .

Thanks,

Pon Suresh

How to repeat:
MySQL  localhost:3306 ssl  cart  JS > util.dump
dumpInstance()  dumpSchemas()   dumpTables()

Suggested fix:
Kindly update to (util.dumpSchemas) in documentation.

[10 Nov 2020 8:47] MySQL Verification Team

Hello pon suresh pandian,

Thank you for the report and feedback.

regards,
Umesh

[12 Nov 2020 14:04] Margaret Fisher

Posted by developer:
 
Thank you for the comment. The example that did not work is actually in Python mode (with shell-py as the prompt), where naming uses underscores. I see you tried it in Javascript mode. It was not clear from the topic that the example was in Python mode, as there was only the prompt to indicate it and that could be overlooked easily. So I have now added before each example what mode is used, in order to clarify. Thanks for helping us to improve the documentation.