From 5798dbcc936fea1e168dffebbf26e25afb29d3fa Mon Sep 17 00:00:00 2001 From: Yasuhiro Horimoto Date: Fri, 17 May 2019 11:59:51 +0900 Subject: [PATCH] doc logical_range_filter: add a explanation for "order" parameter (#961) * doc logical_range_filter: add a explanation for "order" parameter * doc logical_range_filter: fix a expression in English for easy to read --- doc/files.am | 2 + doc/locale/ja/LC_MESSAGES/reference.po | 17 +++++ .../logical_range_filter/order_existent.log | 69 +++++++++++++++++++ .../commands/logical_range_filter.rst | 10 ++- 4 files changed, 97 insertions(+), 1 deletion(-) create mode 100644 doc/source/example/reference/commands/logical_range_filter/order_existent.log diff --git a/doc/files.am b/doc/files.am index c681ac4867..c90286603e 100644 --- a/doc/files.am +++ b/doc/files.am @@ -157,6 +157,7 @@ absolute_source_files = \ $(top_srcdir)/doc/source/example/reference/commands/logical_range_filter/logical_table_existent.log \ $(top_srcdir)/doc/source/example/reference/commands/logical_range_filter/logical_table_nonexistent.log \ $(top_srcdir)/doc/source/example/reference/commands/logical_range_filter/offset.log \ + $(top_srcdir)/doc/source/example/reference/commands/logical_range_filter/order_existent.log \ $(top_srcdir)/doc/source/example/reference/commands/logical_range_filter/output_columns.log \ $(top_srcdir)/doc/source/example/reference/commands/logical_range_filter/post_filter.log \ $(top_srcdir)/doc/source/example/reference/commands/logical_range_filter/sort_keys_on_shared_key.log \ @@ -1219,6 +1220,7 @@ source_files_relative_from_doc_dir = \ source/example/reference/commands/logical_range_filter/logical_table_existent.log \ source/example/reference/commands/logical_range_filter/logical_table_nonexistent.log \ source/example/reference/commands/logical_range_filter/offset.log \ + source/example/reference/commands/logical_range_filter/order_existent.log \ source/example/reference/commands/logical_range_filter/output_columns.log \ source/example/reference/commands/logical_range_filter/post_filter.log \ source/example/reference/commands/logical_range_filter/sort_keys_on_shared_key.log \ diff --git a/doc/locale/ja/LC_MESSAGES/reference.po b/doc/locale/ja/LC_MESSAGES/reference.po index 87316c5d72..d6331dbd9a 100644 --- a/doc/locale/ja/LC_MESSAGES/reference.po +++ b/doc/locale/ja/LC_MESSAGES/reference.po @@ -8494,6 +8494,23 @@ msgstr "" msgid "``order``" msgstr "" +msgid "" +"Specifies order of search result. Specify ``ascending`` or ``descending`` as " +"the value of this parameter." +msgstr "" +"検索結果の順序を指定します。``ascending`` もしくは ``descending`` を指定しま" +"す。" + +msgid "" +"If we set ``ascending`` in this parameter, search results are sorted by " +"ascending order based on ``shared_key``. If we set ``descending`` in this " +"parameter, search results are sorted by descending order based on " +"``shared_key``." +msgstr "" +"``ascending`` を設定した場合は、 ``shard_key`` を基準に検索結果は昇順に並べら" +"れます。``descending`` を設定した場合は、 ``shard_key`` を基準に検索結果は降" +"順に並べられます。" + msgid "" "Specifies the filter text that is processed after ``filtered`` stage dynamic " "columns are generated. You can use ``post_filter`` to filter by ``filtered`` " diff --git a/doc/source/example/reference/commands/logical_range_filter/order_existent.log b/doc/source/example/reference/commands/logical_range_filter/order_existent.log new file mode 100644 index 0000000000..c5e75c233c --- /dev/null +++ b/doc/source/example/reference/commands/logical_range_filter/order_existent.log @@ -0,0 +1,69 @@ +Execution example:: + + logical_range_filter --logical_table Entries --shard_key created_at --order "descending" + # [ + # [ + # 0, + # 1557403984.311448, + # 0.0003597736358642578 + # ], + # [ + # [ + # [ + # "_key", + # "ShortText" + # ], + # [ + # "content", + # "Text" + # ], + # [ + # "created_at", + # "Time" + # ], + # [ + # "n_likes", + # "UInt32" + # ], + # [ + # "tag", + # "ShortText" + # ] + # ], + # [ + # "Good-bye Tritonn", + # "I also migrated all Tritonn system!", + # 1436371200, + # 3, + # "Senna" + # ], + # [ + # "Good-bye Senna", + # "I migrated all Senna system!", + # 1436367600, + # 3, + # "Senna" + # ], + # [ + # "Mroonga", + # "I also started to use Mroonga. It's also very fast! Really fast!", + # 1436288400, + # 15, + # "Groonga" + # ], + # [ + # "Groonga", + # "I started to use Groonga. It's very fast!", + # 1436284800, + # 10, + # "Groonga" + # ], + # [ + # "The first post!", + # "Welcome! This is my first post!", + # 1436281200, + # 5, + # "Hello" + # ] + # ] + # ] diff --git a/doc/source/reference/commands/logical_range_filter.rst b/doc/source/reference/commands/logical_range_filter.rst index 38105e2c2f..497b013fd7 100644 --- a/doc/source/reference/commands/logical_range_filter.rst +++ b/doc/source/reference/commands/logical_range_filter.rst @@ -279,7 +279,15 @@ TODO: Add examples ``order`` """""""""" -TODO +Specifies order of search result. +Specify ``ascending`` or ``descending`` as the value of this parameter. + +If we set ``ascending`` in this parameter, search results are sorted by ascending order based on ``shared_key``. +If we set ``descending`` in this parameter, search results are sorted by descending order based on ``shared_key``. + +.. groonga-command +.. include:: ../../example/reference/commands/logical_range_filter/order_existent.log +.. logical_range_filter --logical_table Entries --shard_key created_at --order "descending" .. _logical-range-filter-search-related-parameters: