分詞器プラグイン|V4.3.5|OceanBaseデータベース|OceanBaseデータベースドキュメント|分散データベース

分詞器プラグイン

最終更新日：2026-04-09 02:53:57 更新

本記事では、OceanBaseデータベースに分詞器プラグインをインストールし、使用する方法について説明します。分詞器プラグインは全文インデックス機能に使用され、特定のビジネスニーズに合わせてカスタマイズした分詞ロジックをサポートします。

注意

OceanBaseデータベースV4.3.5では、V4.3.5 BP1バージョンから分詞器プラグインがサポートされます。
現在の分詞器プラグインは実験的な機能であり、本番環境での使用は推奨されません。

前提条件

分割プラグインをインストールおよび使用する前に、以下の条件が満たされていることを確認してください：

オペレーティングシステムはyumパッケージ管理ツールをサポートしています。

説明

yumをサポートしていないシステムを使用している場合は、RPMパッケージを手動でダウンロードしたり、他のパッケージ管理ツールを使用したりするなど、他の方法で上記の依存関係をインストールできます。
OceanBaseデータベースクラスタが正常にデプロイされていること。
システムテナント権限を持っており、構成パラメータの変更やクラスタの再起動が可能であること。

操作手順

ステップ１：開発環境のインストール

分詞器プラグインの開発には、C/C++コンパイル環境とOceanBaseが提供するプラグイン開発ツールキットが必要です。以下のコマンドを実行して、C/C++開発環境とOceanBaseプラグイン開発パッケージをインストールします：

基本コンパイルツールをインストールします。

C/C++プログラムをコンパイルするために必要な基本ツールとライブラリがインストールされます。
```
yum install -y cmake make glibc-devel glibc-headers gcc gcc-c++
```
OceanBaseソフトウェアソースを設定します。

OceanBaseの公式ソフトウェアソースを追加することで、後でyumを使用してOceanBase関連のツールや依存関係をインストールできるようにします。
1. yum-utilsツールをインストールします。
```
yum install -y yum-utils
```
2. OceanBaseソフトウェアソースを追加します。
```
yum-config-manager --add-repo https://mirrors.aliyun.com/oceanbase/OceanBase.repo
```
プラグイン開発スイートをインストールします。
```
yum install -y oceanbase-plugin-dev-kit
```
インストール完了後、/usr/share/examples/ObPlugin/ftparser ディレクトリにOceanBase分詞器プラグインのサンプルコードファイル space_ftparser.cpp が表示されます。
```
ls /usr/share/examples/ObPlugin/ftparser
```
実行結果は次のとおりです：
```
CMakeLists.txt  space_ftparser.cpp
```

ステップ2：開発テンプレートの取得

OceanBase分詞器プラグインのサンプルコード space_ftparser.cpp を自分の開発ディレクトリにコピーすると、space_ftparser.cpp ファイルを変更して独自の分詞器プラグインを開発できます。

例：

[root@xxx packages]# cp /usr/share/examples/ObPlugin/ftparser/* /home/admin/test_plugin_dev

[root@xxx packages]# ls /home/admin/test_plugin_dev

実行結果は次のとおりです：

CMakeLists.txt  space_ftparser.cpp

サンプルコードの中核となるファイルは space_ftparser.cpp であり、ビジネスニーズに応じてこのファイルを変更することでカスタマイズされた分詞ロジックを実現できます。

ステップ3：プラグインのコンパイルとインストール

ビルド設定を修正します（CMakeLists.txt）。

サンプルコードのルートディレクトリには、CMakeLists.txt ファイルがあります。このファイルでは、「TODO」とマークされた部分を修正する必要があります。以下の部分が含まれます：
- PLUGIN_NAME：現在のプラグイン名であり、プロジェクトおよび生成される動的リンクライブラリの名前でもあります。必要な名前に変更してください。
- SOURCES：実装ファイルのリストで、CまたはC++ソースファイルを含むことができます。新しい実装ファイルを追加する場合は、ここにファイルパスを追加してください。ヘッダーファイルはこのリストに含めないように注意してください。
コンパイルを実行します。

