19.4.2.2 X Plugin Options and System Variables — MySQL 5.7

19.4.2.2 Параметры плагина X и системные переменные

Для управления включением плагина X используйте этот параметр:

--mysqlx[=value]

Формат командной строки	`--mysqlx[=value]`
Введено	5.7.12
Тип	Перечисление
Значение по умолчанию	`ON`
Допустимые значения	`ON` `OFF` `FORCE` `FORCE_PLUS_PERMANENT`

Этот параметр управляет тем, как сервер загружает плагин X при запуске. Он доступен только в том случае, если плагин был предварительно зарегистрирован с помощью INSTALL PLUGIN или загружен с помощью --plugin-load или --plugin-load-add.

Значение параметра должно быть одним из доступных значений для параметров загрузки плагинов, как описано в Разделе 5.5.1, «Установка и удаление плагинов». Например, --mysqlx=FORCE_PLUS_PERMANENT сообщает серверу загрузить плагин и предотвратить его удаление во время работы сервера.

Если плагин X включен, он предоставляет несколько системных переменных, которые позволяют управлять его работой:

mysqlx_bind_address

Формат командной строки	`--mysqlx-bind-address=addr`
Введена	5.7.17
Системная переменная	`mysqlx_bind_address`
Область видимости	Глобальная
Динамическая	Нет
Тип	Строка
Значение по умолчанию	`*`

Сетевой адрес, по которому X Plugin прослушивает TCP/IP-подключения. Эта переменная не является динамической и может быть настроена только при запуске. Это эквивалент X Plugin системной переменной bind_address; см. описание этой переменной для получения дополнительной информации.

mysqlx_bind_address принимает одно значение адреса, которое может указывать на один не универсальный IP-адрес или имя хоста, или один из форматов универсального адреса, которые позволяют прослушивать несколько сетевых интерфейсов (*, 0.0.0.0 или ::).

IP-адрес может быть указан как IPv4 или IPv6 адрес. Если значением является имя хоста, X Plugin преобразует имя в IP-адрес и привязывается к этому адресу. Если имя хоста преобразуется в несколько IP-адресов, X Plugin использует первый IPv4-адрес, если таковые имеются, или первый IPv6-адрес в противном случае.

X Plugin обрабатывает различные типы адресов следующим образом:

Если адрес является *, X Plugin принимает TCP/IP-подключения на всех IPv4-интерфейсах хоста сервера и, если хост сервера поддерживает IPv6, на всех IPv6-интерфейсах. Используйте этот адрес, чтобы разрешить подключения как IPv4, так и IPv6 для X Plugin. Это значение используется по умолчанию.
Если адрес является 0.0.0.0, X Plugin принимает TCP/IP-подключения на всех IPv4-интерфейсах хоста сервера.
Если адрес является ::, X Plugin принимает TCP/IP-подключения на всех IPv4 и IPv6 интерфейсах хоста сервера.
Если адрес является IPv4-отображаемым адресом, X Plugin принимает TCP/IP-подключения для этого адреса в формате IPv4 или IPv6. Например, если X Plugin привязан к ::ffff:127.0.0.1, клиент, такой как MySQL Shell, может подключиться с помощью --host=127.0.0.1 или --host=::ffff:127.0.0.1.
Если адрес является “обычным” IPv4 или IPv6 адресом (например, 127.0.0.1 или ::1), X Plugin принимает TCP/IP-подключения только для этого IPv4 или IPv6 адреса.

Если привязка к адресу завершается неудачей, X Plugin выдает ошибку, и сервер не загружает его.

mysqlx_connect_timeout

Формат командной строки	`--mysqlx-connect-timeout=#`
Введена	5.7.12
Системная переменная	`mysqlx_connect_timeout`
Область видимости	Глобальная
Динамическая	Да
Тип	Целое число
Значение по умолчанию	`30`
Минимальное значение	`1`
Максимальное значение	`1000000000`
Единица измерения	секунды

Количество секунд, в течение которых X Plugin ожидает приема первого пакета от вновь подключенных клиентов. Это эквивалент X Plugin переменной connect_timeout; см. описание этой переменной для получения дополнительной информации.

mysqlx_idle_worker_thread_timeout

Формат командной строки	`--mysqlx-idle-worker-thread-timeout=#`
Введена	5.7.12
Системная переменная	`mysqlx_idle_worker_thread_timeout`
Область видимости	Глобальная
Динамическая	Да
Тип	Целое число
Значение по умолчанию	`60`
Минимальное значение	`0`
Максимальное значение	`3600`
Единица измерения	секунды

Количество секунд, по истечении которых завершаются неактивные рабочие потоки.

