MySQL Shell позволяет настроить и запустить отчеты для отображения текущей информации с сервера MySQL, такой как данные о состоянии и производительности. Модуль отчетов MySQL Shell поддерживает как встроенные отчеты, так и пользовательские. Отчеты можно создавать непосредственно в интерактивном режиме MySQL Shell или определять в скриптах, которые автоматически загружаются при запуске MySQL Shell.

Отчет — это обычная функция JavaScript или Python, которая выполняет операции для генерации желаемого результата. Вы регистрируете функцию как отчет MySQL Shell с помощью метода shell.registerReport() в JavaScript или метода shell.register_report() в Python. Раздел 11.1.1, «Создание отчетов MySQL Shell» содержит инструкции по созданию, регистрации и сохранению ваших отчетов. Вы можете сохранить отчет как часть плагина MySQL Shell (см. Раздел 11.3, «Плагины MySQL Shell»).

Отчеты, написанные на любом из поддерживаемых языков (JavaScript, Python или SQL), могут выполняться независимо от активного языка MySQL Shell. Отчеты можно запустить один раз с помощью команды MySQL Shell \show или выполнять и обновлять непрерывно в сеансе MySQL Shell с помощью команды \watch. К ним также можно получить доступ как к функциям API с помощью объекта shell.reports. Раздел 11.1.5, «Запуск отчетов MySQL Shell» объясняет, как запускать отчеты каждым из этих способов.

MySQL Shell включает ряд встроенных отчетов, описанных в Раздел 11.1.6, «Встроенные отчеты MySQL Shell».