Вы получаете доступ к интеграции командной строки, запустив приложение 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. Если вы не знаете, как оболочка вашей системы обрабатывает эти последовательности символов при разборе команды, вам следует избегать их. Например, для передачи параметра с кавычками как части параметра, например, “list, of, names”, одного синтаксиса в командной строке недостаточно. Вам нужно использовать синтаксис вашей оболочки для экранирования этих кавычек. В противном случае MySQL Shell может не получить фактические кавычки. См. раздел 5.8.2.2 «Определение аргументов».

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

[positional_argument | named_argument]*

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

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