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

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

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

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