以下の手順でコンパイルを実行します：
1. ワーカーディレクトリに移動します。
```
cd /your/work/path/ftparser
```
  分かち書きプラグイン開発ディレクトリに移動します。/your/work/path/ftparser を実際の開発ディレクトリパスに置き換えてください。
2. ビルドディレクトリを作成します。
```
mkdir -p build
```
  コンパイルプロセスで生成される中間ファイルと最終生成物を格納するために、build という名前のディレクトリを作成します。-p パラメータは、ディレクトリが既に存在していてもエラーが報告されないようにします。
3. ビルドディレクトリに移動します。
```
cd build
```
  作成したばかりの build ディレクトリに移動します。その後のコンパイル操作はこのディレクトリで行われ、ソースコードディレクトリをクリーンに保ちます。
4. ビルド環境を設定します。
```
cmake ..
```
  cmake コマンドを実行して、上級ディレクトリの CMakeLists.txt ファイルを読み取り、コンパイルに必要な Makefile ファイルを生成します。.. は、CMakeLists.txt ファイルが上級ディレクトリにあることを示します。
5. ソースコードをコンパイルします。
```
make
```
  make コマンドを実行して、生成された Makefile ファイルに基づいてソースコードをコンパイルし、動的リンクライブラリファイル（例えば libexample_ftparser.so）を生成します。
  
  コンパイルが成功すると、現在のディレクトリ（つまり build ディレクトリ）に動的リンクライブラリファイルが生成されます。
コンパイル生成物をコピーします。

コンパイルが完了すると、build ディレクトリに動的リンクライブラリファイル（例えば libexample_ftparser.so）が生成されます。このファイルをOceanBaseクラスタの各Observerノードの plugin_dir ディレクトリにコピーします。
```
cp libexample_ftparser.so /path/to/plugin_dir/
```
生成された動的リンクライブラリファイルをOceanBaseのプラグインディレクトリにコピーします。/path/to/plugin_dir/ を実際の plugin_dir パスに置き換えてください（システムパラメータ plugin_dir を照会して取得できます）。
プラグインをロードします。

システムテナントでOceanBaseデータベースにログインし、プラグインをロードするために構成パラメータ plugins_load を変更します：
```
ALTER SYSTEM SET plugins_load='libexample_ftparser.so';
```
クラスタを再起動して、プラグインを有効にします。
- OceanBaseデプロイメントツール（OBD）で管理されるOceanBaseクラスタの場合、次のコマンドを使用してクラスタを再起動できます。
```
obd cluster restart <cluster_name>
```
  <cluster_name> を実際のクラスタ名に置き換えてください。
- OceanBaseクラウドプラットフォーム（OCP）で管理されるクラスタの場合、OCP上で直接クラスタを再起動できます。

インストール済みの分かち書きプラグインを確認します。

select * from oceanbase.GV$OB_PLUGINS;

実行結果は次のとおりです：

