MySQL Shell 8.4  /  扩展 MySQL Shell  /  使用 MySQL Shell 进行报告

10.1 使用 MySQL Shell 进行报告

MySQL Shell 允许您设置和运行报告以显示来自 MySQL 服务器的实时信息,例如状态和性能信息。MySQL Shell 的报告功能支持内置报告和用户定义报告。报告可以直接在 MySQL Shell 交互式提示符下创建,也可以在 MySQL Shell 启动时自动加载的脚本中定义。

报告是一个简单的 JavaScript 或 Python 函数,执行操作以生成所需的输出。您通过 JavaScript 中的 shell.registerReport() 方法或 Python 中的 shell.register_report() 方法将该函数注册为 MySQL Shell 报告。 第 10.1.1 节,“创建 MySQL Shell 报告” 提供了创建、注册和存储报告的说明。您可以将报告存储为 MySQL Shell 插件的一部分(参见 第 10.3 节,“MySQL Shell 插件”)。

无论 MySQL Shell 的活动语言是什么,都可以运行用任何支持语言(JavaScript、Python 或 SQL)编写的报告。可以使用 MySQL Shell \show 命令运行一次报告,或者使用 MySQL Shell 会话中的 \watch 命令运行报告并持续刷新。还可以通过 shell.reports 对象以 API 函数的方式访问它们。 第 10.1.5 节,“运行 MySQL Shell 报告” 说明了如何通过每种方式运行报告。

MySQL Shell 包含一些内置报告,这些报告在 第 10.1.6 节,“内置 MySQL Shell 报告” 中进行了描述。