MySQL Shell API 8.4.1
Unified development interface for MySQL Products
|
Gives access to built-in and user-defined reports. More...
Methods | |
Dict | query (Session session, List argv) |
Executes the given SQL statement. More... | |
Dict | threads (Session session, List argv, Dict options) |
Lists threads that belong to the user who owns the session object. More... | |
Dict | thread (Session session, List argv, Dict options) |
Provides various information regarding the specified thread. More... | |
Gives access to built-in and user-defined reports.
The 'reports' object provides access to built-in reports. All user-defined reports registered using the shell.registerReport() method are also available here. The reports are provided as methods of this object, with names corresponding to the names of the available reports.
All methods have the same signature: Dict report(Session session, List argv, Dict options), where:
Each report returns a dictionary with the following keys:
For more information on a report use: shell.reports.help('report_name').
Dict query | ( | Session | session, |
List | argv | ||
) |
Executes the given SQL statement.
This is a 'list' type report.
session | Session object used to execute the given SQL statement. |
argv | List of strings constituting the SQL statement to be executed. |
Dict threads | ( | Session | session, |
List | argv, | ||
Dict | options | ||
) |
Lists threads that belong to the user who owns the session object.
This is a 'list' type report.
The 'options' dictionary may contain the following key-value pairs:
For more information on available columns, run: \show threads --help.
session | Session object. |
argv | Empty list. |
options | Configuration options of the report. |
Dict thread | ( | Session | session, |
List | argv, | ||
Dict | options | ||
) |
Provides various information regarding the specified thread.
By default lists information on the thread used by the session object.
The 'options' dictionary may contain the following key-value pairs:
session | Session object. |
argv | Empty list. |
options | Configuration options of the report. |