Spec-Zone.ru › MySQL Workbench

C.3 Плагины и инструменты

Плагины — это специальные модули, доступные пользователю через графический интерфейс Workbench. Обычно они вызываются из главного меню или контекстного меню. Большая часть функциональности MySQL Workbench реализована с помощью плагинов; например, редакторы таблиц, представлений и процедур являются встроенными плагинами на C++, как и мастера обратного и прямого проектирования. Модуль администрирования в MySQL Workbench полностью реализован как плагин на Python.

Плагин может быть простой функцией, выполняющей некоторое действие над вводом и завершающей работу без дальнейшего взаимодействия с пользователем. Примеры включают автоматическую расстановку диаграммы или внесение массовых изменений в объекты. Для создания простого плагина функция должна находиться в модуле и быть объявлена как плагин с помощью декоратора plugin объекта ModuleInfo.

Плагины могут иметь неопределенный срок работы, например, если они управляются пользователем через графический интерфейс. Это относится к редакторам объектов и мастерам в MySQL Workbench. Хотя плагин типа мастера должен быть объявлен стандартным способом, для выполнения плагина нужно будет выполнить только точку входа в функции плагина, поскольку большая часть дополнительной функциональности будет вызвана в результате взаимодействия пользователя с графическим интерфейсом.

Примечание

Для перезагрузки плагина необходимо перезапустить MySQL Workbench.

Импортированные файлы плагинов (и их скомпилированные аналоги) хранятся здесь:

Таблица C.3 Расположение файлов пользовательских плагинов

Таблица C.3 Расположение файлов пользовательских плагинов
Операционная система Путь к файлу
Windows %AppData%\MySQL\Workbench\modules
macOS ~имя_пользователя/Library/Application Support/MySQL/Workbench/modules
Linux ~имя_пользователя/.mysql/workbench/modules

Объявление плагина с помощью данного синтаксиса:

@ModuleInfo.plugin(plugin_name, caption, [input], [groups], [pluginMenu])

Эти параметры определены следующим образом:

  • plugin_name: Уникальное имя плагина. Может содержать только буквенно-цифровые символы, точки и символы подчеркивания.

  • caption: Подпись для использования в меню для плагина.

  • input: Необязательный список входных аргументов.

  • groups: Необязательный список групп, к которым принадлежит плагин. Допустимые значения:

    • Overview/Utility: Меню Контекст в Обзоре модели.

    • Model/Utility: Меню для объектов диаграммы.

    • Menu/<category>: Меню Плагины в главном меню.

  • pluginMenu: Необязательное имя подменю в меню Плагины, где должен отображаться плагин. Например, Каталог, Объекты, Утилиты. Это эквивалентно добавлению Menu/<category> в список групп.

© 2025 Oracle
Licensed under the GPLv2 License.
https://docs.oracle.com/cd/E17952_01/workbench-en/wb-plugins.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API