Kouhei Sutou
null+****@clear*****
Wed Nov 21 17:52:12 JST 2012
Kouhei Sutou 2012-11-21 17:52:12 +0900 (Wed, 21 Nov 2012) New Revision: 89e490a481dc47f3ffcd4b401ad5e66790bc8aaf https://github.com/groonga/groonga/commit/89e490a481dc47f3ffcd4b401ad5e66790bc8aaf Log: doc: add about register command Added files: doc/source/example/reference/commands/register/query_expanders_tsv.log doc/source/reference/commands/register.txt Modified files: doc/Makefile.am Modified: doc/Makefile.am (+1 -0) =================================================================== --- doc/Makefile.am 2012-11-21 15:30:07 +0900 (074376f) +++ doc/Makefile.am 2012-11-21 17:52:12 +0900 (fea7643) @@ -11,6 +11,7 @@ include $(top_srcdir)/doc/files.am SOURCES = $(srcdir)/source update-examples: PATH=$(top_builddir)/src:$(top_builddir)/src/suggest:$$PATH \ + GRN_PLUGINS_DIR="$(top_builddir)/plugins" \ $(srcdir)/update_execution_example.py \ $(SOURCES) Added: doc/source/example/reference/commands/register/query_expanders_tsv.log (+4 -0) 100644 =================================================================== --- /dev/null +++ doc/source/example/reference/commands/register/query_expanders_tsv.log 2012-11-21 17:52:12 +0900 (cb2f067) @@ -0,0 +1,4 @@ +Execution example:: + + register query_expanders/tsv + # [[0, 1337566253.89858, 0.000355720520019531], true] Added: doc/source/reference/commands/register.txt (+59 -0) 100644 =================================================================== --- /dev/null +++ doc/source/reference/commands/register.txt 2012-11-21 17:52:12 +0900 (798cfda) @@ -0,0 +1,59 @@ +.. -*- rst -*- + +.. highlightlang:: none + +.. groonga-command +.. database: commands_register + +register +======== + +Summary +------- + +``register`` registers a plugin. You need to register a plugin before +you use a plugin. + +You need just one ``register`` for a plugin in the same database +because registered plugin information is written into the database. +When you restart your ``groonga`` process, ``groonga`` process loads +all registered plugins without ``register`` command. + +.. note:: + + Registered plugins can't be removed for now. + +Syntax +------ + +``register`` has a parameter ``path``. It is required parameter:: + + register path + +Usage +----- + +Here is a sample that registers ``QueryExpanderTSV`` query expander +that is included in +``${PREFIX}/lib/groonga/plugins/query_expanders/tsv.so``. + +.. groonga-command +.. include:: ../../example/reference/commands/register/query_expanders_tsv.log +.. register query_expanders/tsv + +You can omit ``${PREFIX}/lib/groonga/plugins/`` and suffix (``.so``). +They are completed automatically. + +You can specify absolute path such as ``register +/usr/lib/groonga/plugins/query_expanders/tsv.so``. + +Return value +------------ + +``register`` returns ``true`` as body on success such as:: + + [${COMMON_HEADER}, true] + +If ``register`` fails, error details are in ``COMMON_HEADER``. + +See XXX for ``COMMON_HEADER``. -------------- next part -------------- HTML����������������������������...Download
