若要擷取可供 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...
...