[Groonga-commit] groonga/groonga at a803a90 [master] doc logical_select: describe min and min_border

Zurück zum Archiv-Index

Kouhei Sutou null+****@clear*****
Wed Jul 8 17:40:27 JST 2015


Kouhei Sutou	2015-07-08 17:40:27 +0900 (Wed, 08 Jul 2015)

  New Revision: a803a9047d09e7991d32ae5d630202539ab42372
  https://github.com/groonga/groonga/commit/a803a9047d09e7991d32ae5d630202539ab42372

  Message:
    doc logical_select: describe min and min_border

  Added files:
    doc/source/example/reference/commands/logical_select/min.log
    doc/source/example/reference/commands/logical_select/min_border.log
  Modified files:
    doc/source/reference/commands/logical_select.rst

  Added: doc/source/example/reference/commands/logical_select/min.log (+56 -0) 100644
===================================================================
--- /dev/null
+++ doc/source/example/reference/commands/logical_select/min.log    2015-07-08 17:40:27 +0900 (eee6214)
@@ -0,0 +1,56 @@
+Execution example::
+
+  logical_select \
+    --logical_table Entries \
+    --shard_key created_at \
+    --min "2015/07/09 00:00:00"
+  # [
+  #   [
+  #     0, 
+  #     1337566253.89858, 
+  #     0.000355720520019531
+  #   ], 
+  #   [
+  #     [
+  #       [
+  #         2
+  #       ], 
+  #       [
+  #         [
+  #           "_key", 
+  #           "ShortText"
+  #         ], 
+  #         [
+  #           "content", 
+  #           "Text"
+  #         ], 
+  #         [
+  #           "created_at", 
+  #           "Time"
+  #         ], 
+  #         [
+  #           "n_likes", 
+  #           "UInt32"
+  #         ], 
+  #         [
+  #           "tag", 
+  #           "ShortText"
+  #         ]
+  #       ], 
+  #       [
+  #         "Good-bye Senna", 
+  #         "I migrated all Senna system!", 
+  #         1436367600.0, 
+  #         3, 
+  #         "Senna"
+  #       ], 
+  #       [
+  #         "Good-bye Tritonn", 
+  #         "I also migrated all Tritonn system!", 
+  #         1436371200.0, 
+  #         3, 
+  #         "Senna"
+  #       ]
+  #     ]
+  #   ]
+  # ]

  Added: doc/source/example/reference/commands/logical_select/min_border.log (+50 -0) 100644
===================================================================
--- /dev/null
+++ doc/source/example/reference/commands/logical_select/min_border.log    2015-07-08 17:40:27 +0900 (3fc2728)
@@ -0,0 +1,50 @@
+Execution example::
+
+  logical_select \
+    --logical_table Entries \
+    --shard_key created_at \
+    --min "2015/07/09 00:00:00" \
+    --min_border "exclude"
+  # [
+  #   [
+  #     0, 
+  #     1337566253.89858, 
+  #     0.000355720520019531
+  #   ], 
+  #   [
+  #     [
+  #       [
+  #         1
+  #       ], 
+  #       [
+  #         [
+  #           "_key", 
+  #           "ShortText"
+  #         ], 
+  #         [
+  #           "content", 
+  #           "Text"
+  #         ], 
+  #         [
+  #           "created_at", 
+  #           "Time"
+  #         ], 
+  #         [
+  #           "n_likes", 
+  #           "UInt32"
+  #         ], 
+  #         [
+  #           "tag", 
+  #           "ShortText"
+  #         ]
+  #       ], 
+  #       [
+  #         "Good-bye Tritonn", 
+  #         "I also migrated all Tritonn system!", 
+  #         1436371200.0, 
+  #         3, 
+  #         "Senna"
+  #       ]
+  #     ]
+  #   ]
+  # ]

  Modified: doc/source/reference/commands/logical_select.rst (+40 -3)
===================================================================
--- doc/source/reference/commands/logical_select.rst    2015-07-08 17:29:48 +0900 (83e0df2)
+++ doc/source/reference/commands/logical_select.rst    2015-07-08 17:40:27 +0900 (4fcb5aa)
@@ -249,13 +249,50 @@ There are optional parameters.
 ``min``
 """""""
 
-Specifies the min value of ``shard_key``.
+Specifies the minimum value of ``shard_key`` column. If shard doesn't
+have any matched records, the shard isn't searched.
+
+For example, ``min`` is ``"2015/07/09 00:00:00"``, ``Entry_20150708``
+isn't searched. Because ``Entry_20150708`` has only records for
+``""2015/07/08"``.
+
+The following example only uses ``Entry_20150709``
+table. ``Entry_20150708`` isn't used.
+
+.. groonga-command
+.. include:: ../../example/reference/commands/logical_select/min.log
+.. logical_select \
+..   --logical_table Entries \
+..   --shard_key created_at \
+..   --min "2015/07/09 00:00:00"
 
 ``min_border``
 """"""""""""""
 
-Specifies whether the min value of borderline must be include or not.
-Specify ``include`` or ``exclude`` as the value of this parameter.
+Specifies whether the minimum value is include or not. Here is
+available values.
+
+.. list-table::
+   :header-rows: 1
+
+   * - Value
+     - Description
+   * - ``include``
+     - Includes ``min`` value. This is the default.
+   * - ``exclude``
+     - Doesn't include ``min`` value.
+
+Here is an example for ``exclude``. The result doesn't include the
+``"Good-bye Senna"`` record because its ``created_at`` value is
+``"2015/07/09 00:00:00"``.
+
+.. groonga-command
+.. include:: ../../example/reference/commands/logical_select/min_border.log
+.. logical_select \
+..   --logical_table Entries \
+..   --shard_key created_at \
+..   --min "2015/07/09 00:00:00" \
+..   --min_border "exclude"
 
 ``max``
 """""""
-------------- next part --------------
HTML����������������������������...
Download 



More information about the Groonga-commit mailing list
Zurück zum Archiv-Index