MySQL Shell 8.0  /  ...  /  Built-in MySQL Shell Reports

10.1.6 Built-in MySQL Shell Reports

MySQL Shell includes built-in reports to display the following information:

  • The results of any specified SQL query (query, available from MySQL Shell 8.0.16).

  • A listing of the current threads in the connected MySQL server (threads, available from MySQL Shell 8.0.18).

  • Detailed information about a specified thread (thread, available from MySQL Shell 8.0.18).

As with user-defined reports, the built-in 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. The built-in reports support the standard options for the \show and \watch commands in addition to their report-specific options, unless noted otherwise in their descriptions. They can also be accessed as API functions using the shell.reports object. Section 10.1.5, “Running MySQL Shell Reports” explains how to run reports in each of these ways.