7.3.50. register

バージョン 5.0.1 で非推奨: Use plugin_register instead.

7.3.50.1. 概要

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

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

注釈

Registered plugins can be removed since Groonga 5.0.1. Use plugin_unregister in such a case.

7.3.50.2. 構文

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

register path

7.3.50.3. 使い方

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

実行例:

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

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

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

7.3.50.4. 戻り値

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

[HEADER, true]

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

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