2.3.2.2 MySQL Configurator CLI

MySQL Configurator поддерживает режимы GUI (по умолчанию) и CLI (передав --console) с помощью исполняемого файла mysql_configurator.exe.

Важно

Known Limitation: только действие configure поддерживается в MySQL Configurator 9.2.0.

Примечание

Функциональность MySQL Configurator CLI была добавлена в MySQL Configurator 9.2.0.

Для выполнения MySQL Configurator требуется пользователь Windows с правами администратора, иначе система запросит учетные данные.

Синтаксис CLI

Общий синтаксис:

mysql_configurator.exe --console [--help] | [--action=action_name | -a=action_name] | ...]

Таблица 2.6 Синтаксис

Таблица 2.6 Синтаксис
Имя опции	Сокращение	Поддерживаемые значения	Пример использования	Описание
console	c	N/A	--console	Активирует CLI в MySQL Configurator, в противном случае запускается GUI.
действие	a	configure, reconfigure, remove или upgrade	--action=configure	Запускает MySQL Configurator CLI в режиме новой конфигурации, переконфигурации, удаления или обновления.
помощь	h	N/A	--help	Отображает общую справку или справку по соответствующему действию. Если не указан элемент `--action`, отображается общая справка.
опция действия и значение	N/A	См. раздел "Опции Configure/Reconfigure/Remove/Upgrade" для поддерживаемых значений и подробностей	--datadir="C:\MySQL...", --port=3306	Определяет различные параметры конфигурации, доступные для каждого действия CLI (конфигурация, переконфигурация, удаление или обновление)

Доступные действия

Каждое действие (configure, reconfigure, remove и upgrade) имеет набор опций, определяющих элементы для конфигурации при выполнении операции. Синтаксис --action_option=action_value со полным списком опций действия ниже:

Таблица 2.7 Опции действий

Таблица 2.7 Опции действий
Опция действия	Сокращение	Псевдонимы	Тип	Значения	Значение по умолчанию	Действие	Условие	Описание