mysqlx_max_allowed_packet

Формат командной строки	`--mysqlx-max-allowed-packet=#`
Введена	5.7.12
Системная переменная	`mysqlx_max_allowed_packet`
Область видимости	Глобальная
Динамическая	Да
Тип	Целое число
Значение по умолчанию	`67108864`
Минимальное значение	`512`
Максимальное значение	`1073741824`
Единица измерения	байты

Максимальный размер сетевых пакетов, которые могут быть получены X Plugin. Это эквивалент X Plugin переменной max_allowed_packet; см. описание этой переменной для получения дополнительной информации.

mysqlx_max_connections

Формат командной строки	`--mysqlx-max-connections=#`
Введена	5.7.12
Системная переменная	`mysqlx_max_connections`
Область видимости	Глобальная
Динамическая	Да
Тип	Целое число
Значение по умолчанию	`100`
Минимальное значение	`1`
Максимальное значение	`65535`

Максимальное количество одновременных клиентских подключений, которые может принимать X Plugin. Это эквивалент X Plugin переменной max_connections; см. описание этой переменной для получения дополнительной информации.

Для изменений этой переменной, если новое значение меньше текущего количества подключений, новый лимит учитывается только для новых подключений.

mysqlx_min_worker_threads

Формат командной строки	`--mysqlx-min-worker-threads=#`
Введена	5.7.12
Системная переменная	`mysqlx_min_worker_threads`
Область видимости	Глобальная
Динамическая	Да
Тип	Целое число
Значение по умолчанию	`2`
Минимальное значение	`1`
Максимальное значение	`100`

Минимальное количество рабочих потоков, используемых X Plugin для обработки запросов клиентов.

mysqlx_port

Формат командной строки	`--mysqlx-port=port_num`
Введена	5.7.12
Системная переменная	`mysqlx_port`
Область видимости	Глобальная
Динамическая	Нет
Тип	Целое число
Значение по умолчанию	`33060`
Минимальное значение	`1`
Максимальное значение	`65535`

Сетевой порт, по которому X Plugin прослушивает TCP/IP-подключения. Это эквивалент X Plugin переменной port; см. описание этой переменной для получения дополнительной информации.

mysqlx_port_open_timeout

Формат командной строки	`--mysqlx-port-open-timeout=#`
Введена	5.7.17
Системная переменная	`mysqlx_port_open_timeout`
Область видимости	Глобальная
Динамическая	Нет
Тип	Целое число
Значение по умолчанию	`0`
Минимальное значение	`0`
Максимальное значение	`120`
Единица измерения	секунды

Количество секунд, в течение которых X Plugin ожидает освобождения TCP/IP-порта.

mysqlx_socket

Формат командной строки	`--mysqlx-socket=file_name`
Введено	5.7.15
Системная переменная	`mysqlx_socket`
Область действия	Глобальная
Динамическая	Нет
Тип	Строка
Значение по умолчанию	`/tmp/mysqlx.sock`

Путь к файлу сокета Unix, который X Plugin использует для подключений. Эта настройка используется сервером MySQL только при работе в операционных системах Unix. Клиенты могут использовать этот сокет для подключения к серверу MySQL с помощью X Plugin.

Путь и имя файла по умолчанию для mysqlx_socket основаны на пути и имени файла по умолчанию для основного файла сокета для сервера MySQL, с добавлением x к имени файла. Путь и имя файла по умолчанию для основного файла сокета — /tmp/mysql.sock, поэтому путь и имя файла по умолчанию для файла сокета X Plugin — /tmp/mysqlx.sock.

Если вы указываете альтернативный путь и имя файла для основного файла сокета при запуске сервера с помощью системной переменной socket, это не влияет на значение по умолчанию для файла сокета X Plugin. В этой ситуации, если вы хотите хранить оба сокета по одному пути, вы также должны установить системную переменную mysqlx_socket. Например, в конфигурационном файле:

socket=/home/sockets/mysqld/mysql.sock
mysqlx_socket=/home/sockets/xplugin/xplugin.sock

Если вы измените путь и имя файла по умолчанию для основного файла сокета во время компиляции, используя параметр компиляции MYSQL_UNIX_ADDR, это повлияет на значение по умолчанию для файла сокета X Plugin, который формируется путем добавления x к имени файла MYSQL_UNIX_ADDR. Если вы хотите установить другое значение по умолчанию для файла сокета X Plugin во время компиляции, используйте параметр компиляции MYSQLX_UNIX_ADDR.

