Прежде чем использовать плагин сервера, его необходимо установить, используя один из следующих методов. В описаниях plugin_name обозначает имя плагина, например, innodb, csv или validate_password.

Встроенные плагины

Встроенный плагин автоматически распознается сервером. По умолчанию сервер включает плагин при запуске. Некоторые встроенные плагины позволяют изменить это с помощью опции --plugin_name[=activation_state].

Плагины, зарегистрированные в таблице mysql.plugin

Таблица системной информации mysql.plugin служит реестром плагинов (кроме встроенных, которые не нуждаются в регистрации). Во время стандартной последовательности запуска сервер загружает зарегистрированные в таблице плагины. По умолчанию для плагина, загруженного из таблицы mysql.plugin, сервер также включает плагин. Это можно изменить с помощью опции --plugin_name[=activation_state].

Если сервер запускается с опцией --skip-grant-tables, плагины, зарегистрированные в таблице mysql.plugin, не загружаются и недоступны.

Плагины, указанные с опциями командной строки

Плагин, расположенный в файле библиотеки плагинов, может быть загружен при запуске сервера с помощью опции --plugin-load, --plugin-load-add или --early-plugin-load. Обычно сервер также включает загруженный при запуске плагин. Это можно изменить с помощью опции --plugin_name[=activation_state].

Опции --plugin-load и --plugin-load-add загружают плагины после инициализации встроенных плагинов и движков хранения во время последовательности запуска сервера. Опция --early-plugin-load используется для загрузки плагинов, которые должны быть доступны до инициализации встроенных плагинов и движков хранения.

Значение каждой опции загрузки плагинов — это список, разделенный точкой с запятой, из plugin_library и name=plugin_library значений. Каждое plugin_library — это имя файла библиотеки, содержащей код плагина, а каждое name — имя загружаемого плагина. Если имя библиотеки плагина указано без предшествующего имени плагина, сервер загружает все плагины в библиотеке. При наличии предшествующего имени плагина, сервер загружает только указанный плагин из библиотеки. Сервер ищет файлы библиотек плагинов в каталоге, указанном переменной системы plugin_dir.

Опции загрузки плагинов не регистрируют плагин в таблице mysql.plugin. При последующих перезапусках сервер загрузит плагин снова только в том случае, если указаны --plugin-load, --plugin-load-add или --early-plugin-load. То есть, опция выполняет одноразовую установку плагина, которая сохраняется только для одного запуска сервера.

--plugin-load, --plugin-load-add и --early-plugin-load позволяют загружать плагины даже при использовании --skip-grant-tables (что заставляет сервер игнорировать таблицу mysql.plugin). --plugin-load, --plugin-load-add и --early-plugin-load также позволяют загружать плагины при запуске, которые нельзя загрузить во время работы.

Опция --plugin-load-add дополняет опцию --plugin-load:

Например, эти опции:

--plugin-load=x --plugin-load-add=y

эквивалентны этим опциям:

--plugin-load-add=x --plugin-load-add=y

и также эквивалентны этой опции:

--plugin-load="x;y"

Но эти опции:

--plugin-load-add=y --plugin-load=x

эквивалентны этой опции:

--plugin-load=x

Плагины, установленные с помощью инструкции INSTALL PLUGIN

Плагин, расположенный в файле библиотеки плагинов, может быть загружен во время выполнения с помощью инструкции INSTALL PLUGIN. Инструкция также регистрирует плагин в таблице mysql.plugin, чтобы сервер загружал его при последующих перезапусках. По этой причине, INSTALL PLUGIN требует привилегии INSERT для таблицы mysql.plugin.

Имя файла библиотеки плагина зависит от вашей платформы. Распространенные суффиксы — .so для Unix и подобных систем, .dll для Windows.

Пример: Опция --plugin-load-add устанавливает плагин при запуске сервера. Для установки плагина с именем myplugin из файла библиотеки плагинов с именем somepluglib.so используйте эти строки в файле my.cnf:

[mysqld]
plugin-load-add=myplugin=somepluglib.so

В этом случае плагин не регистрируется в mysql.plugin. Перезапуск сервера без опции --plugin-load-add приведет к тому, что плагин не будет загружен при запуске.

Альтернативно, инструкция INSTALL PLUGIN заставляет сервер загрузить код плагина из файла библиотеки во время выполнения:

INSTALL PLUGIN myplugin SONAME 'somepluglib.so';

INSTALL PLUGIN также вызывает «постоянную» регистрацию плагина: плагин перечисляется в таблице mysql.plugin, чтобы гарантировать загрузку сервером при последующих перезапусках.

Многие плагины могут быть загружены либо при запуске сервера, либо во время выполнения. Однако, если плагин разработан таким образом, что он должен быть загружен и инициализирован во время запуска сервера, попытки загрузить его во время выполнения с помощью INSTALL PLUGIN приводят к ошибке:

mysql> INSTALL PLUGIN myplugin SONAME 'somepluglib.so';
ERROR 1721 (HY000): Plugin 'myplugin' is marked as not dynamically
installable. You have to stop the server to install it.

В этом случае необходимо использовать --plugin-load, --plugin-load-add или --early-plugin-load.

Если плагин называется как с помощью опции --plugin-load, --plugin-load-add, или --early-plugin-load, так и (в результате ранее выполненной команды INSTALL PLUGIN) в таблице mysql.plugin, сервер запускается, но записывает эти сообщения в журнал ошибок:

[ERROR] Function 'plugin_name' already exists
[Warning] Couldn't load plugin named 'plugin_name'
with soname 'plugin_object_file'.