Чтобы получить список глобальных объектов, доступных для вызовов командной строки, используйте следующий синтаксис:

$ 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.

Например, ключ consistent параметра 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...
...