datadir	d	data-dir, data-directory	Путь	N/A	"C:\ProgramData\MySQL\MySQL Server x.x", где `x.x` соответствует соответствующей основной и дополнительной версии сервера.	configure	N/A	Путь к каталогу данных MySQL-сервера. Этот параметр устанавливает системную переменную `datadir`.
config-type	N/A	configuration-type	список	Developer, Server, Dedicated, Manual	development	configure, reconfigure	N/A	Оптимизирует системные ресурсы в зависимости от предполагаемого использования экземпляра сервера.
enable-tcp-ip	N/A	N/A	bool	true, false	true	configure, reconfigure	N/A	Указывает, разрешены ли подключения через TCP/IP.
port	P	N/A	число	N/A	3306	configure, reconfigure	enable-tcp-id=true	Номер порта для прослушивания подключений через TCP/IP.
mysqlx-port	X	x-port, xport	число	N/A	3306	configure, reconfigure	enable-tcp-ip=true	Сеть порт, на котором X Plugin прослушивает подключения через TCP/IP. Это эквивалент X Plugin для `port`.
open_win_firewall	N/A	open-windows-firewall, openfirewall	bool	true, false	true	configure, reconfigure	enable-tcp-ip=true	Создаёт правила брандмауэра Windows для подключений TCP/IP для параметров `port` и `mysqlx-port`.
enable-named-pipes	N/A	named-pipes	bool	true, false	false	configure, reconfigure	N/A	Указывает, разрешены ли подключения через именованные каналы.
socket	N/A	pipe-name, named-pipe-name, named-pipe, pipename	строка	N/A	MYSQL	configure, reconfigure	enable-named-pipes=true	Указывает имя канала для прослушивания локальных подключений, использующих именованный канал. Значение по умолчанию — MySQL, регистр не учитывается.
named-pipe-full-access-group	N/A	full-access-group	строка	"", все пользователи, допустимое имя локальной группы Windows	"" (пустая строка)	configure, reconfigure	enable-named-pipes=true	Устанавливает имя локальной группы Windows, члены которой имеют достаточный доступ к MySQL-серверу для использования клиентов именованных каналов. Значение по умолчанию — пустая строка, что означает, что ни один пользователь Windows не имеет полного доступа к именованному каналу.
shared-memory	N/A	enable-shared-memory	bool	true, false	false	configure, reconfigure	N/A	Разрешает ли сервер подключения через общую память.
shared-memory-base-name	N/A	shared-memory-name, shared-mem-name	строка	N/A	MYSQL	configure, reconfigure	shared-memory=true	Имя подключения общей памяти, используемого для связи с сервером.
password	p	pwd, root-password, passwd, rootpasswd	строка	N/A	N/A	configure, reconfigure	N/A	Пароль, назначенный пользователю root во время конфигурации или переконфигурации. Пароль нельзя изменить во время переконфигурации, хотя он необходим для проверки подключения к серверу.
configure-as-service	N/A	as-windows-service, as-win-service	bool	true, false	true	configure, reconfigure	N/A	Конфигурирует MySQL-сервер на запуск в виде службы Windows. По умолчанию служба Windows работает с учетной записью стандартной системы (Network Service).
windows-service-name	N/A	service-name, win-service-name, servicename	строка	N/A	"MySQLxx", где `xx` соответствует основной и дополнительной версии сервера.	configure, reconfigure	configure-as-service=true	Имя службы Windows, используемой для запуска MySQL Server.
windows-service-auto-start	N/A	win-service-auto-start, service-auto-start, auto-start, autostart	bool	true, false	true	configure, reconfigure	configure-as-service=true	При конфигурации в качестве службы Windows, это значение задаёт автоматический запуск службы при запуске системы.
windows-service-user	N/A	win-service-user, service-user	строка	N/A	NT AUTHORITY	configure, reconfigure	configure-as-service=true	Имя учётной записи пользователя Windows, используемой для запуска службы Windows.
windows-service-password	N/A	win-service-password, win-service-pwd, service-password, service-pwd, sapass	строка	N/A	"" (пустая строка)	configure, reconfigure	configure-as-service=true	Пароль учётной записи пользователя Windows, используемой для запуска службы Windows.
server-file-permissions-access	N/A	server-file-access	список	FullAccess, Configure, Manual	full-access	configure, upgrade	N/A	Конфигурирует уровень доступа пользователя к файлам сервера (каталог данных и любые файлы внутри него).
server-file-full-control-list	N/A	full-control-list	разделенный запятыми список	пользователи/группы Windows	пользователь, запускающий службу Windows (если применимо), и группа Администраторы	configure, upgrade	server-file-permissions-access=configure	Определяет список пользователей или групп с полным доступом к файлам сервера, разделённых запятыми.
server-file-no-access-list	N/A	no-access-list	разделенный запятыми список	пользователи/группы Windows	пусто	configure, upgrade	server-file-permissions-access=configure	Определяет список пользователей или групп без доступа к файлам сервера, разделённых запятыми.
enable-error-log	N/A	enable-err-log	bool	true, false	true	configure, reconfigure	N/A	Включает журнал ошибок. Журнал ошибок содержит запись времени запуска и завершения mysqld. Он также содержит диагностические сообщения, такие как ошибки, предупреждения и заметки, которые возникают во время запуска и завершения сервера и в то время, когда сервер работает.
log-error	N/A	error-log, error-log-file, errorlogname	Путь/Имя файла	N/A	{host_name}.err	configure, reconfigure	enable-error-log=true	Определяет расположение журнала ошибок. Если путь не указан, расположение файла — каталог данных.
slow-query-log	N/A	enable-slow-log	bool	true, false	false	configure, reconfigure	N/A	Включен ли журнал медленных запросов.
slow-query-log-file	N/A	slow-log-file, slowlogname	Имя файла	N/A	{host_name}-slow.log	configure, reconfigure	slow-query-log=true	Имя файла журнала медленных запросов.
general-log	N/A	enable-general-log, generallog	bool	true, false	false	configure, reconfigure	N/A	Включен ли общий журнал запросов.
general-log-file	N/A	generallogname	Имя файла	N/A	{host_name}.log	configure, reconfigure	general-log=true	Имя файла общего журнала запросов.
enable-log-bin	N/A	enable-binary-log	bool	true, false	true	configure, reconfigure	N/A	Включает двоичное протоколирование.
log-bin	N/A	binary-log	Имя файла	N/A	{host_name}-bin	configure, reconfigure	enable-log-bin=true	Указывает базовое имя для файлов двоичного журнала. При включённом двоичном протоколировании сервер записывает все операторы, изменяющие данные, в двоичный журнал, который используется для резервного копирования и репликации. Двоичный журнал — это последовательность файлов с базовым именем и числовым расширением.
server-id	N/A	serverid	число	N/A	1	configure	N/A	Для серверов, используемых в топологии репликации, необходимо указать уникальный идентификатор сервера для каждого сервера репликации в диапазоне от 1 до 2^32 - 1. «Уникальный» означает, что каждый идентификатор должен отличаться от любого другого идентификатора, используемого любым другим сервером источника или реплики в топологии репликации.
lower-case-table-names	N/A	N/A	список	0, 1, 2	1	configure	N/A	Если установлено в 0, имена таблиц хранятся в указанном виде, и сравнения регистрозависимые. Если установлено в 1, имена таблиц хранятся в нижнем регистре на диске, и сравнения не регистрозависимые. Если установлено в 2, имена таблиц хранятся в исходном виде, но сравниваются в нижнем регистре. Этот параметр также применяется к именам баз данных и псевдонимам таблиц.
install-sample-database	N/A	install-example-database	список	All, Sakila, World, None	none	configure, reconfigure	N/A	Устанавливает указанные образцовые базы данных.
uninstall-sample-database	N/A	uninstall-example-database	список	All, Sakila, World, None	none	configure, reconfigure	N/A	Удаляет указанные образцовые базы данных.
old-instance-protocol	N/A	existing-instance-protocol	список	Socket, Sockets, Tcp, Pipe, NamedPipe, SharedMemory, Memory	N/A	tcp-ip	upgrade	Протокол подключения, используемый экземпляром сервера, который обновляется.
old-instance-port	N/A	existing-instance-port	число	N/A	3306	upgrade	N/A	Номер порта, который должен использовать экземпляр сервера, который обновляется, при прослушивании подключений TCP/IP.
old-instance-pipe-name	N/A	existing-instance-pipe-name	строка	N/A	MYSQL	upgrade	N/A	Указывает имя канала, которое должен использовать экземпляр сервера, который обновляется, при прослушивании локальных подключений, использующих именованный канал.
old-instance-memory-name	N/A	old-instance-shared-memory-name, existing-instance-memory-name, existing-instance-shared-memory-name	строка	N/A	MYSQL	upgrade	N/A	Имя подключения общей памяти, используемое экземпляром сервера, который обновляется, для связи с сервером.

