This is a read-only copy of the MariaDB Knowledgebase generated on 2024-11-21. For the latest, interactive version please visit https://mariadb.com/kb/.

mariadb-plugin

mariadb-plugin is a tool for enabling or disabling plugins.

Prior to MariaDB 10.5, the client was called mysql_plugin. It can still be accessed under this name, via a symlink in Linux, or an alternate binary in Windows.

It is a commandline alternative to the INSTALL PLUGIN and UNINSTALL PLUGIN statements, and the --plugin-load option to mariadbd.

mariadb-plugin must be run while the server is offline, and works by adding or removing rows from the mysql.plugin table.

mariadb-plugin basically has two use cases:

  • adding a plugin even before the first real server startup
  • removing a plugin that crashes the server on startup

For the install use case, adding a plugin-load-add entry to my.cnf or in a separate include option file, is probably a better alternative. In case of a plugin loaded via a mysql.plugin crashing the server, uninstalling the plugin with the help of mariadb-plugin can be the only viable action though.

Usage

mariadb-plugin [options] <plugin> ENABLE|DISABLE

mariadb-plugin expects to find a configuration file that indicates how to configure the plugins. The configuration file is by default the same name as the plugin, with a .ini extension. For example:

mariadb-plugin crazyplugins ENABLE

Here, mariadb-plugin will look for a file called crazyplugins.ini

crazyplugins
crazyplugin1
crazyplugin2
crazyplugin3

The first line should contain the name of the library object file, with no extension. The other lines list the names of the components. Each value should be on a separate line, and the # character at the start of the line indicates a comment.

Options

The following options can be specified on the command line, while some can be specified in the [mysqld] group of any option file. For options specified in a [mysqld] group, only the --basedir, --datadir, and --plugin-dir options can be used - the rest are ignored.

OptionDescription
-b, --basedir=nameThe base directory for the server.
-d, --datadir=nameThe data directory for the server.
-?, --helpDisplay help and exit.
-f, --my-print-defaults=namePath to my_print_defaults executable. Example: /source/temp11/extra
-m, --mysqld=namePath to mysqld executable. Example: /sbin/temp1/mysql/bin
-n, --no-defaultsDo not read values from configuration file.
-p, --plugin-dir=nameThe plugin directory for the server.
-i, --plugin-ini=nameRead plugin information from configuration file specified instead of from <plugin-dir>/<plugin_name>.ini.
-P, --print-defaultsShow default values from configuration file.
-v, --verboseMore verbose output; you can use this multiple times to get even more verbose output.
-V, --versionOutput version information and exit.

See Also

Content reproduced on this site is the property of its respective owners, and this content is not reviewed in advance by MariaDB. The views, information and opinions expressed by this content do not necessarily represent those of MariaDB or any other party.