10.1.1 Creating MySQL Shell Reports — MySQL Shell 8.4

10.1.1 Создание отчетов MySQL Shell

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

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

Подпись

Подпись для функции Python или JavaScript, которая должна быть зарегистрирована как отчет MySQL Shell, должна быть следующей:

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

Где:

session — это объект сеанса MySQL Shell, который используется для выполнения отчета.
argv — это необязательный список, содержащий строковые значения дополнительных аргументов, передаваемых в отчет.
options — это необязательный словарь с именами ключей и значениями, которые соответствуют любым параметрам отчета и их значениям.

Типы отчетов

Функция отчета должна возвращать данные в определенном формате, в зависимости от типа, используемого при его регистрации:

Тип списка: Возвращает вывод в виде списка списков, при этом первый список состоит из имен столбцов, а остальные — из содержимого строк. MySQL Shell отображает вывод по умолчанию в табличном формате или в вертикальном формате, если параметр --vertical или --E был указан в команде \show или \watch. Значения для строк преобразуются в строковые представления элементов. Если строка содержит меньше элементов, чем число имен столбцов, недостающие элементы считаются NULL. Если строка содержит больше элементов, чем число имен столбцов, дополнительные элементы игнорируются. При регистрации этого отчета используйте тип «“list”».

Тип отчета: Возвращает вывод произвольной формы в виде списка, содержащего один элемент. MySQL Shell отображает этот вывод с использованием YAML. При регистрации этого отчета используйте тип «“report”».
Тип печати: Печатает вывод непосредственно на экран и возвращает пустой список в MySQL Shell, чтобы показать, что вывод уже отображен. При регистрации этого отчета используйте тип «“print”».

Для предоставления вывода функция API отчета должна возвращать словарь с ключом report и списком JSON-объектов, по одному для каждого элемента в возвращаемом списке. Для типа списка используйте по одному элементу для каждого списка, для типа отчета используйте один элемент, а для типа печати не используйте элементов.