--help
使用(-h) CLI 参数
从命令行集成调用命令时,您可以访问 MySQL Shell 联机帮助
。在全局、对象和命令级别支持帮助。
内置帮助 CLI 参数不映射到任何 API 参数,并且在 CLI 中可用的所有对象和命令中都受支持。
命令和参数的描述取自目标 API 函数的现有文档。
要检索可用于 CLI 调用的全局对象列表,请使用以下语法:
$ mysqlsh -- --help
在此示例中,--
启动命令的命令行集成部分。之后单独使用
--help
or
-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
。
例如参数的consistent
key
dump-schemas
:
$ mysqlsh -- util dump-schemas --help
...
--consistent=<bool>
Enable or disable consistent data dumps. Default: true.
...
对于支持不同数据类型的参数,参数列为:
--name[:type]=value
Brief description of the parameter.
例如,操作的columns
关键
util.importTable()
。
$ mysqlsh -- util import-table --help
...
--columns[:<type>]=<value>
Array of strings and/or integers (default: empty array) - This...
...