MySQL 8.0外壳/.../ 创建用户定义的MySQL Shell全局对象

9.2.1创建自定义MySQL Shell全局对象

要创建一个新的MySQL Shell全局对象作为扩展对象的入口点,首先要使用内置的shell.createExtensionObject ()函数或shell.create_extension_object ()在Python中:

shell.createExtensionObject ()

然后将这个顶级扩展对象注册为MySQL Shell全局对象shell.registerGlobal ()方法,或shell.register_global ()在Python中。该方法的语法如下:

壳。registerGlobal(名称、对象(定义)

地点:

  • 的名字给出全局对象的名称(和类)的字符串。名称必须是有效的脚本标识符,因此第一个字符必须是字母或下划线字符,后面跟着任意数量的字母、数字或下划线字符。该名称在MySQL Shell安装中必须是唯一的,所以它不能是内置MySQL Shell全局对象的名称(例如,dbdba集群会话壳牌跑龙套),它不能是你已经在用户定义的MySQL Shell全局对象中使用过的名称。下面的示例展示了如何在注册全局对象之前检查名称是否已经存在。

    重要的

    当您以JavaScript和Python模式访问对象时,您用来注册全局对象的名称将按原样使用。因此,为全局对象使用简单的单字名称(例如,ext).如果用复杂名称注册全局对象(驼峰式或蛇式)(例如,myCustomObject),在使用全局对象时,必须指定注册时的名称。只有用于成员的名称才会以适合语言的方式处理。

  • 对象是要注册为MySQL Shell全局对象的扩展对象。您只能注册一个扩展对象一次。

  • 定义是一个可选字典,包含MySQL Shell帮助系统中提供的全局对象的帮助信息。字典包含以下键:

    • 短暂的(字符串,可选):作为帮助信息提供的全局对象的简短描述。

    • 细节(字符串列表,可选):作为帮助信息提供的全局对象的详细描述。