7.3.46. plugin_register — Groonga v16.0.5ドキュメント

本文へスキップ
`Ctrl`+`K`

# 7.3.46. `plugin_register`

Added in version 5.0.1.

## 7.3.46.1. 概要

`plugin_register` コマンドはプラグインを登録します。プラグインを使う前にプラグインを登録する必要があります。

同じデータベースに対しては1つのプラグインについて一度だけ `plugin_register` コマンドを実行すれば十分です。これは、登録されたプラグイン情報はデータベースに記録されているからです。 `groonga` プロセスを再起動したときは、 `register` コマンドを実行しなくてもすでに登録されているプラグインを読み込みます。

plugin_unregister でプラグインの登録を解除することができます。

## 7.3.46.2. 構文

このコマンドの引数は1つで必須です:

    plugin_register name

## 7.3.46.3. 使い方

これは `${PREFIX}/lib/groonga/plugins/query_expanders/tsv.so` に含まれている `QueryExpanderTSV` クエリー展開オブジェクトを登録する例です。

実行例:

    plugin_register query_expanders/tsv
    # [[0,1337566253.89858,0.000355720520019531],true]

`${PREFIX}/lib/groonga/plugins/` と拡張子（ `.so` ）は省略可能です。これらは自動で補完されます。

`plugin_register /usr/lib/groonga/plugins/query_expanders/tsv.so` というように絶対パスを指定することもできます。

## 7.3.46.4. 戻り値

`plugin_register` が成功したときは以下のようにボディは `true` になります:

    [HEADER, true]

`plugin_register` が失敗すると、エラーの詳細は `HEADER` に含まれます。

`HEADER` については 出力形式 を参照してください。

## 7.3.46.5. 参考

- plugin_unregister