INSTALL PLUGIN [IF NOT EXISTS] plugin_name SONAME 'plugin_library'
plugin_name is the name of the plugin as defined in the
plugin declaration structure contained in the library file. Plugin names are
not case sensitive. For maximal compatibility, plugin names should be limited
to ASCII letters, digits, and underscore, because they are used in C source
files, shell command lines, M4 and Bourne shell scripts, and SQL environments.
plugin_library is the name of the shared library that
contains the plugin code. Before MariaDB 5.5.21, the name should include the file name extension (for
libmyplugin.dll). Starting from MariaDB 5.5.21, the file name extension can be omitted (which makes the statement look the same on all architectures).
The shared library must be located in the plugin directory (that is,
the directory named by the
plugin_dir system variable). The library must be in the plugin directory itself, not in a subdirectory. By
plugin_dir is plugin directory under the directory named by
pkglibdir configuration variable, but it can be changed by setting
the value of
plugin_dir at server startup. For example, set
its value in a
If the value of
plugin_dir is a relative path name, it is
taken to be relative to the MySQL base directory (the value of the basedir
INSTALL PLUGIN adds a line to the
mysql.plugin table that
describes the plugin. This table contains the plugin name and library file
INSTALL PLUGIN causes the server to read
my.cnf) files just as during server startup. This enables the plugin to
pick up any relevant options from those files. It is possible to add plugin
options to an option file even before loading a plugin (if the loose prefix is
used). It is also possible to uninstall a plugin, edit
my.cnf, and install the
plugin again. Restarting the plugin this way enables it to the new option
values without a server restart.
Before MySQL 5.1.33, a plugin was started with each option set to its default value.
INSTALL PLUGIN also loads and initializes the plugin code to
make the plugin available for use. A plugin is initialized by executing its
initialization function, which handles any setup that the plugin must perform
before it can be used.
INSTALL PLUGIN, you must have the
INSERT privilege for the
At server startup, the server loads and initializes any plugin that is
listed in the
mysql.plugin table. This means that a plugin is installed
INSTALL PLUGIN only once, not every time the server
starts. Plugin loading at startup does not occur if the server is started with
When the server shuts down, it executes the deinitialization function for each plugin that is loaded so that the plugin has a chance to perform any final cleanup.
If you need to load plugins for a single server startup when the
--skip-grant-tables option is given (which tells the server
not to read system tables), use the
--plugin-load mysqld option.
MariaDB starting with 10.4.0
IF NOT EXISTS
IF NOT EXISTS clause is used, MariaDB will return a note instead of an error if the specified plugin already exists. See SHOW WARNINGS.
INSTALL PLUGIN sphinx SONAME 'ha_sphinx.so';
Starting from MariaDB 5.5.21, the extension can be omitted:
INSTALL PLUGIN innodb SONAME 'ha_xtradb';
From MariaDB 10.4.0:
INSTALL PLUGIN IF NOT EXISTS example SONAME 'ha_example'; Query OK, 0 rows affected (0.104 sec) INSTALL PLUGIN IF NOT EXISTS example SONAME 'ha_example'; Query OK, 0 rows affected, 1 warning (0.000 sec) SHOW WARNINGS; +-------+------+------------------------------------+ | Level | Code | Message | +-------+------+------------------------------------+ | Note | 1968 | Plugin 'example' already installed | +-------+------+------------------------------------+