1MYSQL_PLUGIN(1) MySQL Database System MYSQL_PLUGIN(1)
2
6 mysql_plugin - configure MySQL server plugins
7
9 mysql_plugin [options] plugin {ENABLE|DISABLE}
10
12 The mysql_plugin utility enables MySQL administrators to manage which
13 plugins a MySQL 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 mysql_plugin is available as of MySQL 5.5.16.
17 Depending on whether mysql_plugin is invoked to enable or disable
19 plugins, it inserts or deletes rows in the mysql.plugin table that
20 serves as a plugin registry. (To perform this operation, mysql_plugin
21 invokes the MySQL server in bootstrap mode. This means that the server
22 must not already be running.) For normal server startups, the server
23 loads and enables plugins listed in mysql.plugin automatically. For
24 additional control over plugin activation, use --plugin_name options
25 named for specific plugins, as described in Section 5.1.8.1,
26 “Installing and Uninstalling Plugins”.
27 Each invocation of mysql_plugin reads a configuration file to determine
29 how to configure the plugins contained in a single plugin library
30 object file. To invoke mysql_plugin, use this syntax:
31 mysql_plugin [options] plugin {ENABLE|DISABLE}
33 plugin is the name of the plugin to configure. ENABLE or DISABLE (not
35 case sensitive) specify whether to enable or disable components of the
36 plugin library named in the configuration file. The order of the plugin
37 and ENABLE or DISABLE arguments does not matter.
38 For example, to configure components of a plugin library file named
40 myplugins.so on Linux or myplugins.dll on Windows, specify a plugin
41 value of myplugins. Suppose that this plugin library contains three
42 plugins, plugin1, plugin2, and plugin3, all of which should be
43 configured under mysql_plugin control. By convention, configuration
44 files have a suffix of .ini and the same basename as the plugin
45 library, so the default configuration file name for this plugin library
46 is myplugins.ini. The configuration file contents look like this:
47 myplugins
49 plugin1
50 plugin2
51 plugin3
52 The first line in the myplugins.ini file is the name of the library
54 object file, without any extension such as .so or .dll. The remaining
55 lines are the names of the components to be enabled or disabled. Each
56 value in the file should be on a separate line. Lines on which the
57 first character is '#' are taken as comments and ignored.
58 To enable the plugins listed in the configuration file, invoke
60 mysql_plugin this way:
61 shell> mysql_plugin myplugins ENABLE
63 To disable the plugins, use DISABLE rather than ENABLE.
65 An error occurs if mysql_plugin cannot find the configuration file or
67 plugin library file, or if mysql_plugin cannot start the MySQL server.
68 mysql_plugin supports the following options, which can be specified on
70 the command line or in the [mysqld] group of any option file. For
71 options specified in a [mysqld] group, mysql_plugin recognizes the
72 --basedir, --datadir, and --plugin-dir options and ignores others. For
73 information about option files, see Section 4.2.3.3, “Using Option
74 Files”.
75 mysql_plugin Options
77 · --help, -?
79 Display a help message and exit.
81 · --basedir=path, -b path
83 The server base directory.
85 · --datadir=path, -d path
87 The server data directory.
89 · --my-print-defaults=path, -b path
91 The path to the my_print_defaults program.
93 · --mysqld=path, -b path
95 The path to the mysqld server.
97 · --no-defaults, -p
99 Do not read values from the configuration file. This option enables
101 an administrator to skip reading defaults from the configuration
102 file.
103 With mysql_plugin, this option need not be given first on the
105 command line, unlike most other MySQL programs that support
106 --no-defaults.
107 · --plugin-dir=path, -p path
109 The server plugin directory.
111 · --plugin-ini=file_name, -i file_name
113 The mysql_plugin configuration file. Relative path names are
115 interpreted relative to the current directory. If this option is
116 not given, the default is plugin.ini in the plugin directory, where
117 plugin is the plugin argument on the command line.
118 · --print-defaults, -P
120 Display the default values from the configuration file. This option
122 causes mysql_plugin to print the defaults for --basedir, --datadir,
123 and --plugin-dir if they are found in the configuration file. If no
124 value for a variable is found, nothing is shown.
125 With mysql_plugin, this option need not be given first on the
127 command line, unlike most other MySQL programs that support
128 --print-defaults.
129 · --verbose, -v
131 Verbose mode. Print more information about what the program does.
133 This option can be used multiple times to increase the amount of
134 information.
135 · --version, -V
137 Display version information and exit.
139
141 Copyright © 1997, 2013, Oracle and/or its affiliates. All rights
142 reserved.
143 This documentation is free software; you can redistribute it and/or
145 modify it only under the terms of the GNU General Public License as
146 published by the Free Software Foundation; version 2 of the License.
147 This documentation is distributed in the hope that it will be useful,
149 but WITHOUT ANY WARRANTY; without even the implied warranty of
150 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
151 General Public License for more details.
152 You should have received a copy of the GNU General Public License along
154 with the program; if not, write to the Free Software Foundation, Inc.,
155 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA or see
156 http://www.gnu.org/licenses/.
157
160 For more information, please refer to the MySQL Reference Manual, which
161 may already be installed locally and which is also available online at
162 http://dev.mysql.com/doc/.
163
165 Oracle Corporation (http://dev.mysql.com/).
166MySQL 5.5 01/16/2013 MYSQL_PLUGIN(1)