2.9. その他#
このセクションではUNIX系の環境でMroongaをソースコードからインストールする方法を説明します。
2.9.1. 依存関係#
MroongaをビルドするためにはいくつかのツールとライブラリーとMySQLが必要です。MySQLの代わりにMariaDBを使うこともできます。
2.9.1.1. ツール#
必須のツール
wget
、curl
または Web ブラウザ(ソースアーカイブをダウンロードするため)tar
とgzip
(ソースアーカイブを展開するため)シェル(
dash
、bash
、zsh
など、どのようなシェルでもたぶん大丈夫)CコンパイラーとC++コンパイラー (
gcc
とg++
がサポート対象だが、他のコンパイラーでもたぶん大丈夫)CMake(クロスプラットフォームのビルドシステムとして利用するため)
Ninja(高速にビルドするため)
pkg-config(ライブラリを検出するため)
これらを用意してください。
あるとよいツール
sudo (ビルドしたGroongaをインストールするため)
2.9.1.2. ライブラリー#
必須のライブラリー
Groonga 。(もしパッケージを使うなら、開発用パッケージをインストールしてください。debなら
libgroonga-dev
で、RPMならgroonga-devel
です。)
あるとよいライブラリー
MeCab: 日本語形態素解析器
注釈
形態素単位でトークナイズした全文検索索引を使用したい場合は、Groongaのインストール前に MeCabをインストールしてください。
2.9.1.3. MySQL#
Mroongaはインストール済みのMySQLだけでなくMySQLのソースとビルドディレクトリーも必要です。そのため、MySQLのパッケージを使うことはできません。MySQLのパッケージはMySQLのソースとビルドディレクトリーを提供していないからです。MySQLのソースとビルドディレクトリーが必要です!
MySQLの代わりにMariaDBを使う場合でもMariaDBのソースが必要です。
MySQL 8.4最新版のソースコードをダウンロードし、ビルド&インストールして下さい。
こちらのDownload MySQL Community Server を参照して下さい。
mysql-8.4.1を使用し、以下にソースディレクトリが展開されているものと仮定します。
$HOME/local/src/mysql-8.4.1
次のディレクトリーでビルドします。
$HOME/local/build/mysql-8.4.1
次のコマンドラインはMySQLをビルド・インストールするコマンドラインです。
% cmake \
-S $HOME/local/src/mysql-8.4.1 \
-B $HOME/local/build/mysql-8.4.1 \
-GNinja \
-DCMAKE_INSTALL_PREFIX=$HOME/local
% cmake --build $HOME/local/build/mysql-8.4.1
% cmake --install $HOME/local/build/mysql-8.4.1
MySQLのバイナリが以下にインストールされているものと仮定します。
$HOME/local
2.9.2. ソースからビルド#
MroongaはGNUビルドシステムを使っています。以下は一番簡単なビルド手順です。
% wget https://packages.groonga.org/source/mroonga/mroonga-6.12.tar.gz
% tar xvzf mroonga-6.12.tar.gz
% cd mroonga-6.12
% ./configure \
--with-mysql-source=$HOME/local/src/mysql-8.4.1 \
--with-mysql-build=$HOME/local/build/mysql-8.4.1 \
--with-mysql-config=$HOME/local/bin/mysql_config
% make
% sudo make install
% $HOME/local/bin/mysql -u root < /usr/local/share/mroonga/install.sql
次のことを configure
で指定しなければいけません。
--with-mysql-source
でMySQLのソースコードがあるディレクトリーを指定します。--with-mysql-build
でMySQLのビルドディレクトリーを指定します。--with-mysql-config
でmysql_config
コマンドのパスを指定します。
SHOW ENGINES
SQLを実行することでMroongaが正常にインストールされているかを確認できます。 Mroonga
という行があればMroongaは正常にインストールされています。
mysql> SHOW ENGINES;
+------------+---------+------------------------------------------------------------+--------------+------+------------+
| Engine | Support | Comment | Transactions | XA | Savepoints |
+------------+---------+------------------------------------------------------------+--------------+------+------------+
| Mroonga | YES | Fulltext search, column base | NO | NO | NO |
| MRG_MYISAM | YES | Collection of identical MyISAM tables | NO | NO | NO |
| CSV | YES | CSV storage engine | NO | NO | NO |
| MyISAM | DEFAULT | Default engine as of MySQL 3.23 with great performance | NO | NO | NO |
| InnoDB | YES | Supports transactions, row-level locking, and foreign keys | YES | YES | YES |
| MEMORY | YES | Hash based, stored in memory, useful for temporary tables | NO | NO | NO |
+------------+---------+------------------------------------------------------------+--------------+------+------------+
6 rows in set (0.00 sec)
以下、それぞれの手順の詳細を説明します。
2.9.2.1. configure
#
まず configure
を実行します。重要な configure
の引数は以下の通りです。
2.9.2.1.1. --with-mysql-source=PATH
#
MYSQLのソースコードがあるディレクトリーを指定します。
これは必須の引数です。
% ./configure \
--with-mysql-source=$HOME/local/src/mysql-8.4.1 \
--with-mysql-config=$HOME/local/bin/mysql_config
2.9.2.1.2. --with-mysql-build=PATH
#
MySQLのソースコードをビルドしたディレクトリーを指定します。
MySQLのソースコードがあるディレクトリーでビルドした場合はこの引数を指定する必要はありません。他のディレクトリーでビルドしたときはこの引数を指定する必要があります。
以下は $HOME/local/build/mysql-8.4.1
でMySQLをビルドした時の例です。
% ./configure \
--with-mysql-source=$HOME/local/src/mysql-8.4.1 \
--with-mysql-build=$HOME/local/build/mysql-8.4.1 \
--with-mysql-config=$HOME/local/bin/mysql_config
2.9.2.1.3. --with-mysql-config=PATH
#
mysql_config
コマンドのパスを指定します。
mysql_config
コマンドが PATH
から探索可能であればこの引数を指定する必要はありません。例えば、 mysql_config
が /usr/bin/mysql_config
にある場合はこの引数を指定する必要はありません。
% ./configure \
--with-mysql-source=$HOME/local/src/mysql-8.4.1
2.9.2.1.4. --with-default-tokenizer=TOKENIZER
#
全文検索用のデフォルトのトークナイザーを指定します。この値はmy.cnfでもカスタマイズできます。
デフォルト値は TokenBigram
です。
デフォルトのトークナイザーとして TokenMecab
を使う例です。
% ./configure \
--with-mysql-source=$HOME/local/src/mysql-8.4.1 \
--with-mysql-config=$HOME/local/bin/mysql_config \
--with-default-tokenizer=TokenMecab
2.9.2.1.5. --prefix=PATH
#
インストール先となるディレクトリを指定します。Mroonga関連のファイルは ha_mroonga.so
を除いて ${PATH}/
ディレクトリ以下にインストールされます。 ha_mroonga.so
はMySQLのプラグインファイルです。これはMySQLのプラグインディレクトリーにインストールされます。
デフォルトは /usr/local
です。この場合、Mroongaをインストールするために使う install.sql
は /usr/local/share/mroonga/install.sql
にインストールされます。
以下はシステム全体にMroongaをインストールするのではなく、ユーザーが個人で使う目的で $HOME/local
にインストールする例です。
% ./configure \
--prefix=$HOME/local \
--with-mysql-source=$HOME/local/src/mysql-8.4.1 \
--with-mysql-config=$HOME/local/bin/mysql_config
2.9.2.1.6. PKG_CONFIG_PATH=PATH
#
これは configure
の引数ではありませんが、Groongaを標準的な場所にインストールしていないユーザーのために説明します。
Groongaを /usr/lib
など標準のパス以外にインストールした場合は PKG_CONFIG_PATH
を指定する必要があります。例えば、 ーーprefix=$HOME/local
でGroongaをインストールした場合は以下のようにします。
./configure \
PKG_CONFIG_PATH=$HOME/local/lib/pkgconfig \
--with-mysql-source=$HOME/local/src/mysql-8.4.1 \
--with-mysql-config=$HOME/local/bin/mysql_config
2.9.2.2. make
#
configure
が成功したら make
でMroongaをビルドします。
% make
マルチコアCPUを使っている場合は -j
オプションを使うとより速くmakeを実行できます。もし、4コアのCPUを使っている場合は、 -j4
オプションを使うともっと速くビルドできます。
% make -j4
make
で何かエラーが発生した場合は、そのエラーをレポートしてください: 見つけたバグを報告するには
2.9.2.3. make install
#
これでビルドしたMroongaをインストールできます!
% sudo make install
${PREFIX}
とMySQLのプラグインディレクトリーへの書き込み権限がある場合は sudo
を使う必要はありません。例えば、 --prefix=$HOME/local
と指定した場合です。この場合は make install
を使ってください。
% make install
2.9.2.4. mysql -u root < install.sql
#
MroongaをMySQLに登録するために INSTALL PLUGIN
や CREATE FUNCTION
といったSQLを実行する必要があります。これらのSQLは ${PREFIX}/share/mroonga/install.sql
に書かれています。
以下は configure
に --prefix=$HOME/local
と指定した場合の例です。
% mysql -u root < $HOME/local/share/mroonga/install.sql
2.9.2.5. uninstall Mroonga
#
Mroongaを削除したい場合は、以下のコマンドを入力して下さい。
% mysql < ${PREFIX}/share/mroonga/uninstall.sql
% cd ${MROONGA_BUILD_DIR}
% sudo make uninstall