MySQL Shell 9.0  /  扩展 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 报告” 所述。