Skip to content
Plugins for MySQL Shell
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Type Name Latest commit message Commit time
Failed to load latest commit information.
audit remove some debut print Nov 13, 2019
collations Better layout of query Nov 1, 2019
innodb add fragemented and disk info Oct 22, 2019
maintenance closing the connections when doing shutdown Oct 21, 2019
proxysql add the SYS functions and view to monitor the cluster directly Oct 11, 2019
router check to import external modules Oct 12, 2019
schema add check from invalid dates in 8.0 : 0000-00-00 Oct 21, 2019
security add auth method overview Nov 5, 2019
.gitignore Adding collation plugins and first function nonUnique Oct 17, 2019
LICENSE add my plugins Sep 17, 2019 add my plugins Sep 17, 2019 add my plugins Sep 17, 2019 add my plugins Sep 17, 2019


A collection of MySQL Shell example plugins.

After installing this plugin collection into the .mysqlsh/plugins/ext folder it will register a new MySQL Shell global object called "ext" and load several plugin categories at MySQL Shell startup.

To get help about the individual plugins type \? ext.

MySQL JS> \? ext.schema
      schema - Schema management and utilities.


      A collection of schema management tools and related utilities that work
      on schemas

            Provides help about this object and it's members

      showProcedures([schema][, session])
            Lists all stored procedures.

MySQL JS> ext.schema.showProcedures()
| ROUTINE_SCHEMA | ROUTINE_NAME                        |
| sys            | extract_schema_from_file_name       |
| sys            | extract_table_from_file_name        |

MySQL JS> \py
Switching to Python mode...

MySQL PY> ext.schema.show_procedures()
| ROUTINE_SCHEMA | ROUTINE_NAME                        |
| sys            | extract_schema_from_file_name       |
| sys            | extract_table_from_file_name        |


To install this demo on your machine type the following commands after you have installed the MySQL Shell and the git command line tools.

This will clone the repository and copy the files to the right path in order to be automatically loaded on MySQL Shell startup.

Please note: This plugin collection needs to be installed into a folder called ext.

macOS / Linux

$ mkdir -p ~/.mysqlsh/plugins
$ git clone ~/.mysqlsh/plugins/ext


$ mkdir %AppData%MySQL\mysqlsh\plugins
$ git clone %AppData%MySQL\mysqlsh\plugins\ext

Extending the MySQL Shell

Please take a look at the demo/ file to learn how to extend the MySQL Shell with plugins.

You can’t perform that action at this time.