Documentation Home
MySQL Shell 8.0
Related Documentation Download this Manual
PDF (US Ltr) - 462.9Kb
PDF (A4) - 459.8Kb
HTML Download (TGZ) - 92.4Kb
HTML Download (Zip) - 103.9Kb

MySQL Shell 8.0  /  Extending MySQL Shell  /  Reporting with MySQL Shell

6.1 Reporting with MySQL Shell

MySQL Shell enables you to set up and run reports to display live information from a MySQL server, such as status and performance information. MySQL Shell's reporting facility supports both built-in reports and user-defined reports. The reporting facility is available from MySQL Shell 8.0.16. Reports can be created directly at the MySQL Shell interactive prompt, or defined in scripts that are automatically loaded when MySQL Shell starts.

A report is a plain JavaScript or Python function that performs operations to generate the desired output. You register the function as a MySQL Shell report through the shell.registerReport() method in JavaScript or the shell.register_report() method in Python. Section 6.1.1, “Creating MySQL Shell Reports” has instructions to create, register, and store your reports. You can store your report as part of a MySQL Shell plugin (see Section 6.3, “MySQL Shell Plugins”).

Reports written in any of the supported languages (JavaScript, Python, or SQL) can be run regardless of the active MySQL Shell language. Reports can be run once using the MySQL Shell \show command, or run and then refreshed continuously in a MySQL Shell session using the \watch command. They can also be accessed as API functions using the shell.reports object. Section 6.1.5, “Running MySQL Shell Reports” explains how to run reports in each of these ways.

In MySQL Shell 8.0.16, the following built-in report is available:


Executes the single SQL statement that is provided as an argument. This report has no report-specific options, but the standard options for the \show and \watch commands may be used. For examples, see Section 6.1.5, “Running MySQL Shell Reports”.