man pages section 1: User Commands

Exit Print View

Updated: July 2014

mysql_plugin (1)


mysql_plugin - configure MySQL server plugins


mysql_plugin [options] plugin {ENABLE|DISABLE}


MySQL Database System                             MYSQL_PLUGIN(1)

     mysql_plugin - configure MySQL server plugins

     mysql_plugin [options] plugin {ENABLE|DISABLE}

     The mysql_plugin utility enables MySQL administrators to
     manage which plugins a MySQL 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.  mysql_plugin is available as
     of MySQL 5.5.16.

     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 MySQL
     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, as described in Section, "Installing and
     Uninstalling 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 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:


MySQL 5.5            Last change: 03/22/2013                    1

MySQL Database System                             MYSQL_PLUGIN(1)


     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 MySQL 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. For information
     about option files, see Section, "Using Option

     o   --help, -?

         Display a help message and exit.

     o   --basedir=path, -b path

         The server base directory.

     o   --datadir=path, -d path

         The server data directory.

     o   --my-print-defaults=path, -b path

         The path to the my_print_defaults program.

     o   --mysqld=path, -b path

         The path to the mysqld server.

     o   --no-defaults, -p

         Do not read values from the configuration file. This

MySQL 5.5            Last change: 03/22/2013                    2

MySQL Database System                             MYSQL_PLUGIN(1)

         option enables an administrator to skip reading defaults
         from the configuration file.

         With mysql_plugin, this option need not be given first
         on the command line, unlike most other MySQL programs
         that support --no-defaults.

     o   --plugin-dir=path, -p path

         The server plugin directory.

     o   --plugin-ini=file_name, -i file_name

         The mysql_plugin configuration file. Relative path names
         are interpreted relative to the current directory. If
         this option is not given, the default is plugin.ini in
         the plugin directory, where plugin is the plugin
         argument on the command line.

     o   --print-defaults, -P

         Display the default values from the configuration file.
         This option causes mysql_plugin to print the defaults
         for --basedir, --datadir, and --plugin-dir if they are
         found in the configuration file. If no value for a
         variable is found, nothing is shown.

         With mysql_plugin, this option need not be given first
         on the command line, unlike most other MySQL programs
         that support --print-defaults.

     o   --verbose, -v

         Verbose mode. Print more information about what the
         program does. This option can be used multiple times to
         increase the amount of information.

     o   --version, -V

         Display version information and exit.

     Copyright (C) 1997, 2013, Oracle and/or its affiliates. All
     rights reserved.

     This software and related documentation are provided under a
     license agreement containing restrictions on use and
     disclosure and are protected by intellectual property laws.
     Except as expressly permitted in your license agreement or
     allowed by law, you may not use, copy, reproduce, translate,
     broadcast, modify, license, transmit, distribute, exhibit,
     perform, publish, or display any part, in any form, or by

MySQL 5.5            Last change: 03/22/2013                    3

MySQL Database System                             MYSQL_PLUGIN(1)

     any means. Reverse engineering, disassembly, or
     decompilation of this software, unless required by law for
     interoperability, is prohibited.

     The information contained herein is subject to change
     without notice and is not warranted to be error-free. If you
     find any errors, please report them to us in writing.

     If this software or related documentation is delivered to
     the U.S. Government or anyone licensing it on behalf of the
     U.S. Government, the following notice is applicable:

     U.S. GOVERNMENT RIGHTS Programs, software, databases, and
     related documentation and technical data delivered to U.S.
     Government customers are "commercial computer software" or
     "commercial technical data" pursuant to the applicable
     Federal Acquisition Regulation and agency-specific
     supplemental regulations. As such, the use, duplication,
     disclosure, modification, and adaptation shall be subject to
     the restrictions and license terms set forth in the
     applicable Government contract, and, to the extent
     applicable by the terms of the Government contract, the
     additional rights set forth in FAR 52.227-19, Commercial
     Computer Software License (December 2007). Oracle USA, Inc.,
     500 Oracle Parkway, Redwood City, CA 94065.

     This software is developed for general use in a variety of
     information management applications. It is not developed or
     intended for use in any inherently dangerous applications,
     including applications which may create a risk of personal
     injury. If you use this software in dangerous applications,
     then you shall be responsible to take all appropriate fail-
     safe, backup, redundancy, and other measures to ensure the
     safe use of this software. Oracle Corporation and its
     affiliates disclaim any liability for any damages caused by
     use of this software in dangerous applications.

     Oracle is a registered trademark of Oracle Corporation
     and/or its affiliates. MySQL is a trademark of Oracle
     Corporation and/or its affiliates, and shall not be used
     without Oracle's express written authorization. Other names
     may be trademarks of their respective owners.

     This software and documentation may provide access to or
     information on content, products, and services from third
     parties. Oracle Corporation and its affiliates are not
     responsible for and expressly disclaim all warranties of any
     kind with respect to third-party content, products, and
     services. Oracle Corporation and its affiliates will not be
     responsible for any loss, costs, or damages incurred due to
     your access to or use of third-party content, products, or

MySQL 5.5            Last change: 03/22/2013                    4

MySQL Database System                             MYSQL_PLUGIN(1)

     This document in any form, software or printed matter,
     contains proprietary information that is the exclusive
     property of Oracle. Your access to and use of this material
     is subject to the terms and conditions of your Oracle
     Software License and Service Agreement, which has been
     executed and with which you agree to comply. This document
     and information contained herein may not be disclosed,
     copied, reproduced, or distributed to anyone outside Oracle
     without prior written consent of Oracle or as specifically
     provided below. This document is not part of your license
     agreement nor can it be incorporated into any contractual
     agreement with Oracle or its subsidiaries or affiliates.

     This documentation is NOT distributed under a GPL license.
     Use of this documentation is subject to the following terms:

     You may create a printed copy of this documentation solely
     for your own personal use. Conversion to other formats is
     allowed as long as the actual content is not altered or
     edited in any way. You shall not publish or distribute this
     documentation in any form or on any media, except if you
     distribute the documentation in a manner similar to how
     Oracle disseminates it (that is, electronically for download
     on a Web site with the software) or on a CD-ROM or similar
     medium, provided however that the documentation is
     disseminated together with the software on the same medium.
     Any other use, such as any dissemination of printed copies
     or use of this documentation, in whole or in part, in
     another publication, requires the prior written consent from
     an authorized representative of Oracle. Oracle and/or its
     affiliates reserve any and all rights to this documentation
     not expressly granted above.

     For more information on the terms of this license, or for
     details on how the MySQL documentation is built and
     produced, please visit blue]MySQL Contact & Questions].

     For additional licensing information, including licenses for
     third-party libraries used by MySQL products, see Preface
     and Legal Notices.

     For help with using MySQL, please visit either the
     blue]MySQL Forums] or blue]MySQL Mailing Lists] where you
     can discuss your issues with other MySQL users.

     For additional documentation on MySQL products, including
     translations of the documentation into other languages, and
     downloadable versions in variety of formats, including HTML
     and PDF formats, see the blue]MySQL Documentation Library].

MySQL 5.5            Last change: 03/22/2013                    5

MySQL Database System                             MYSQL_PLUGIN(1)

     See attributes(5) for descriptions of the following

     |Availability   | database/mysql-55 |
     |Stability      | Uncommitted       |
     For more information, please refer to the MySQL Reference
     Manual, which may already be installed locally and which is
     also available online at

     Oracle Corporation (

     This software was built from source available at  The original
     community source was downloaded from

     Further information about this software can be found on the
     open source community website at

MySQL 5.5            Last change: 03/22/2013                    6