Для использования команд \show и \watch должна быть доступна активная сессия MySQL.

Команда \show запускает указанный отчет, который может быть встроенным отчетом MySQL Shell или определенным пользователем отчетом, зарегистрированным в MySQL Shell. Вы можете указать любые параметры или дополнительные аргументы, которые поддерживает отчет. Например, следующая команда запускает встроенный отчет query, который принимает в качестве аргумента одно SQL-предложение:

\show query show session status

Имя отчета нечувствительно к регистру, а символы дефиса и подчеркивания рассматриваются как одинаковые.

Команда \show также предоставляет следующие стандартные параметры:

Стандартные параметры и параметры, специфичные для отчета, указываются перед аргументами. Например, следующая команда запускает встроенный отчет query и возвращает результаты в вертикальном формате:

\show query --vertical show session status

Команда \watch запускает отчет таким же образом, как и команда \show, но затем обновляет результаты с регулярными интервалами до тех пор, пока вы не отмените команду, используя Ctrl + C. Команда \watch имеет дополнительные стандартные параметры для управления поведением обновления, как показано ниже:

Например, следующая команда использует встроенный отчет query для отображения счетчиков инструкций и обновления результатов каждые 0,5 секунды:

\watch query --interval=0.5 show global status like 'Com%'

Кавычки интерпретируются обработчиком команды, а не непосредственно сервером, поэтому, если они используются в запросе, их необходимо экранировать, добавив перед ними обратный слэш (\).

Встроенные отчеты MySQL Shell и определенные пользователем отчеты, которые были зарегистрированы в MySQL Shell, также могут быть доступны как функции API в объекте shell.reports. Объект shell.reports доступен в режимах JavaScript и Python и использует имя отчета, предоставленное при регистрации, в качестве имени функции. Функция имеет следующий синтаксис:

Dict report(Session session, List argv, Dict options);

Где:

Возвращаемое значение — это словарь с ключом report и списком JSON-объектов, содержащих отчет. Для отчетов типа Список — элемент для каждого списка, для отчетов типа Отчет — один элемент, для отчетов типа Печать — нет элементов.

При использовании объекта shell.reports, если словарь параметров присутствует, список argv требуется даже если дополнительных аргументов нет. Используйте команду \help report_name для отображения справки по функции отчета и проверки необходимости аргументов или параметров в отчете.

Например, следующий код запускает определенный пользователем отчет с именем sessions, который показывает текущие сессии. Создается объект сессии MySQL Shell для выполнения отчета. Использование параметра, специфичного для отчета, для ограничения количества возвращаемых строк до 10. Дополнительных аргументов нет, поэтому список argv присутствует, но пуст.

report = shell.reports.sessions(shell.getSession(), [], {'limit':10});