MySQL Shell插件

Wesley13
• 阅读 599

作者:Rene Ramirez 译:徐轶韬

本文转载自“MySQL解决方案工程师”公众号

MySQL Shell 8.0.17引入了一种通过插件来扩展基本功能的新方法,插件使用JavaScript或Python脚本,允许用户:

  • 通过 show和 watch shell命令注册一个可用于监视任务的报告。

  • 使用自定义功能创建和注册新的全局对象。

插件的构成

插件是一个包含插件注册文件的文件夹,它将在shell启动时执行。

插件注册文件是一个名为_init.js_的JavaScript文件和名为_init.py_的Python文件(在本篇博客文章的其余部分将其称为 _init_文件)。

shell启动时会自动加载插件,因此,插件文件夹必须位于用户配置的_plugins_路径文件夹中:

  • Windows:%appdata%/ MySQL / mysqlsh / plugins

  • 其他:〜/ .mysqlsh / plugins

当s_hell_启动时,它将遍历_plugins_目录的内容, 标识包含_init_文件的所有文件夹。_init_文件是将要加载的插件。通过在相应的语言上下文中执行init文件来加载它们。

使用插件扩展shell

shell全局对象包含以下函数,可以通过注册用户定义的报告或扩展对象来实现shell功能扩展:

  • _shell.registerReport(name,type,report [,description])_:注册用户定义的报告。

  • _shell.createExtensionObject()_:创建一个扩展对象(之后可以注册为全局对象)。

  • _shell.addExtensionObjectMember(object,name,member [,definition])_:将新成员添加到扩展对象中。

  • _shell.registerGlobal(name,object [,definition])_:将扩展对象注册为shell全局对象。

在执行init文件时,一部分shell全局对象是开箱即用的,也就是说,它们可以立即在init文件上使用。

这些对象包括:

  • shell 对象。

  • dba 对象。

  • mysql 模块。

  • mysqlx 模块。

使用上面列出的_shell_对象的函数,_init_文件可以扩展shell功能。

使用shell插件添加报告

8.0.16开始提供报告功能。在本节中,我们将创建一个简单的报告来监控InnoDB集群的状态。

_.mysqlsh/plugins/monitor/_init.js文件包含以下内容:

一个后端函数,它将返回与指定会话关联的集群对象:

MySQL Shell插件

JavaScript中自带的后端报告函数,在集群成员建立全局会话时,创建集群状态报告:

MySQL Shell插件

将上述函数注册成为报告,使其可以与

show 和   watch shell命令一起使用:

MySQL Shell插件

启动Shell后,将加载插件并使用 _show_和

_watch_命令执行新的 status 报告 :

使用shell插件添加新的全局对象

通过shell扩展对象,可以轻松扩展shell的基本功能。通常,扩展shell的过程包括:

  • 创建扩展对象。

  • 向扩展对象添加函数。

  • 注册扩展对象。

在使用InnoDB集群时,集群对象已经提供了很多特性,这些特性的例子包括describe()和satus()函数。假设我们想添加一个特定的用例,并且需要一个函数来检索InnoDB集群成员的列表。

让我们定义一个名为idc的新对象,它将与全局会话关联的InnoDB集群一起工作,并具有一个函数getMembers,该函数将返回集群成员列表,而不提供任何附加信息。

让我们添加代码来更新现有的插件。

这是后端函数,它将提供我们想要的功能。

MySQL Shell插件

现在我们创建扩展对象,将函数添加到其中,并将其注册为全局对象:

MySQL Shell插件

当shell启动时,加载插件,与此同时新的idc全局对象将变成可用:

集成帮助功能
shell扩展的主要方面是允许用户将额外的功能集成到shell中,与此同时,提供关于它的文档也非常重要的。新功能的三个函数提供以下选项以定义帮助信息:
brief:简短描述正在注册的报告/对象/函数。
details:它是一个字符串列表,包含关于正在注册的报告/函数/对象的详细信息。这个列表里的每个字符串,在显示的帮助信息时都是一个单独的段落。

请持续关注!
有关此主题的其他博客文章将会持续发表,包括:
MySQL Shell 插件-数据验证:当将函数注册到扩展对象中时,它将指导您通过不同的数据验证选项。
MySQL Shell 插件-插件组:它解释了如何组织你的插件,使他们包含在一个单一的全局对象里面。
一种Python方法:它解释了如何将Python模块与MySQL Shell插件组合起来创建复杂的插件。

资源
有关MySQL Shell插件的详细信息,请参阅MySQL Shell用户指南。
不要忘记下载并尝试一下,欢迎您的反馈!
您可以通过https://mysqlcommunity.slack.com/的#shell频道与我们联系


