编写 mysql 插件_如何编写MySQL Shell插件

MySQL Shell 现在不只是用来部署InnoDB cluster和 Replica set了，在8.0.17之后有了自定义扩展能力，DBA可以用javascript和python编写扩展了，把一些常用的SQL脚本封装成自己的工具箱，甚至可以围绕它构建DBA的DevOps作业平台。

为MySQL Shell添加扩展并不复杂，现有两种扩展方式，一种是report，这种主要用来做各种查询，可以使用内建的两个命令调用自定义的report，另一种是plugin，可以定义任意功能函数。\show 就是普通一次性输出，已经内建了好多常用指标，参见脑图。

\watch类似top方式，持续输出信息，写些简单的监控脚本方便多了。

自定义扩展

将自定义的js或py脚本放在~/.mysqlsh/plugin 和~/.mysqlsh/init.d目录下，建议是放在plugin目录下，目录可按功能类别命名，目录中必须有init.py 或init.js 文件用来初始化扩展，代码中可约定顶级目录名作为全局对象，二级目录作为成员对象。hongbin@MBP ~/.m/plugins> tree

.

└── ext

└── table

└── init.py

2 directories, 1 file

下面是一段示例代码# init.py

# -------

# 演示注册report和plugin两种方式

# 定义一个查询函数，获取没有主键或唯一索引表

def report_table_without_pk(session):

query = '''SELECT tables.table_schema , tables.table_name

FROM information_schema.tables

LEFT JOIN (

SELECT table_schema , table_name

FROM information_schema.statistics

GROUP BY table_schema, table_name, index_name HAVING

SU