Глава 1 Функции MySQL Shell

MySQL Shell обрабатывает код, написанный на JavaScript, Python и SQL. Любой выполняемый код обрабатывается как один из этих языков, в зависимости от языка, который в настоящее время активен. Также есть специфические команды MySQL Shell, начинающиеся с \, которые позволяют настроить MySQL Shell независимо от текущего выбранного языка. Более подробная информация представлена в разделе 3.1 «Команды MySQL Shell».

MySQL Shell использует Python 3, а не Python 2.7. Для платформ, включающих поддерживаемую установку Python 3, MySQL Shell использует последнюю доступную версию с минимальной поддерживаемой версией Python 3.6. Для платформ, где Python 3 не включён или не соответствует минимальной поддерживаемой версии, MySQL Shell поддерживает обратную совместимость с Python 2.6 и Python 2.7, поэтому, если вам требуется одна из этих более старых версий, вы можете собрать MySQL Shell из исходного кода с использованием соответствующей версии Python.

MySQL Shell включает Python 3.10.8 для платформ, где Python 3 не включён или не соответствует минимальной поддерживаемой версии.

MySQL Shell предоставляет режим интерактивного выполнения кода, где вы вводите код в командной строке MySQL Shell, и каждое введённое утверждение обрабатывается, а результат обработки выводится на экран. Поддерживается ввод текста Unicode, если используемый терминал его поддерживает. Поддерживаются цветные терминалы.

Многострочный код может быть написан с использованием команды, что позволяет MySQL Shell кэшировать несколько строк и затем выполнить их как одно утверждение. Дополнительная информация представлена в разделе «Поддержка многострочного ввода».

Помимо интерактивного выполнения кода, MySQL Shell также может брать код из различных источников и обрабатывать его. Этот метод обработки кода в неинтерактивном режиме называется пакетным выполнением.

Поскольку пакетный режим предназначен для обработки скриптов одного языка, он ограничен минимальным количеством неформатированного вывода и отключением выполнения команд. Чтобы избежать этих ограничений, используйте опцию командной строки --interactive, которая указывает MySQL Shell выполнить ввод как интерактивную сессию. В этом режиме ввод обрабатывается строка за строкой, точно так же, как каждая строка вводилась в интерактивной сессии. Дополнительная информация приведена в разделе 5.6 «Выполнение кода в пакетном режиме».

MySQL Shell включает следующие API, реализованные на JavaScript и Python, которые можно использовать для разработки кода, взаимодействующего с MySQL.

MySQL Shell разработан для предоставления интегрированного клиентского приложения командной строки для всех продуктов MySQL, которые поддерживают протокол X. Разработческие функции MySQL Shell предназначены для сессий с использованием протокола X. MySQL Shell также может подключаться к серверам MySQL, которые не поддерживают протокол X, используя классический протокол MySQL. Минимальный набор функций X DevAPI доступен для сессий, созданных с использованием классического протокола MySQL.

Вы можете определить расширения базовой функциональности MySQL Shell в виде отчетов и объектов расширения. Отчеты и объекты расширения могут быть созданы с использованием JavaScript или Python и могут использоваться независимо от активного языка MySQL Shell. Вы можете сохранить отчеты и объекты расширения в плагинах, которые загружаются автоматически при запуске MySQL Shell. MySQL Shell имеет несколько встроенных отчетов, готовых к использованию. Более подробная информация представлена в главе 10 «Расширение MySQL Shell».

MySQL Shell включает следующие утилиты для работы с MySQL:

Дополнительная информация представлена в главе 11 «Утилиты MySQL Shell».

MySQL Shell предоставляет большую часть своей функциональности с помощью синтаксиса команд API, что позволяет легко интегрировать mysqlsh с другими инструментами. Например, вы можете создать скрипты bash, которые администрируют InnoDB Cluster с помощью этой функциональности. Используйте синтаксис mysqlsh [options] -- shell_object object_method [method_arguments] для непосредственной передачи операций в глобальные объекты MySQL Shell, минуя интерфейс REPL. Более подробная информация в разделе 5.8 «Интеграция API с командной строкой».

MySQL Shell может возвращать результаты в табличном, табулированном, вертикальном формате или в формате JSON. Для интеграции MySQL Shell с внешними инструментами можно активировать обертывание JSON для всего вывода при запуске MySQL Shell из командной строки. Дополнительную информацию см. в разделе 5.7, «Форматы вывода».

MySQL Shell может регистрировать информацию о процессе выполнения на выбранном вами уровне детализации. Информация о регистрации может отправляться в любой комбинации файла журнала приложения, дополнительного отображаемого места назначения и консоли. Дополнительную информацию см. в главе 12, Ведение журнала и отладка MySQL Shell.

В MySQL Shell соединения с экземплярами MySQL Server обрабатываются объектом сессии. При первом подключении к экземпляру MySQL Server, которое может быть выполнено при запуске MySQL Shell или позднее, создается глобальный объект MySQL Shell, называемый session, для представления этого соединения. Эта сессия известна как глобальная сессия, потому что она может использоваться во всех режимах выполнения MySQL Shell. В режиме SQL глобальная сессия используется для выполнения операторов, а в режимах JavaScript и Python она доступна через объект, называемый session. Вы можете создавать дополнительные объекты сессии, используя функции, доступные в модулях JavaScript и Python mysqlx и mysql, и вы можете назначить один из этих объектов сессии в качестве глобального объекта session, чтобы использовать его в любом режиме. Дополнительную информацию см. в разделе 4.2, «Сессии MySQL Shell».