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.
operations to generate the desired output. You register the function
as a MySQL Shell report through 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”).
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
Section 6.1.5, “Running MySQL Shell Reports” explains how to run
reports in each of these ways.
MySQL Shell includes a number of built-in reports, described in Section 6.1.6, “Built-in MySQL Shell Reports”.