Chapter 10 Extending MySQL Shell

Table of Contents

10.1 Reporting with MySQL Shell

10.1.1 Creating MySQL Shell Reports

10.1.2 Registering MySQL Shell Reports

10.1.3 Persisting MySQL Shell Reports

10.1.4 Example MySQL Shell Report

10.1.5 Running MySQL Shell Reports

10.1.6 Built-in MySQL Shell Reports

10.2 Adding Extension Objects to MySQL Shell

10.2.1 Creating User-Defined MySQL Shell Global Objects

10.2.2 Creating Extension Objects

10.2.3 Persisting Extension Objects

10.2.4 Example MySQL Shell Extension Objects

10.3 MySQL Shell Plugins

10.3.1 Creating MySQL Shell Plugins

10.3.2 Creating Plugin Groups

10.3.3 Example MySQL Shell Plugins

10.4 Custom SQL Handler

10.4.1 Registering SQL Handler

10.4.2 Returning a Custom Result

10.4.3 Result Data Specification

You can define extensions to the base functionality of MySQL Shell in the form of reports and extension objects. Reports and extension objects can be created using JavaScript or Python, and can be used regardless of the active MySQL Shell language. You can persist reports and extension objects in plugins that are loaded automatically when MySQL Shell starts.

• MySQL Shell reports. See Section 10.1, “Reporting with MySQL Shell”.

• Extension objects. See Section 10.2, “Adding Extension Objects to MySQL Shell”.

• Reports and extension objects can be stored as MySQL Shell plugins. See Section 10.3, “MySQL Shell Plugins”.