Переменная среды MYSQLX_UNIX_PORT также может использоваться для установки значения по умолчанию для файла сокета X Plugin при запуске сервера (см. Раздел 4.9, «Переменные среды»). Если вы устанавливаете эту переменную среды, она переопределяет скомпилированное значение MYSQLX_UNIX_ADDR, но переопределяется значением mysqlx_socket.

mysqlx_ssl_ca

Формат командной строки	`--mysqlx-ssl-ca=file_name`
Введено	5.7.12
Системная переменная	`mysqlx_ssl_ca`
Область действия	Глобальная
Динамическая	Нет
Тип	Имя файла
Значение по умолчанию	`NULL`

Системная переменная mysqlx_ssl_ca похожа на ssl_ca, за исключением того, что она применяется к X Plugin, а не к основному интерфейсу соединения сервера MySQL. Информацию о настройке поддержки шифрования для X Plugin см. в Разделе 19.4.1, «Использование зашифрованных соединений с X Plugin».

mysqlx_ssl_capath

Формат командной строки	`--mysqlx-ssl-capath=dir_name`
Введено	5.7.12
Системная переменная	`mysqlx_ssl_capath`
Область действия	Глобальная
Динамическая	Нет
Тип	Имя каталога
Значение по умолчанию	`NULL`

Системная переменная mysqlx_ssl_capath похожа на ssl_capath, за исключением того, что она применяется к X Plugin, а не к основному интерфейсу соединения сервера MySQL. Информацию о настройке поддержки шифрования для X Plugin см. в Разделе 19.4.1, «Использование зашифрованных соединений с X Plugin».

mysqlx_ssl_cert

Формат командной строки	`--mysqlx-ssl-cert=file_name`
Введено	5.7.12
Системная переменная	`mysqlx_ssl_cert`
Область действия	Глобальная
Динамическая	Нет
Тип	Имя файла
Значение по умолчанию	`NULL`

Системная переменная mysqlx_ssl_cert похожа на ssl_cert, за исключением того, что она применяется к X Plugin, а не к основному интерфейсу соединения сервера MySQL. Информацию о настройке поддержки шифрования для X Plugin см. в Разделе 19.4.1, «Использование зашифрованных соединений с X Plugin».

mysqlx_ssl_cipher

Формат командной строки	`--mysqlx-ssl-cipher=name`
Введено	5.7.12
Системная переменная	`mysqlx_ssl_cipher`
Область действия	Глобальная
Динамическая	Нет
Тип	Строка
Значение по умолчанию	`NULL`

Системная переменная mysqlx_ssl_cipher похожа на ssl_cipher, за исключением того, что она применяется к X Plugin, а не к основному интерфейсу соединения сервера MySQL. Информацию о настройке поддержки шифрования для X Plugin см. в Разделе 19.4.1, «Использование зашифрованных соединений с X Plugin».

mysqlx_ssl_crl

Формат командной строки	`--mysqlx-ssl-crl=file_name`
Введено	5.7.12
Системная переменная	`mysqlx_ssl_crl`
Область действия	Глобальная
Динамическая	Нет
Тип	Имя файла
Значение по умолчанию	`NULL`

Системная переменная mysqlx_ssl_crl похожа на ssl_crl, за исключением того, что она применяется к X Plugin, а не к основному интерфейсу соединения сервера MySQL. Информацию о настройке поддержки шифрования для X Plugin см. в Разделе 19.4.1, «Использование зашифрованных соединений с X Plugin».

mysqlx_ssl_crlpath

Формат командной строки	`--mysqlx-ssl-crlpath=dir_name`
Введено	5.7.12
Системная переменная	`mysqlx_ssl_crlpath`
Область действия	Глобальная
Динамическая	Нет
Тип	Имя каталога
Значение по умолчанию	`NULL`

Системная переменная mysqlx_ssl_crlpath похожа на ssl_crlpath, за исключением того, что она применяется к X Plugin, а не к основному интерфейсу соединения сервера MySQL. Информацию о настройке поддержки шифрования для X Plugin см. в Разделе 19.4.1, «Использование зашифрованных соединений с X Plugin».

mysqlx_ssl_key

Формат командной строки	`--mysqlx-ssl-key=file_name`
Введено	5.7.12
Системная переменная	`mysqlx_ssl_key`
Область действия	Глобальная
Динамическая	Нет
Тип	Имя файла
Значение по умолчанию	`NULL`

Системная переменная mysqlx_ssl_key похожа на ssl_key, за исключением того, что она применяется к плагину X, а не к основному интерфейсу подключения к MySQL Server. Сведения о настройке поддержки шифрования для плагина X см. в разделе 19.4.1, «Использование шифрованных подключений с плагином X».