11.2.1 Создание глобальных объектов MySQL Shell, определяемых пользователем
Для создания нового глобального объекта MySQL Shell, который будет служить точкой входа для ваших объектов расширения, сначала создайте новый объект расширения верхнего уровня, используя встроенную функцию shell.createExtensionObject() в JavaScript или shell.create_extension_object() в Python:
shell.createExtensionObject()
Затем зарегистрируйте этот объект расширения верхнего уровня в качестве глобального объекта MySQL Shell, вызвав метод shell.registerGlobal() в JavaScript или shell.register_global() в Python. Синтаксис метода следующий:
shell.registerGlobal(name, object[, definition])
Где:
-
name— строка, задающая имя (и класс) глобального объекта. Имя должно быть допустимым идентификатором скрипта, поэтому первый символ должен быть буквой или символом подчеркивания, за которым может следовать любое количество букв, цифр или символов подчеркивания. Имя должно быть уникальным в вашей установке MySQL Shell, поэтому оно не должно совпадать с именем встроенного глобального объекта MySQL Shell (например,db,dba,cluster,session,shell,util), и оно не должно совпадать с именем, которое вы уже использовали для глобального объекта MySQL Shell, определяемого пользователем. В примерах ниже показано, как проверить, существует ли имя, прежде чем регистрировать глобальный объект.ВажноИмя, которое вы используете для регистрации глобального объекта, используется без изменений при доступе к объекту как в JavaScript, так и в Python режимах. Поэтому рекомендуется использовать простое однословное имя для глобального объекта (например,
ext). Если вы зарегистрируете глобальный объект с сложным именем в стиле camel case или snake case (например,myCustomObject), при использовании глобального объекта вам необходимо указать имя в том виде, как оно было зарегистрировано. Только имена, используемые для членов, обрабатываются соответствующим языком. object— объект расширения, который вы регистрируете в качестве глобального объекта MySQL Shell. Вы можете зарегистрировать объект расширения только один раз.-
definition— необязательный словарь с информацией о справке для глобального объекта, предоставляемой системой справки MySQL Shell. Словарь содержит следующие ключи:brief(строка, необязательно): Краткое описание глобального объекта, которое будет предоставлено в качестве справки.details(список строк, необязательно): Подробное описание глобального объекта, которое будет предоставлено в качестве справки.
© 2025 Oracle
Licensed under the GPLv2 License.
