INSTALL PLUGIN plugin_name SONAME 'plugin_library'

このステートメントは、プラグインをインストールします。

plugin_name は、ライブラリファイルに含まれているプラグイン宣言構造で定義されているプラグインの名前です。プラグイン名では大文字と小文字が区別されます。最大限の互換性を持たせるために、プラグイン名を、C ソースファイル、シェルコマンドライン、M4 および Bourne シェルスクリプト、SQL 環境などで使用されている ASCII 文字、数字、および下線に制限するようにしてください。

plugin_library は、プラグインコードを含む共有ライブラリの名前です。この名前には、ファイル名拡張子 (たとえば、libmyplugin.so または libmyplugin.dylib) が含まれます。

共有ライブラリは、プラグインディレクトリ (つまり、plugin_dir システム変数で指定されるディレクトリ) に存在する必要があります。ライブラリは、サブディレクトリではなく、プラグインディレクトリ自体に存在する必要があります。デフォルトでは、plugin_dir は、pkglibdir 設定変数で指定されるディレクトリの下にある plugin ディレクトリですが、サーバーの起動時に plugin_dir の値を設定することによって変更できます。たとえば、my.cnf ファイル内でその値を設定します。

[mysqld]
plugin_dir=/path/to/plugin/directory

plugin_dir の値が相対パス名である場合は、MySQL ベースディレクトリ (basedir システム変数の値) に相対的に取得されます。

INSTALL PLUGIN は、plugin を説明している mysql.plugin テーブルに行を追加します。このテーブルには、プラグイン名とライブラリファイル名が含まれています。

MySQL 5.1.33 の時点では、INSTALL PLUGIN を指定すると、サーバーはサーバーの起動中にオプション (my.cnf) ファイルを読み取ります。これにより、プラグインは、これらのファイルから関連する任意のオプションを取得できるようになります。プラグインをロードする前でも、オプションファイルにプラグインオプションを追加できます (loose 接頭辞が使用されている場合)。また、プラグインをアンインストールしたり、my.cnf を編集したり、プラグインをもう一度インストールしたりすることもできます。プラグインをこの方法で再起動すると、サーバーを再起動することなく新しいオプション値を指定できます。

MySQL 5.1.33 より前のバージョンでは、プラグインは、各オプションがデフォルト値に設定された状態で起動されます。

INSTALL PLUGIN はまた、プラグインコードをロードして初期化することにより、プラグインを使用可能な状態にします。プラグインは、使用可能になる前にプラグインが実行する必要のあるすべてのセットアップを処理する、初期化関数を実行することによって初期化されます。

INSTALL PLUGIN を使用するには、mysql.plugin テーブルに対する INSERT 権限が必要です。

サーバーの起動時に、サーバーは、mysql.plugin テーブルにリストされているすべてのプラグインをロードして初期化します。つまり、プラグインはサーバーが起動するたびにではなく、1 回だけ INSTALL PLUGIN によってインストールされます。起動時のプラグインのロードは、サーバーが --skip-grant-tables オプションで起動された場合は実行されません。

サーバーが停止するとき、サーバーは、ロードされているプラグインごとに初期化解除関数を実行して、各プラグインに任意の最終クリーンアップを実行するための変更を発生させます。

サーバーの起動時に個々のプラグインロードを制御するオプションについては、Server Options for Loading Plugins を参照してください。サーバーにシステムテーブルを読み取らないよう指示する --skip-grant-tables オプションが指定されたとき、1 回のサーバー起動時にプラグインをロードする必要がある場合は、--plugin-load オプションを使用します。Server Command Options を参照してください。

プラグインを完全に削除するには、UNINSTALL PLUGIN ステートメントを使用します。

インストールされているプラグインを表示するには、SHOW PLUGIN ステートメントを使用します。

プラグインライブラリを再コンパイルし、それを再インストールする必要がある場合は、次のどちらかの手順を使用できます。