10.1.2 注册 MySQL Shell 报告

要使用 MySQL Shell 注册用户定义的报告，请 shell.registerReport()在 JavaScript 或 shell.register_report()Python 中调用该方法。该方法的语法如下：

shell.registerReport(name, type, report[, description])
在哪里：

name是给出报告的唯一名称的字符串。

type是一个字符串，给出报告类型，决定输出格式， “ list ”、“ report ”或 “ print ”。

report是调用报表时要调用的函数。

description是一个带有选项的字典，您可以使用它来指定报告支持的选项、报告接受的其他参数以及 MySQL Shell 帮助系统中提供的帮助信息。

、、 和 参数都是必需的name。报告名称必须符合以下要求： typereport

它在您的 MySQL Shell 安装中必须是唯一的。

它必须是有效的脚本标识符，因此第一个字符必须是字母或下划线字符，后跟任意数量的字母、数字或下划线字符。

它可以是混合大小写，但转换为小写后，它在 MySQL Shell 安装中仍然必须是唯一的。

\show在注册过程中以及使用和命令 运行报告时，报告名称不区分大小写 \watch。在对象上调用相应的 API 函数时，报告名称区分大小写shell.reports。在那里，无论您处于 Python 还是 JavaScript 模式，您都必须使用用于注册报告的确切名称来调用该函数。

可选字典包含以下键，这些键都是可选的：

brief
报告的简要说明。

details
报告的详细描述，以字符串数组形式提供。当您使用该 \help命令或 --help该命令的选项 时，会提供此信息\show。

options
报告可以接受的任何特定于报告的选项。数组中的每个字典都描述一个选项，并且必须包含以下键：

name（字符串，必需）：长格式的选项名称，必须是有效的脚本标识符。

brief（字符串，可选）：选项的简短描述。

shortcut（字符串，可选）：选项的备用名称，作为单个字母数字字符。

details（字符串数组，可选）：选项的详细描述。当您使用该\help命令或 --help该命令的选项 时，会提供此信息\show。

type（字符串，可选）：选项的值类型。允许的值为 “ string ”、“ bool ”、 “ integer ”和“ float ” ，如果 未指定，则默认为“ string ” 。type如果 指定了“ bool ”，则该选项充当开关：如果未指定，则默认为，当您使用or命令运行报告时 false默认为（并且不接受任何值） ，并且在运行报告时必须具有有效值使用该 对象。 true\show\watchshell.reports

required（bool，可选）：该选项是否是必需的。如果required 未指定，则默认为 false. 如果选项类型为 “ bool ”，则required 不能为 true。

values（字符串数组，可选）：选项允许值的列表。只有类型为“ string ”的选项才能有这个键。如果 values未指定，则该选项接受任何值。

argc
一个字符串，指定报告所需的附加参数的数量，可以是以下之一：

参数的确切数量，指定为单个数字。

零个或多个参数，指定为星号。

参数数字范围，指定为用短划线分隔的两个数字（例如 “ 1-5 ”）。

具有最小值但没有最大值的参数数字范围，指定为由破折号分隔的数字和星号（例如，“ 1-* ”）。