PDF (美国标准尺寸) - 2.3Mb
PDF (A4 尺寸) - 2.3Mb
使用 --help
(-h) CLI 参数,您可以在从命令行集成调用命令时访问 MySQL Shell 联机帮助。帮助在全局、对象和命令级别都受支持。
注意
内置的帮助 CLI 参数不会映射到任何 API 参数,并且在 CLI 中可用的所有对象和命令中都受支持。
命令和参数的描述取自目标 API 函数的现有文档。
要检索 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...
...