由叶老师主讲的知数堂「MySQL优化课」第17期已发车,课程从第15期就升级成MySQL 8.0版本了,现在上车刚刚好,扫码开启MySQL 8.0的修行之旅吧。

MySQL Shell插件


另外,叶老师在腾讯课堂《MySQL性能优化》精编版第一期已完结,本课程讲解读几个MySQL性能优化的核心要素:合理利用索引,降低锁影响,提高事务并发度

下面是自动拼团的二维码,组团价仅需78元

MySQL Shell插件

本文分享自微信公众号 - 老叶茶馆(iMySQL_WX)。
如有侵权,请联系 support@oschina.cn 删除。
本文参与“OSC源创计划”,欢迎正在阅读的你也加入,一起分享。

点赞
收藏
评论区
推荐文章
blmius blmius
3年前
MySQL:[Err] 1292 - Incorrect datetime value: ‘0000-00-00 00:00:00‘ for column ‘CREATE_TIME‘ at row 1
文章目录问题用navicat导入数据时,报错:原因这是因为当前的MySQL不支持datetime为0的情况。解决修改sql\mode:sql\mode:SQLMode定义了MySQL应支持的SQL语法、数据校验等,这样可以更容易地在不同的环境中使用MySQL。全局s
皕杰报表之UUID
​在我们用皕杰报表工具设计填报报表时,如何在新增行里自动增加id呢?能新增整数排序id吗?目前可以在新增行里自动增加id,但只能用uuid函数增加UUID编码,不能新增整数排序id。uuid函数说明:获取一个UUID,可以在填报表中用来创建数据ID语法:uuid()或uuid(sep)参数说明:sep布尔值,生成的uuid中是否包含分隔符'',缺省为
Jacquelyn38 Jacquelyn38
3年前
2020年前端实用代码段,为你的工作保驾护航
有空的时候,自己总结了几个代码段,在开发中也经常使用,谢谢。1、使用解构获取json数据let jsonData  id: 1,status: "OK",data: 'a', 'b';let  id, status, data: number   jsonData;console.log(id, status, number )
Stella981 Stella981
3年前
KVM调整cpu和内存
一.修改kvm虚拟机的配置1、virsheditcentos7找到“memory”和“vcpu”标签,将<namecentos7</name<uuid2220a6d1a36a4fbb8523e078b3dfe795</uuid
Easter79 Easter79
3年前
Twitter的分布式自增ID算法snowflake (Java版)
概述分布式系统中,有一些需要使用全局唯一ID的场景,这种时候为了防止ID冲突可以使用36位的UUID,但是UUID有一些缺点,首先他相对比较长,另外UUID一般是无序的。有些时候我们希望能使用一种简单一些的ID,并且希望ID能够按照时间有序生成。而twitter的snowflake解决了这种需求,最初Twitter把存储系统从MySQL迁移
Wesley13 Wesley13
3年前
mysql设置时区
mysql设置时区mysql\_query("SETtime\_zone'8:00'")ordie('时区设置失败,请联系管理员!');中国在东8区所以加8方法二:selectcount(user\_id)asdevice,CONVERT\_TZ(FROM\_UNIXTIME(reg\_time),'08:00','0
Wesley13 Wesley13
3年前
00:Java简单了解
浅谈Java之概述Java是SUN(StanfordUniversityNetwork),斯坦福大学网络公司)1995年推出的一门高级编程语言。Java是一种面向Internet的编程语言。随着Java技术在web方面的不断成熟,已经成为Web应用程序的首选开发语言。Java是简单易学,完全面向对象,安全可靠,与平台无关的编程语言。
Wesley13 Wesley13
3年前
MySQL部分从库上面因为大量的临时表tmp_table造成慢查询
背景描述Time:20190124T00:08:14.70572408:00User@Host:@Id:Schema:sentrymetaLast_errno:0Killed:0Query_time:0.315758Lock_
为什么mysql不推荐使用雪花ID作为主键
作者:毛辰飞背景在mysql中设计表的时候,mysql官方推荐不要使用uuid或者不连续不重复的雪花id(long形且唯一),而是推荐连续自增的主键id,官方的推荐是auto_increment,那么为什么不建议采用uuid,使用uuid究
Python进阶者 Python进阶者
10个月前
Excel中这日期老是出来00:00:00,怎么用Pandas把这个去除
大家好,我是皮皮。一、前言前几天在Python白银交流群【上海新年人】问了一个Pandas数据筛选的问题。问题如下:这日期老是出来00:00:00,怎么把这个去除。二、实现过程后来【论草莓如何成为冻干莓】给了一个思路和代码如下:pd.toexcel之前把这