1MYSQL_PLUGIN(1) MariaDB Database System MYSQL_PLUGIN(1)
2
6 mysql_plugin - configure MariaDB server plugins
7
9 mysql_plugin [options] plugin {ENABLE|DISABLE}
10
12 The mysql_plugin utility enables MariaDB administrators to manage which
13 plugins a MariaDB server loads. It provides an alternative to manually
14 specifying the --plugin-load option at server startup or using the
15 INSTALL PLUGIN and UNINSTALL PLUGIN statements at runtime.
16 Depending on whether mysql_plugin is invoked to enable or disable
18 plugins, it inserts or deletes rows in the mysql.plugin table that
19 serves as a plugin registry. (To perform this operation, mysql_plugin
20 invokes the MariaDB server in bootstrap mode. This means that the
21 server must not already be running.) For normal server startups, the
22 server loads and enables plugins listed in mysql.plugin automatically.
23 For additional control over plugin activation, use --plugin_name
24 options named for specific plugins.
25 Each invocation of mysql_plugin reads a configuration file to determine
27 how to configure the plugins contained in a single plugin library
28 object file. To invoke mysql_plugin, use this syntax:
29 mysql_plugin [options] plugin {ENABLE|DISABLE}
31 plugin is the name of the plugin to configure. ENABLE or DISABLE (not
33 case sensitive) specify whether to enable or disable components of the
34 plugin library named in the configuration file. The order of the plugin
35 and ENABLE or DISABLE arguments does not matter.
36 For example, to configure components of a plugin library file named
38 myplugins.so on Linux or myplugins.dll on Windows, specify a plugin
39 value of myplugins. Suppose that this plugin library contains three
40 plugins, plugin1, plugin2, and plugin3, all of which should be
41 configured under mysql_plugin control. By convention, configuration
42 files have a suffix of .ini and the same basename as the plugin
43 library, so the default configuration file name for this plugin library
44 is myplugins.ini. The configuration file contents look like this:
45 myplugins
47 plugin1
48 plugin2
49 plugin3
50 The first line in the myplugins.ini file is the name of the library
52 object file, without any extension such as .so or .dll. The remaining
53 lines are the names of the components to be enabled or disabled. Each
54 value in the file should be on a separate line. Lines on which the
55 first character is '#' are taken as comments and ignored.
56 To enable the plugins listed in the configuration file, invoke
58 mysql_plugin this way:
59 shell> mysql_plugin myplugins ENABLE
61 To disable the plugins, use DISABLE rather than ENABLE.
63 An error occurs if mysql_plugin cannot find the configuration file or
65 plugin library file, or if mysql_plugin cannot start the MariaDB
66 server.
67 mysql_plugin supports the following options, which can be specified on
69 the command line or in the [mysqld] group of any option file. For
70 options specified in a [mysqld] group, mysql_plugin recognizes the
71 --basedir, --datadir, and --plugin-dir options and ignores others.
72 mysql_plugin Options
74 · --help, -?
76 Display a help message and exit.
78 · --basedir=path, -b path
80 The server base directory.
82 · --datadir=path, -d path
84 The server data directory.
86 · --my-print-defaults=path, -b path
88 The path to the my_print_defaults program.
90 · --mysqld=path, -b path
92 The path to the mysqld server.
94 · --no-defaults, -p
96 Do not read values from the configuration file. This option enables
98 an administrator to skip reading defaults from the configuration
99 file.
100 With mysql_plugin, this option need not be given first on the
102 command line, unlike most other MariaDB programs that support
103 --no-defaults.
104 · --plugin-dir=path, -p path
106 The server plugin directory.
108 · --plugin-ini=file_name, -i file_name
110 The mysql_plugin configuration file. Relative path names are
112 interpreted relative to the current directory. If this option is
113 not given, the default is plugin.ini in the plugin directory, where
114 plugin is the plugin argument on the command line.
115 · --print-defaults, -P
117 Display the default values from the configuration file. This option
119 causes mysql_plugin to print the defaults for --basedir, --datadir,
120 and --plugin-dir if they are found in the configuration file. If no
121 value for a variable is found, nothing is shown.
122 With mysql_plugin, this option need not be given first on the
124 command line, unlike most other MariaDB programs that support
125 --print-defaults.
126 · --verbose, -v
128 Verbose mode. Print more information about what the program does.
130 This option can be used multiple times to increase the amount of
131 information.
132 · --version, -V
134 Display version information and exit.
136
138 Copyright © 1997, 2013, Oracle and/or its affiliates. All rights
139 reserved., 2013-2015 MariaDB Foundation
140 This documentation is free software; you can redistribute it and/or
142 modify it only under the terms of the GNU General Public License as
143 published by the Free Software Foundation; version 2 of the License.
144 This documentation is distributed in the hope that it will be useful,
146 but WITHOUT ANY WARRANTY; without even the implied warranty of
147 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
148 General Public License for more details.
149 You should have received a copy of the GNU General Public License along
151 with the program; if not, write to the Free Software Foundation, Inc.,
152 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA or see
153 http://www.gnu.org/licenses/.
154
157 For more information, please refer to the MariaDB Knowledge Base,
158 available online at https://mariadb.com/kb/
159
161 MariaDB Foundation (http://www.mariadb.org/).
162MariaDB 10.3 9 May 2017 MYSQL_PLUGIN(1)