1MARIADB-PLUGIN(1) MariaDB Database System MARIADB-PLUGIN(1)
2
6 mariadb-plugin - configure MariaDB server plugins (mysql_plugin is now
7 a symlink to mariadb-plugin)
8
10 mysql_plugin [options] plugin {ENABLE|DISABLE}
11
13 The mysql_plugin utility enables MariaDB administrators to manage which
14 plugins a MariaDB server loads. It provides an alternative to manually
15 specifying the --plugin-load option at server startup or using the
16 INSTALL PLUGIN and UNINSTALL PLUGIN statements at runtime.
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 MariaDB server in bootstrap mode. This means that the
22 server must not already be running.) For normal server startups, the
23 server loads and enables plugins listed in mysql.plugin automatically.
24 For additional control over plugin activation, use --plugin_name
25 options named for specific plugins.
26 Each invocation of mysql_plugin reads a configuration file to determine
28 how to configure the plugins contained in a single plugin library
29 object file. To invoke mysql_plugin, use this syntax:
30 mysql_plugin [options] plugin {ENABLE|DISABLE}
32 plugin is the name of the plugin to configure. ENABLE or DISABLE (not
34 case sensitive) specify whether to enable or disable components of the
35 plugin library named in the configuration file. The order of the plugin
36 and ENABLE or DISABLE arguments does not matter.
37 For example, to configure components of a plugin library file named
39 myplugins.so on Linux or myplugins.dll on Windows, specify a plugin
40 value of myplugins. Suppose that this plugin library contains three
41 plugins, plugin1, plugin2, and plugin3, all of which should be
42 configured under mysql_plugin control. By convention, configuration
43 files have a suffix of .ini and the same basename as the plugin
44 library, so the default configuration file name for this plugin library
45 is myplugins.ini. The configuration file contents look like this:
46 myplugins
48 plugin1
49 plugin2
50 plugin3
51 The first line in the myplugins.ini file is the name of the library
53 object file, without any extension such as .so or .dll. The remaining
54 lines are the names of the components to be enabled or disabled. Each
55 value in the file should be on a separate line. Lines on which the
56 first character is '#' are taken as comments and ignored.
57 To enable the plugins listed in the configuration file, invoke
59 mysql_plugin this way:
60 shell> mysql_plugin myplugins ENABLE
62 To disable the plugins, use DISABLE rather than ENABLE.
64 An error occurs if mysql_plugin cannot find the configuration file or
66 plugin library file, or if mysql_plugin cannot start the MariaDB
67 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.
73 mysql_plugin Options
75 • --help, -?
77 Display a help message and exit.
79 • --basedir=path, -b path
81 The server base directory.
83 • --datadir=path, -d path
85 The server data directory.
87 • --my-print-defaults=path, -b path
89 The path to the my_print_defaults program.
91 • --mysqld=path, -b path
93 The path to the mysqld server.
95 • --no-defaults, -p
97 Do not read values from the configuration file. This option enables
99 an administrator to skip reading defaults from the configuration
100 file.
101 With mysql_plugin, this option need not be given first on the
103 command line, unlike most other MariaDB programs that support
104 --no-defaults.
105 • --plugin-dir=path, -p path
107 The server plugin directory.
109 • --plugin-ini=file_name, -i file_name
111 The mysql_plugin configuration file. Relative path names are
113 interpreted relative to the current directory. If this option is
114 not given, the default is plugin.ini in the plugin directory, where
115 plugin is the plugin argument on the command line.
116 • --print-defaults, -P
118 Display the default values from the configuration file. This option
120 causes mysql_plugin to print the defaults for --basedir, --datadir,
121 and --plugin-dir if they are found in the configuration file. If no
122 value for a variable is found, nothing is shown.
123 With mysql_plugin, this option need not be given first on the
125 command line, unlike most other MariaDB programs that support
126 --print-defaults.
127 • --verbose, -v
129 Verbose mode. Print more information about what the program does.
131 This option can be used multiple times to increase the amount of
132 information.
133 • --version, -V
135 Display version information and exit.
137
139 Copyright © 1997, 2013, Oracle and/or its affiliates. All rights
140 reserved., 2013-2019 MariaDB Foundation
141 This documentation is free software; you can redistribute it and/or
143 modify it only under the terms of the GNU General Public License as
144 published by the Free Software Foundation; version 2 of the License.
145 This documentation is distributed in the hope that it will be useful,
147 but WITHOUT ANY WARRANTY; without even the implied warranty of
148 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
149 General Public License for more details.
150 You should have received a copy of the GNU General Public License along
152 with the program; if not, write to the Free Software Foundation, Inc.,
153 51 Franklin Street, Fifth Floor, Boston, MA 02110-1335 USA or see
154 http://www.gnu.org/licenses/.
155
158 For more information, please refer to the MariaDB Knowledge Base,
159 available online at https://mariadb.com/kb/
160
162 MariaDB Foundation (http://www.mariadb.org/).
163MariaDB 10.5 27 June 2019 MARIADB-PLUGIN(1)