Вы получаете доступ к интеграции командной строки, запустив приложение mysqlsh и передав специальный параметр --. Когда вы запускаете MySQL Shell таким образом, -- указывает конец списка параметров (например, сервера для подключения, языка и т. д.), и всё после него передаётся в интеграцию командной строки. Интеграция командной строки поддерживает определённый синтаксис, основанный на объектах и методах, используемых в интерактивном интерфейсе MySQL Shell. Для выполнения операции с помощью синтаксиса интеграции командной строки введите в вашей оболочке:

mysqlsh [options] -- [shell_object]+ object_method [arguments]

Элементы синтаксиса:

shell_object должен соответствовать одному из доступных глобальных объектов, а любые вложенные объекты должны быть дочерними объектами предыдущего объекта в списке. object_method должен соответствовать одному из методов последнего объекта в списке и должен быть определён в одном из допустимых форматов (JavaScript, Python или дружественный командной строке). Если они не соответствуют допустимому объекту и его методам, MySQL Shell завершается со статусом 10.

См. примеры в примерах интеграции командной строки MySQL Shell.

Чтобы узнать, какие объекты и методы доступны в интеграции командной строки, лучше всего запросить у используемого вами MySQL Shell. Это связано с тем, что помимо стандартных объектов, поставляемых с MySQL Shell, могут быть доступны дополнительные объекты из плагинов.

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

$ mysqlsh -- --help

Это отобразит список объектов и краткое описание того, что предоставляет каждый объект.

Чтобы получить список функций, доступных в интеграции командной строки для object:

$ mysqlsh -- object --help

Дополнительную информацию см. в разделе 5.8.2.4 «Справка по командной строке».

Список arguments необязателен, и все аргументы должны соответствовать синтаксису, подходящему для использования в командной строке, как описано в этом разделе. Специальные символы (например, пробелы или \) и кавычки обрабатываются оболочкой вашей системы (например, bash, cmd) до того, как они будут переданы MySQL Shell. Если вы не знакомы с тем, как ваша оболочка системы обрабатывает эти последовательности символов при анализе команды, вам следует избегать их. Например, чтобы передать параметр с кавычками, такими как “список, имён”, использование только этого синтаксиса в командной строке недостаточно. Вам нужно использовать синтаксис вашей оболочки системы для экранирования этих кавычек. Если вы этого не сделаете, MySQL Shell может не получить фактические кавычки. См. раздел 5.8.2.2 «Определение аргументов».

Существует два типа аргументов, которые могут использоваться в списке аргументов: безымянные аргументы и именованные аргументы. Безымянные аргументы используются для определения параметров простых типов, таких как строки, числа, булевы значения, null. Именованные аргументы используются для определения значений для параметров списка и опций в параметре словаря, они являются парами ключ-значение, где значения являются простыми типами. Их использование должно соответствовать следующему шаблону:

[positional_argument | named_argument]*

Все части синтаксиса являются необязательными и могут быть заданы в любом порядке. Эти аргументы затем преобразуются в аргументы, передаваемые в вызов метода, в следующем порядке:

Использование интеграции командной строки позволяет вызывать функции API MySQL Shell проще и удобнее, чем с помощью параметра --execute. Следующие примеры демонстрируют, как использовать эту функциональность: