Эта секция описывает команды, которые настраивают MySQL Shell из интерактивного редактора кода. Для получения информации об опциях mysqlsh см. Приложение A .
MySQL Shell обеспечивает команды, которые позволяют вам изменить
среду выполнения редактора кода, например настроить активный язык
программирования или связь с MySQL Server. В следующей таблице перечислены
команды, которые доступны независимо от в настоящее время выбранного языка.
Поскольку команды должны быть доступны независимо от
режима выполнения,
они начинаются с escape-символа \
.
Команда | Псевдоним | Описание |
---|---|---|
|
|
Помощь о MySQL Shell или онлайн-поиск помощи. |
|
|
Выход из MySQL Shell. |
|
В режиме SQL начинает многострочный режим. Код кэшируется и выполнен, когда пустая строка введена. | |
|
|
Покажите текущий статус MySQL Shell. |
|
Переключить режим выполнения на JavaScript. | |
|
Переключить режим выполнения на Python. | |
|
Переключить режим выполнения на SQL. | |
|
|
Соединиться с MySQL Server. |
|
Пересоединиться с MySQL Server. | |
|
|
Определите схему, чтобы использовать. |
|
|
Выполните файл скрипта, используя активный язык. |
|
|
Покажите любые предупреждения, произведенные запросом. |
|
|
Не показывать предупреждения, произведенные запросом. |
|
Представление и история редактирования команд. | |
|
Вручную обновите кэш имен автоматического заполнения. | |
|
Запросить и изменить параметры конфигурации MySQL Shell. | |
|
Управляйте указанным отчетом, используя предоставленные возможности и аргументы. | |
|
Управляйте указанным отчетом, используя предоставленные возможности и аргументы и обновите результаты равномерно. |
Команда \help
может использоваться с или без
параметра. Когда используется без параметра, общее сообщение помощи
печатается, включая информацию о доступных командах MySQL Shell, глобальных
объектах и главных категориях помощи.
Когда используется с параметром, параметр используется, чтобы искать доступную помощь на основе режима, в котором в настоящее время работает MySQL Shell. Параметр может быть словом, командой, API-функцией или частью SQL-оператора. Следующие категории существуют:
AdminAPI
глобальный объект
dba
InnoDB cluster AdminAPI.
Shell Commands
предоставляет подробную
информацию о доступных встроенных командах MySQL Shell.ShellAPI
содержит информацию о
глобальных объектах shell
и
util
, а также модуле
mysql
, который позволяет выполнить SQL
на MySQL Server.SQL Syntax
точка входа, чтобы
получить помощь о синтаксисе SQL-операторов.X DevAPI
детали по модулю
mysqlx
, а также возможности X DevAPI, которые
позволяют работать с MySQL как с Document Store.Чтобы искать помощь по теме, например API-функция, используют имя функции
в качестве pattern
.
Можно использовать подстановочные символы ?
,
чтобы соответствовать любому отдельному символу, и
*
, чтобы соответствовать многократным
знакам в поиске. Подстановочные символы могут использоваться один или
несколько раз в образце. Следующие пространства имен могут также
использоваться, ища помощь:
dba
для AdminAPI.
mysqlx
для X DevAPI.mysql
для ShellAPI
для классического протокола.shell
для прочих классов ShellAPI:
Shell
, Sys
,
Options
.commands
для команд MySQL Shell.cmdline
командного интерфейса
mysqlsh
.Например, чтобы искать помощь по теме, скомандуйте
\help
и:pattern
используйте x devapi
,
чтобы искать помощь на X DevAPI.
\c
,
чтобы искать помощь по команде MySQL Shell \connect
.Cluster
или
dba.Cluster
, чтобы искать помощь
по AdminAPI dba.Cluster()
.Table
или
mysqlx.Table
, чтобы искать помощь
по классу X DevAPI Table
.isView
,
Table.isView
или
mysqlx.Table.isView
, чтобы
искать помощь по функции isView
объекта
Table
.is_view
,
Table.is_view
или
mysqlx.Table.is_view
, чтобы
искать помощь по функции isView
объекта
Table
.sql syntax
как образец поиска.
В зависимости от образца поиска, если один или несколько результатов могут быть найдены. Если только одна тема помощи содержит образец поиска в своем названии, эта тема помощи показана. Если многочисленные названия темы соответствуют образцу, но каждое имеет точное совпадение, эта тема помощи показывается и сопровождается списком других тем с совпадением образца в их названиях. Если никакое точное совпадение не определяется, список тем с совпадением образца в их названиях показан. Если список тем возвращен, можно выбрать тему, чтобы рассмотреть, из списка, войдя в команду снова с расширенным образцом поиска, который соответствует названию соответствующей темы.
Команда \connect
используется, чтобы
соединиться с MySQL Server, используя строку типа URI. См.
Connecting using a URI String.
Например:
\connect root@localhost:3306
Если пароль требуется, сервер его запросит явно.
Используйте опцию --mysqlx
(--mx
), чтобы создать сессию, используя
X-протокол, чтобы соединиться с экземпляром сервера MySQL:
\connect --mysqlx root@localhost:33060
Используйте опцию --mysql
(--mc
), чтобы создать ClassicSession,
позволяя вам использовать протокол MySQL, чтобы выполнить
SQL непосредственно на сервере. Например:
\connect --mysql root@localhost:3306
Использование единственной черты с краткими опциями (то есть,
-mx
и -mc
)
устарело с версии 8.0.13 MySQL Shell.
Команда \reconnect
определяется без
любых параметров или вариантов. Если связь с сервером потеряна, можно
использовать \reconnect
, которая заставляет
MySQL Shell попробовать несколько попыток повторного соединения за сессию,
используя существующие параметры связи. Если те попытки неудачны, можно
установить новую связь, используя команду
\connect
и определение параметров связи.
Команда \status
показывает информацию о
текущем глобальном соединении. Это включает информацию о сервере, набор
символов, продолжительности работы и так далее.
Команда \source
используется, чтобы
выполнить код скрипта в данном пути. Например:
\source /tmp/mydata.sql
Можно выполнить код SQL, JavaScript или Python. Код в файле выполняется, используя активный язык, так чтобы обработать код SQL, MySQL Shell должен быть в режиме SQL. Поскольку код выполняется, используя активный язык, выполняя скрипт на ином языке, чем в настоящее время выбранный язык режима выполнения, можно получить неожиданные результаты.
Команда \use
позволяет вам выбрать,
какая схема активна, например:
\use schema_name
Команда \use
требует, чтобы глобальная сессия
разработки была активна. Команда \use
задает
текущую схему для указанной schema_name
и обновляет переменную db
к объекту, который представляет выбранную схему.
Команда \history
показывает список команд,
введенных ранее в MySQL Shell. \history
выводит записи истории в порядке, в каком они были выполнены с их номером
записи истории, который может использоваться с командой
\history delete
.entry_number
Команда \history
предоставляет следующие возможности:
\history save
сохраняет историю вручную.
\history delete entrynumber
удалит отдельную
запись истории с данным номером.\history delete
firstnumber
-
lastnumber
удалит записи истории в диапазоне данных
номеров. Если lastnumber
после последнего найденного номера записи истории, записи
истории удалены до и включая последнюю.\history delete
number
-
удалит записи истории с
number
до последней включительно.\history delete
-number
удалит конкретное количество записей истории, начинающихся с последней и
двигаясь назад. Например, \history delete -10
удаляет последние 10 записей истории.\history clear
удалит всю историю.См. раздел 4.4.
Когда вы отключите опцию кэша имен автозаполнения, используйте
\rehash
, чтобы вручную обновить кэш.
Например, после того, как вы загружаете новую схему, вводя
\use
, schema
\rehash
обновит автоматическое
заполнение имен. После того, как это автоматическое заполнение узнает об
именах, используемых в базе данных, можно автоматически заполнить такой
текст, как имена таблиц и так далее. См.
раздел
4.3.
Команда \option
позволяет вам запросить и
поменять параметры MySQL Shell во всех режимах. Можно использовать
\option
, чтобы перечислить параметры
конфигурации, которые были установлены, и посмотреть, как их значения
были в последний раз изменены. Можно также использовать его, чтобы установить
и сбросить варианты для сессии или постоянно в конфигурационном файле MySQL
Shell. Для инструкций и списка параметров конфигурации посмотрите
раздел
8.4.
Можно настроить MySQL Shell, чтобы использовать внешний пейджер, чтобы прочитать на экране длинный вывод, например, помощь онлайн или результаты SQL-запросов. Посмотрите раздел 3.5.
Команда \show
управляет названным отчетом,
который может быть или встроенным отчетом о MySQL Shell или определенным
пользователями отчетом, который был зарегистрирован в MySQL Shell. Можно
определить стандартные возможности для команды, и любые варианты или
дополнительные аргументы, которые отчет поддерживает.
Команда \watch
управляет отчетом таким же
образом, как \show
, но обновляет результаты
равномерно, пока вы не отменяете использование команды с помощью
Ctrl + C.