Kouhei Sutou
null+****@clear*****
Fri Aug 14 15:19:25 JST 2015
Kouhei Sutou 2015-08-14 15:19:25 +0900 (Fri, 14 Aug 2015) New Revision: 4d5bcc9c780e86f72f9e945eb2aacbdddf079ab8 https://github.com/groonga/groonga/commit/4d5bcc9c780e86f72f9e945eb2aacbdddf079ab8 Message: doc: document logical_parameters Added files: doc/source/example/reference/commands/logical_parameters/range_index_always.log doc/source/example/reference/commands/logical_parameters/range_index_auto.log doc/source/example/reference/commands/logical_parameters/range_index_never.log doc/source/example/reference/commands/logical_parameters/usage_get.log doc/source/example/reference/commands/logical_parameters/usage_register.log doc/source/example/reference/commands/logical_parameters/usage_set.log Modified files: doc/source/reference/commands/logical_parameters.rst Added: doc/source/example/reference/commands/logical_parameters/range_index_always.log (+4 -0) 100644 =================================================================== --- /dev/null +++ doc/source/example/reference/commands/logical_parameters/range_index_always.log 2015-08-14 15:19:25 +0900 (1a39eff) @@ -0,0 +1,4 @@ +Execution example:: + + logical_parameters --range_index always + # [[0, 1337566253.89858, 0.000355720520019531], {"range_index": "auto"}] Added: doc/source/example/reference/commands/logical_parameters/range_index_auto.log (+4 -0) 100644 =================================================================== --- /dev/null +++ doc/source/example/reference/commands/logical_parameters/range_index_auto.log 2015-08-14 15:19:25 +0900 (f33192c) @@ -0,0 +1,4 @@ +Execution example:: + + logical_parameters --range_index auto + # [[0, 1337566253.89858, 0.000355720520019531], {"range_index": "never"}] Added: doc/source/example/reference/commands/logical_parameters/range_index_never.log (+4 -0) 100644 =================================================================== --- /dev/null +++ doc/source/example/reference/commands/logical_parameters/range_index_never.log 2015-08-14 15:19:25 +0900 (f9b4aaa) @@ -0,0 +1,4 @@ +Execution example:: + + logical_parameters --range_index never + # [[0, 1337566253.89858, 0.000355720520019531], {"range_index": "always"}] Added: doc/source/example/reference/commands/logical_parameters/usage_get.log (+4 -0) 100644 =================================================================== --- /dev/null +++ doc/source/example/reference/commands/logical_parameters/usage_get.log 2015-08-14 15:19:25 +0900 (69b92c5) @@ -0,0 +1,4 @@ +Execution example:: + + logical_parameters + # [[0, 1337566253.89858, 0.000355720520019531], {"range_index": "auto"}] Added: doc/source/example/reference/commands/logical_parameters/usage_register.log (+4 -0) 100644 =================================================================== --- /dev/null +++ doc/source/example/reference/commands/logical_parameters/usage_register.log 2015-08-14 15:19:25 +0900 (6315f95) @@ -0,0 +1,4 @@ +Execution example:: + + plugin_register sharding + # [[0, 1337566253.89858, 0.000355720520019531], true] Added: doc/source/example/reference/commands/logical_parameters/usage_set.log (+4 -0) 100644 =================================================================== --- /dev/null +++ doc/source/example/reference/commands/logical_parameters/usage_set.log 2015-08-14 15:19:25 +0900 (4e22cd3) @@ -0,0 +1,4 @@ +Execution example:: + + logical_parameters --range_index never + # [[0, 1337566253.89858, 0.000355720520019531], {"range_index": "auto"}] Modified: doc/source/reference/commands/logical_parameters.rst (+85 -11) =================================================================== --- doc/source/reference/commands/logical_parameters.rst 2015-08-14 15:15:33 +0900 (76a1917) +++ doc/source/reference/commands/logical_parameters.rst 2015-08-14 15:19:25 +0900 (40cee44) @@ -3,10 +3,10 @@ .. highlightlang:: none .. groonga-command -.. database: logical_parameters +.. database: commands_logical_parameters ``logical_parameters`` -======================== +====================== Summary ------- @@ -17,41 +17,115 @@ Summary .. versionadded:: 5.0.6 -TODO: Write summary +``logical_parameters`` is a command for test. Normally, you don't need +to use this command. + +``logical_parameters`` provides the following two features: + + * It returns the current parameters for ``logical_*`` commands. + * It sets new parameters for ``logical_*`` commands. + +Here is a list of parameters: + + * :ref:`logical-parameters-range-index` Syntax ------ - logical_parameters [range_index] +``logical_parameters`` has only one optional parameter:: + + logical_parameters [range_index=null] Usage ----- -Register ``sharding`` plugin to use ``logical_parameters`` command in advance. +You need to register ``sharding`` plugin to use ``logical_parameters`` +command: .. groonga-command +.. include:: ../../example/reference/commands/logical_parameters/usage_register.log .. plugin_register sharding +You can get the all current parameter values by calling without +parameters: + +.. groonga-command +.. include:: ../../example/reference/commands/logical_parameters/usage_get.log +.. logical_parameters + +You can set new values by calling with parameters: + +.. groonga-command +.. include:: ../../example/reference/commands/logical_parameters/usage_set.log +.. logical_parameters --range_index never + +``logical_parameters`` returns the parameter values before new values +are set when you set new values. + Parameters ---------- This section describes parameters of ``logical_parameters``. +Required parameters +^^^^^^^^^^^^^^^^^^^ + +There is no required parameters. + Optional parameters ^^^^^^^^^^^^^^^^^^^ -There are optional parameters. +There is one optional parameter. + +.. _logical-parameters-range-index: ``range_index`` -""""""""""""""""" +""""""""""""""" + +Specifies how to use range index in :doc:`logical_range_filter` by +keyword. + +Here are available keywords: + + * ``auto`` (default) + * ``always`` + * ``never`` + +If ``auto`` is specified, range index is used only when it'll be +efficient. This is the default value. + +.. groonga-command +.. include:: ../../example/reference/commands/logical_parameters/range_index_auto.log +.. logical_parameters --range_index auto -TODO +If ``always`` is specified, range index is always used. It'll be +useful for testing a case that range index is used. + +.. groonga-command +.. include:: ../../example/reference/commands/logical_parameters/range_index_always.log +.. logical_parameters --range_index always + +If ``never`` is specified, range index is never used. It'll be useful +for testing a case that range index isn't used. + +.. groonga-command +.. include:: ../../example/reference/commands/logical_parameters/range_index_never.log +.. logical_parameters --range_index never Return value ------------ -TODO +The command returns the current parameters for ``logical_*`` command:: + + [ + HEADER, + {"range_index": HOW_TO_USE_RANGE_INDEX} + ] + +``HOW_TO_USE_RANGE_INDEX`` value is one of the followings: -:: + * ``"auto"`` + * ``"always"`` + * ``"never"`` - [HEADER, {"range_index":"PARAMETER_NAME"}] +See :doc:`/reference/command/output_format` for ``HEADER``. -------------- next part -------------- HTML����������������������������...Download