Masafumi Yokoyama
null+****@clear*****
Thu Jun 25 15:02:49 JST 2015
Masafumi Yokoyama 2015-06-25 15:02:49 +0900 (Thu, 25 Jun 2015) New Revision: 70b0c78575ca721c1b2a6bc9e44eb1daa432f178 https://github.com/groonga/groonga/commit/70b0c78575ca721c1b2a6bc9e44eb1daa432f178 Message: doc: add logical_table_select document TODO: add description about summary, usage and return value Added files: doc/source/reference/commands/logical_table_select.rst Added: doc/source/reference/commands/logical_table_select.rst (+100 -0) 100644 =================================================================== --- /dev/null +++ doc/source/reference/commands/logical_table_select.rst 2015-06-25 15:02:49 +0900 (5972d73) @@ -0,0 +1,100 @@ +.. -*- rst -*- + +.. highlightlang:: none + +.. groonga-command +.. database: logical_table_select + +``logical_table_select`` +======================== + +Summary +------- + +.. note:: + + This command is an experimental feature. + +.. versionadded:: 5.0.5 + +TODO + +Syntax +------ + +``logical_table_select`` command has seven parameters. + +The required parameters are ``logical_table`` and ``shard_key``:: + + logical_table_select logical_table + shard_key + [min] + [min_border] + [max] + [max_border] + [filter] + +Usage +----- + +TODO + +Parameters +---------- + +This section describes parameters of ``logical_table_select``. + +Required parameter +^^^^^^^^^^^^^^^^^^ + +There are required parameters, ``logical_table`` and ``shard_key``. + +``logical_table`` +""""""""""""""""" + +Specifies logical table name. It means table name without "_YYYYMMDD" postfix. +If you use actual table such as "Logs_20150203", "Logs_20150203" and so on, logical table name is "Logs". + +``shard_key`` +""""""""""""" + +Specifies column name which is treated as shared key in each parted table. + +Optional parameters +^^^^^^^^^^^^^^^^^^^ + +There are optional parameters. + +``min`` +""""""" + +Specifies the min value of ``shard_key`` + +``min_border`` +"""""""""""""" + +Specifies whether the min value of borderline must be include or not. +Specify ``include`` or ``exclude`` as the value of this parameter. + +``max`` +""""""" + +Specifies the max value of ``shard_key``. + +``max_border`` +"""""""""""""" + +Specifies whether the max value of borderline must be include or not. +Specify ``include`` or ``exclude`` as the value of this parameter. + +``filter`` +"""""""""" + +Return value +------------ + +TODO: add more description for RESULTS + +:: + + [HEADER, RESULTS] -------------- next part -------------- HTML����������������������������...Download