PDF (美式信紙) - 2.2Mb
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...
...