Прежде чем использовать плагин сервера, его необходимо установить одним из следующих способов. В описаниях 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 и 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'.