要使用 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和参数都是必需的type。
report报告名称必须满足以下要求：
它在您的 MySQL Shell 安装中必须是唯一的。
它必须是有效的脚本标识符，因此第一个字符必须是字母或下划线字符，后跟任意数量的字母、数字或下划线字符。
它可以是大小写混合的，但是当转换为小写时，它在你的 MySQL Shell 安装中仍然必须是唯一的。
\show在注册过程中以及使用和\watch命令
运行报告时，报告名称不区分大小写
。在对象调用相应的 API 函数时，报告名称区分大小写shell.reports。在那里，您必须使用用于注册报表的确切名称调用该函数，无论您是在 Python 还是 JavaScript 模式下。
可选字典包含以下键，它们都是可选的：
-
brief 报告的简要说明。
-
details 报告的详细描述，以字符串数组的形式提供。这是在您使用
\help命令或命令的--help选项时提供的\show。-
options -
报告可以接受的任何特定于报告的选项。数组中的每个字典描述一个选项，并且必须包含以下键：
name(string, required): 长格式的选项名称，必须是有效的脚本标识符。brief（字符串，可选）：选项的简要说明。shortcut（字符串，可选）：作为单个字母数字字符的选项的备用名称。details（字符串数组，可选）：选项的详细描述。这是在您使用\help命令或命令的--help选项时提供的\show。type（字符串，可选）：选项的值类型。允许的值为 “ string ”、“ bool ”、 “ integer ”和“ float ” ，如果 未指定则默认为“ string ” 。type如果 指定了“ bool ”，则该选项充当开关：false如果未指定，则默认为true（并且不接受任何值）当您使用\show或命令，并且在您使用该 对象\watch运行报告时必须具有有效值。shell.reportsrequired(bool, optional)：该选项是否是必需的。如果required未指定，则默认为false. 如果选项类型是 “ bool ”则required不能为真。values（字符串数组，可选）：选项的允许值列表。只有类型为“ string ”的选项可以有这个键。如果values未指定，则该选项接受任何值。
-
argc -
一个字符串，指定报告期望的附加参数的数量，可以是以下之一：
参数的确切数量，指定为单个数字。
零个或多个参数，指定为星号。
参数编号的范围，指定为用破折号分隔的两个数字（例如， “ 1-5 ”）。
具有最小值但没有最大值的参数编号范围，指定为一个数字和一个由短划线分隔的星号（例如，“ 1-* ”）。