MySQL 外壳 8.0  / 第 10 章扩展 MySQL Shell  /  10.1 使用 MySQL Shell 报告

10.1 使用 MySQL Shell 报告

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

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

无论使用何种活动的 MySQL Shell 语言,都可以运行以任何受支持的语言(JavaScript、Python 或 SQL)编写的报告。报告可以使用 MySQL Shell \show命令运行一次,或者运行,然后使用该 \watch命令在 MySQL Shell 会话中连续刷新。它们也可以作为 API 函数使用shell.reports对象进行访问。 第 10.1.5 节,“运行 MySQL Shell 报告”解释了如何以每种方式运行报告。

MySQL Shell 包括许多内置报告,在 第 10.1.6 节,“内置 MySQL Shell 报告”中进行了描述。