mysql_plugin - Man Page

configure MariaDB server plugins (mysql_plugin is now a symlink to mariadb-plugin)

Synopsis

mysql_plugin [options] plugin {ENABLE|DISABLE}

Description

The mysql_plugin utility enables MariaDB administrators to manage which plugins a MariaDB server loads​. It provides an alternative to manually specifying the --plugin-load option at server startup or using the INSTALL PLUGIN and UNINSTALL PLUGIN statements at runtime​.

Depending on whether mysql_plugin is invoked to enable or disable plugins, it inserts or deletes rows in the mysql​.plugin table that serves as a plugin registry​. (To perform this operation, mysql_plugin invokes the MariaDB server in bootstrap mode​. This means that the server must not already be running​.) For normal server startups, the server loads and enables plugins listed in mysql​.plugin automatically​. For additional control over plugin activation, use --plugin_name options named for specific plugins​.

Each invocation of mysql_plugin reads a configuration file to determine how to configure the plugins contained in a single plugin library object file​. To invoke mysql_plugin, use this syntax:

mysql_plugin [options] plugin {ENABLE|DISABLE}

plugin is the name of the plugin to configure​. ENABLE or DISABLE (not case sensitive) specify whether to enable or disable components of the plugin library named in the configuration file​. The order of the plugin and ENABLE or DISABLE arguments does not matter​.

For example, to configure components of a plugin library file named myplugins​.so on Linux or myplugins​.dll on Windows, specify a plugin value of myplugins​. Suppose that this plugin library contains three plugins, plugin1, plugin2, and plugin3, all of which should be configured under mysql_plugin control​. By convention, configuration files have a suffix of ​.ini and the same basename as the plugin library, so the default configuration file name for this plugin library is myplugins​.ini​. The configuration file contents look like this:

myplugins
plugin1
plugin2
plugin3

The first line in the myplugins​.ini file is the name of the library object file, without any extension such as ​.so or ​.dll​. The remaining lines are the names of the components to be enabled or disabled​. Each value in the file should be on a separate line​. Lines on which the first character is '#' are taken as comments and ignored​.

To enable the plugins listed in the configuration file, invoke mysql_plugin this way:

shell> mysql_plugin myplugins ENABLE

To disable the plugins, use DISABLE rather than ENABLE​.

An error occurs if mysql_plugin cannot find the configuration file or plugin library file, or if mysql_plugin cannot start the MariaDB server​.

mysql_plugin supports the following options, which can be specified on the command line or in the [mysqld] group of any option file​. For options specified in a [mysqld] group, mysql_plugin recognizes the --basedir, --datadir, and --plugin-dir options and ignores others​.

mysql_plugin Options

See Also

For more information, please refer to the MariaDB Documentation, available online at https://mariadb.com/docs/

Author

MariaDB Foundation (http://www.mariadb.org/).

Info

15 May 2020 MariaDB 10.11 MariaDB Database System