要检索可用于 CLI 调用的全局对象列表，请使用以下语法

$ mysqlsh -- --help

在此示例中，-- 启动命令的命令行集成部分。在之后使用 --help 或 -h 选项单独列出此界面中可用的全局对象。

要从命令行集成访问对象帮助，请使用以下语法

$ mysqlsh -- object --help

其中 object 是您要获取帮助的对象，例如 dba 全局对象。此调用显示

要检索嵌套对象的帮助，请在 --help 参数之前提供整个对象列表。例如，要获取有关 shell.options 函数的帮助，请发出以下命令

$ mysqlsh -- shell options --help

要显示有关命令行集成的命令的帮助，请使用以下语法

$ mysqlsh -- object command --help

此调用显示有关 command 的详细信息，包括

对于嵌套对象中的命令，应该在命令之前提供整个对象列表，例如

$ mysqlsh shell options set-persist --help

对于期望特定数据类型的参数，参数将列出为

--name=type
Brief description of the parameter.

类型信息表示参数的预期数据类型，例如：str、int、uint、bool、list、float 或 dict。

例如，dump-schemas 参数的 consistent 键

$ mysqlsh -- util dump-schemas --help
...
--consistent=<bool>
Enable or disable consistent data dumps. Default: true.
...

对于支持不同数据类型的参数，参数将列出为

--name[:type]=value
Brief description of the parameter.

例如，util.importTable() 操作的 columns 键。

$ mysqlsh -- util import-table --help
...
--columns[:<type>]=<value>
Array of strings and/or integers (default: empty array) - This...
...