HAYASHI Kentaro
null+****@clear*****
Thu Oct 24 17:01:27 JST 2013
HAYASHI Kentaro 2013-10-24 17:01:27 +0900 (Thu, 24 Oct 2013) New Revision: 4322fcc48f72a4fd39b25f4b09d6cc6d9c9c8ed8 https://github.com/groonga/groonga/commit/4322fcc48f72a4fd39b25f4b09d6cc6d9c9c8ed8 Message: doc: add documentation about ruby_load Added files: doc/source/reference/commands/ruby_load.txt Modified files: doc/files.am Modified: doc/files.am (+4 -0) =================================================================== --- doc/files.am 2013-10-24 18:36:30 +0900 (021f338) +++ doc/files.am 2013-10-24 17:01:27 +0900 (5b722c7) @@ -402,6 +402,7 @@ absolute_source_files = \ $(top_srcdir)/doc/source/reference/commands/quit.txt \ $(top_srcdir)/doc/source/reference/commands/register.txt \ $(top_srcdir)/doc/source/reference/commands/ruby_eval.txt \ + $(top_srcdir)/doc/source/reference/commands/ruby_load.txt \ $(top_srcdir)/doc/source/reference/commands/select.txt \ $(top_srcdir)/doc/source/reference/commands/shutdown.txt \ $(top_srcdir)/doc/source/reference/commands/status.txt \ @@ -897,6 +898,7 @@ source_files_relative_from_doc_dir = \ source/reference/commands/quit.txt \ source/reference/commands/register.txt \ source/reference/commands/ruby_eval.txt \ + source/reference/commands/ruby_load.txt \ source/reference/commands/select.txt \ source/reference/commands/shutdown.txt \ source/reference/commands/status.txt \ @@ -1152,6 +1154,7 @@ html_files_relative_from_locale_dir = \ html/reference/commands/quit.html \ html/reference/commands/register.html \ html/reference/commands/ruby_eval.html \ + html/reference/commands/ruby_load.html \ html/reference/commands/select.html \ html/reference/commands/shutdown.html \ html/reference/commands/status.html \ @@ -1287,6 +1290,7 @@ html_files_relative_from_locale_dir = \ html/_sources/reference/commands/quit.txt \ html/_sources/reference/commands/register.txt \ html/_sources/reference/commands/ruby_eval.txt \ + html/_sources/reference/commands/ruby_load.txt \ html/_sources/reference/commands/select.txt \ html/_sources/reference/commands/shutdown.txt \ html/_sources/reference/commands/status.txt \ Added: doc/source/reference/commands/ruby_load.txt (+71 -0) 100644 =================================================================== --- /dev/null +++ doc/source/reference/commands/ruby_load.txt 2013-10-24 17:01:27 +0900 (157d5ef) @@ -0,0 +1,71 @@ +.. -*- rst -*- + +.. highlightlang:: none + +.. groonga-command +.. database: commands_ruby_load + +``ruby_load`` +============= + +Summary +------- + +``ruby_load`` command loads specified Ruby script. + +Syntax +------ + +``ruby_load`` has one required parameter:: + + ruby_load script_path + +Usage +----- + +You can load any script file which mruby supports by calling ``ruby_load``. + +Here is an example that just load ``expression.rb`` as Ruby script. + +.. groonga-command +.. include:: ../../example/reference/commands/ruby_load/load.log +.. register ruby/load +.. ruby_load "expression.rb" + +Register ``ruby/load`` plugin to use ``ruby_load`` command in advance. + +Note that ``ruby_load`` is implemented as an experimental plugin, +and the specification may be changed in the future. + +Parameters +---------- + +This section describes all parameters. + +``script_path`` +""""""""""""""" + +It specifies the Ruby script path which you want to load. + +Return value +------------ + +``ruby_load`` returns the loaded result with metadata such as +exception information (Including metadata isn't implemented yet):: + + [HEADER, {"value": LOADED_VALUE}] + +``HEADER`` + + See :doc:`/reference/command/output_format` about ``HEADER``. + +``LOADED_VALUE`` + + ``LOADED_VALUE`` is the loaded value of ruby script. + + ``ruby_load`` just return ``null`` as ``LOADED_VALUE`` for now, it will be supported in the future. + +See also +-------- + +:doc:`/reference/commands/ruby_eval` -------------- next part -------------- HTML����������������������������...ダウンロード
