10.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.