old-instance-password	N/A	old-instance-pwd, old-instance-root-password, existing-instance-password, existing-instance-pwd, existing-instance-pwd	строка	N/A	N/A	upgrade	N/A	Пароль пользователя root, используемого экземпляром сервера, который обновляется.
backup-data	N/A	backup-data-directory	bool	true, false	true	upgrade	N/A	Создаёт резервную копию баз данных, чтобы обеспечить восстановление данных в случае сбоя.
keep-data-directory	N/A	keep-data	bool	true, false	false	remove	N/A	Запрещает удаление каталога данных при удалении других настроек.
defaults-extra-file	N/A	password-file, pass-file, pwd-file	Путь	N/A	N/A	reconfigure, upgrade	N/A	Путь и имя файла, содержащего запись `password`, которая определяет пароль пользователя root.
windows-service-account-password-file	N/A	windows-service-account-password-file, win-service-account-pass-file, service-account-pwd-file, win-service-account-pwd-file, service-account-password-file	Путь	N/A	N/A	configure, reconfigure	N/A	Путь и имя файла, содержащего запись `password`, которая определяет пароль пользователя учётной записи службы Windows, связанной с службой Windows, которая запускает сервер.

Управление пользователями MySQL

Действия configure и reconfigure позволяют создавать и редактировать пользователей MySQL в соответствии с опцией --add-user:

--add-user='user_name':'password'|'file_path'|'windows_security_token':host:role:authentication

Действительно только для действия configure (не reconfigure).

Имя пользователя, пароль и путь к файлу токена должны быть заключены в одинарные или двойные кавычки. Экранируйте одинарные кавычки, двойные кавычки и обратные слэши, если они присутствуют в имени пользователя или пароле.

Примеры добавления пользователя:

mysql_configurator.exe --console --action=configure --add-user='john':'mypass12%':%:"Db Admin":MYSQL
mysql_configurator.exe --console --action=configure --add-user='jenny':'jenny-T480\jenny':localhost:"Administrator":Windows

Общие примеры

Новая конфигурация:

# Simple
mysql_configurator.exe --console --action=configure --password=test

# More complex
mysql_configurator.exe --console --action=configure --password=test --port=3320 --enable-pipe-names --pipe-name=MYSQL_PIPE --server-id=2 --install-sample-database=both

# More complex, also with users
mysql_configurator.exe --console --action=configure --password=other123 --add-user='john':'pa$$':"Db Admin":MYSQL --add-user='mary':'p4ssW0rd':"Administrator":MYSQL

Переконфигурация:

# Basic reconfiguration
mysql_configurator.exe --console --action=reconfigure --password=test --port=3310

# Complex reconfiguration
mysql_configurator.exe --console --action=reconfigure --password=test --enable-shared-memory=false

Удаление:

mysql_configurator.exe --console --action=remove --keep-data-directory=true

Обновление:

# Basic removal
mysql_configurator.exe --console --action=upgrade --old-instance-password=test

# Complex removal
mysql_configurator.exe --console --action=upgrade --old-instance-password=test --backup-data=false --server-file-permissions-access=full

Обработка пароля root

Существует несколько способов передачи пароля пользователя root в зависимости от потребностей в плане безопасности и простоты. Различные методы в порядке приоритета:

Передача паролей в качестве аргументов командной строки:

Передайте --password (для конфигурации и переконфигурации) или --old-instance-password (для обновлений) в командную строку.
Установка паролей в файле конфигурации MySQL:

Наличие записи "password={password_here}" непосредственно в файле конфигурации my.ini определяет пароль пользователя root.

Наличие записи "password={password_here}" в дополнительном файле конфигурации (в соответствии с --defaults-extra-file) также может определять пароль пользователя root.
Определение паролей с помощью переменных среды:

MYSQL_PWD: Аналогично MySQL-клиенту, значение, определённое в переменной среды MYSQL_PWD, может определить пароль пользователя root, если он не был определён другим методом. Эта переменная относится к действиям configure, reconfigure и upgrade.

WIN_SERVICE_ACCOUNT_PWD: Эта переменная среды может установить пароль пользователя учётной записи службы Windows, настроенной для запуска службы MySQL Windows, если сервер настроен на запуск в виде службы. Эта переменная относится к действиям configure и reconfigure.