Kouhei Sutou
null+****@clear*****
Fri Sep 27 11:51:52 JST 2013
Kouhei Sutou 2013-09-27 11:51:52 +0900 (Fri, 27 Sep 2013) New Revision: d85fba78945b0155776ddb7a9ac8add148c367fa https://github.com/groonga/groonga/commit/d85fba78945b0155776ddb7a9ac8add148c367fa Message: doc ruby_eval: describe return value structure in JSON section Modified files: doc/source/reference/commands/ruby_eval.txt Modified: doc/source/reference/commands/ruby_eval.txt (+7 -13) =================================================================== --- doc/source/reference/commands/ruby_eval.txt 2013-09-27 11:49:00 +0900 (089c3b4) +++ doc/source/reference/commands/ruby_eval.txt 2013-09-27 11:51:52 +0900 (8fb0dc1) @@ -50,27 +50,21 @@ It specifies the ruby script which you want to evaluate. Return value ------------ -``ruby_eval`` returns the evaluated result which key is "value" as json format:: +``ruby_eval`` returns the evaluated result with metadata such as +exception information (Including metadata isn't implemented yet):: - [HEADER, EVALUATED] + [HEADER, {"value": EVALUATED_VALUE}] ``HEADER`` See :doc:`/reference/command/output_format` about ``HEADER``. -``EVALUATED`` +``EVALUATED_VALUE`` - ``EVALUATED`` consists of pair of key and value in forms of {key:value}. + ``EVALUATED_VALUE`` is the evaludated value of ``ruby_script``. - .. list-table:: - :header-rows: 1 - - * - Name - - Description - * - ``key`` - - reserved word 'value'. - * - ``value`` - - the value of evaluated script. It must be a number. + ``ruby_eval`` supports only a number for evaluated value for now. + Supported types will be increased in the future. See also -------- -------------- next part -------------- HTML����������������������������...Download