+-----------+----------+------------------+--------+----------+------------------------+-----------------+------------------+-------------------+-----------------------+---------------+---------------------------------------------+
| SVR_IP    | SVR_PORT | NAME             | STATUS | TYPE     | LIBRARY                | LIBRARY_VERSION | LIBRARY_REVISION | INTERFACE_VERSION | AUTHOR                | LICENSE       | DESCRIPTION                                 |
+-----------+----------+------------------+--------+----------+------------------------+-----------------+------------------+-------------------+-----------------------+---------------+---------------------------------------------+
| 127.0.0.1 |    55801 | ngram            | READY  | FTPARSER | NULL                   | 1.0.0           | NULL             | 0.1.0             | OceanBase Corporation | Mulan PubL v2 | This is a ngram fulltext parser plugin.     |
| 127.0.0.1 |    55801 | beng             | READY  | FTPARSER | NULL                   | 1.0.0           | NULL             | 0.1.0             | OceanBase Corporation | Mulan PubL v2 | This is a basic english parser plugin.      |
| 127.0.0.1 |    55801 | space            | READY  | FTPARSER | NULL                   | 1.0.0           | NULL             | 0.1.0             | OceanBase Corporation | Mulan PubL v2 | This is a default whitespace parser plugin. |
| 127.0.0.1 |    55801 | example_ftparser | READY  | FTPARSER | libexample_ftparser.so | 1.0.0           | NULL             | 0.1.0             | OceanBase Corporation | Mulan PSL v2  | This is an example ftparser.                |
+-----------+----------+------------------+--------+----------+------------------------+-----------------+------------------+-------------------+-----------------------+---------------+---------------------------------------------+

ここで、LIBRARY が NULL の場合は組み込みの分かち書きプラグインであることを示します。

ステップ4：パーサー・プラグインのテスト

テーブルを作成し、WITH PARSER 句を使用してパーサー example_ftparser を指定します。

CREATE TABLE t_example(
    c1 INT,
    c2 VARCHAR(200),
    c3 TEXT,
    FULLTEXT INDEX (c2, c3) WITH PARSER example_ftparser
);

テーブルにテストデータを挿入します。

INSERT INTO t_example (c1, c2, c3) VALUES
    (1, 'Alice', 'Alice loves programming and enjoys long walks.'),
    (2, 'Bob', 'Bob is an avid reader and a coffee enthusiast.'),
    (3, 'Charlie', 'Charlie is a skilled musician who plays the guitar.'),
    (4, 'Diana', 'Diana is passionate about painting and arts.'),
    (5, 'Eve', 'Eve is a fitness coach and a healthy lifestyle advocate.');

キーワード loves を含むレコードをクエリします。

SELECT * FROM t_example WHERE MATCH(c2, c3) AGAINST ('loves') > 0;

実行結果は次のとおりです：

+------+-------+------------------------------------------------+
| c1   | c2    | c3                                             |
+------+-------+------------------------------------------------+
|    1 | Alice | Alice loves programming and enjoys long walks. |
+------+-------+------------------------------------------------+
1 row in set

キーワード reader を含むレコードをクエリします。

SELECT * FROM t_example WHERE MATCH(c2, c3) AGAINST ('reader') > 0;

実行結果は次のとおりです：

+------+------+------------------------------------------------+
| c1   | c2   | c3                                             |
+------+------+------------------------------------------------+
|    2 | Bob  | Bob is an avid reader and a coffee enthusiast. |
+------+------+------------------------------------------------+
1 row in set

パーシングスコアをテストします。

SELECT c1,
    MATCH (c2, c3) AGAINST ('he loves programming and reading') AS score,
    c2,
    c3
FROM t_example;

実行結果は次のとおりです：

+------+--------------------+---------+----------------------------------------------------------+
| c1   | score              | c2      | c3                                                       |
+------+--------------------+---------+----------------------------------------------------------+
|    1 |  2.665294094128556 | Alice   | Alice loves programming and enjoys long walks.           |
|    2 | 0.2849740932642488 | Bob     | Bob is an avid reader and a coffee enthusiast.           |
|    3 |                  0 | Charlie | Charlie is a skilled musician who plays the guitar.      |
|    4 | 0.2989130434782609 | Diana   | Diana is passionate about painting and arts.             |
|    5 | 0.2722772277227723 | Eve     | Eve is a fitness coach and a healthy lifestyle advocate. |
+------+--------------------+---------+----------------------------------------------------------+
5 rows in set

顧客事例

分詞器プラグイン

注意

前提条件

説明

操作手順

ステップ１：開発環境のインストール

ステップ2：開発テンプレートの取得

ステップ3：プラグインのコンパイルとインストール

ステップ4：パーサー・プラグインのテスト