Kouhei Sutou
null+****@clear*****
Mon Jan 23 11:49:29 JST 2017
Kouhei Sutou 2017-01-23 11:49:29 +0900 (Mon, 23 Jan 2017) New Revision: 279c2017a229e6aa18fc661fdf39fc1c0a4feec2 https://github.com/groonga/groonga/commit/279c2017a229e6aa18fc661fdf39fc1c0a4feec2 Message: doc logical_select select: sortby -> sort_keys Copied files: doc/source/example/reference/commands/select/drilldown_sort_keys_simple.log (from doc/source/example/reference/commands/select/drilldown_limit_negative.log) Modified files: doc/files.am doc/source/example/reference/commands/logical_select/drilldowns_label_calc_types.log doc/source/example/reference/commands/logical_select/drilldowns_label_keys.log doc/source/example/reference/commands/logical_select/drilldowns_label_limit.log doc/source/example/reference/commands/logical_select/drilldowns_label_offset.log doc/source/example/reference/commands/logical_select/drilldowns_label_output_columns.log doc/source/example/reference/commands/logical_select/logical_table_nonexistent.log doc/source/example/reference/commands/select/drilldown_limit_negative.log doc/source/example/reference/commands/select/drilldown_limit_simple.log doc/source/example/reference/commands/select/drilldown_offset_negative.log doc/source/example/reference/commands/select/drilldown_offset_simple.log doc/source/example/reference/commands/select/drilldowns_label_keys_multiple.log doc/source/example/reference/commands/select/drilldowns_label_output_columns_single_group_key.log doc/source/example/reference/commands/select/limit_simple.log doc/source/example/reference/commands/select/offset_negative.log doc/source/example/reference/commands/select/offset_simple.log doc/source/example/reference/commands/select/table_nonexistent.log doc/source/reference/commands/logical_select.rst doc/source/reference/commands/select.rst Renamed files: doc/source/example/reference/commands/logical_select/drilldown_sort_keys.log (from doc/source/example/reference/commands/logical_select/drilldown_sortby.log) doc/source/example/reference/commands/logical_select/drilldowns_label_sort_keys.log (from doc/source/example/reference/commands/logical_select/drilldowns_label_sortby.log) doc/source/example/reference/commands/logical_select/sort_keys.log (from doc/source/example/reference/commands/logical_select/sortby.log) Modified: doc/files.am (+9 -9) =================================================================== --- doc/files.am 2017-01-22 21:38:40 +0900 (2a5f103) +++ doc/files.am 2017-01-23 11:49:29 +0900 (1f9efb0) @@ -125,13 +125,13 @@ absolute_source_files = \ $(top_srcdir)/doc/source/example/reference/commands/logical_select/drilldown_limit.log \ $(top_srcdir)/doc/source/example/reference/commands/logical_select/drilldown_offset.log \ $(top_srcdir)/doc/source/example/reference/commands/logical_select/drilldown_output_columns.log \ - $(top_srcdir)/doc/source/example/reference/commands/logical_select/drilldown_sortby.log \ + $(top_srcdir)/doc/source/example/reference/commands/logical_select/drilldown_sort_keys.log \ $(top_srcdir)/doc/source/example/reference/commands/logical_select/drilldowns_label_calc_types.log \ $(top_srcdir)/doc/source/example/reference/commands/logical_select/drilldowns_label_keys.log \ $(top_srcdir)/doc/source/example/reference/commands/logical_select/drilldowns_label_limit.log \ $(top_srcdir)/doc/source/example/reference/commands/logical_select/drilldowns_label_offset.log \ $(top_srcdir)/doc/source/example/reference/commands/logical_select/drilldowns_label_output_columns.log \ - $(top_srcdir)/doc/source/example/reference/commands/logical_select/drilldowns_label_sortby.log \ + $(top_srcdir)/doc/source/example/reference/commands/logical_select/drilldowns_label_sort_keys.log \ $(top_srcdir)/doc/source/example/reference/commands/logical_select/filter.log \ $(top_srcdir)/doc/source/example/reference/commands/logical_select/limit.log \ $(top_srcdir)/doc/source/example/reference/commands/logical_select/logical_table_existent.log \ @@ -143,7 +143,7 @@ absolute_source_files = \ $(top_srcdir)/doc/source/example/reference/commands/logical_select/offset.log \ $(top_srcdir)/doc/source/example/reference/commands/logical_select/output_columns.log \ $(top_srcdir)/doc/source/example/reference/commands/logical_select/shard_key_existent.log \ - $(top_srcdir)/doc/source/example/reference/commands/logical_select/sortby.log \ + $(top_srcdir)/doc/source/example/reference/commands/logical_select/sort_keys.log \ $(top_srcdir)/doc/source/example/reference/commands/logical_select/usage_plugin_register.log \ $(top_srcdir)/doc/source/example/reference/commands/logical_select/usage_setup.log \ $(top_srcdir)/doc/source/example/reference/commands/logical_shard_list/logical_table.log \ @@ -213,7 +213,7 @@ absolute_source_files = \ $(top_srcdir)/doc/source/example/reference/commands/select/drilldown_output_columns_referenced_type_column_label.log \ $(top_srcdir)/doc/source/example/reference/commands/select/drilldown_output_columns_simple.log \ $(top_srcdir)/doc/source/example/reference/commands/select/drilldown_simple.log \ - $(top_srcdir)/doc/source/example/reference/commands/select/drilldown_sortby_simple.log \ + $(top_srcdir)/doc/source/example/reference/commands/select/drilldown_sort_keys_simple.log \ $(top_srcdir)/doc/source/example/reference/commands/select/drilldowns_label_keys_multiple.log \ $(top_srcdir)/doc/source/example/reference/commands/select/drilldowns_label_output_columns_single_group_key.log \ $(top_srcdir)/doc/source/example/reference/commands/select/filter_equal.log \ @@ -499,7 +499,7 @@ absolute_source_files = \ $(top_srcdir)/doc/source/example/tutorial/drilldown-limit.log \ $(top_srcdir)/doc/source/example/tutorial/drilldown-multiple-column.log \ $(top_srcdir)/doc/source/example/tutorial/drilldown-output-columns.log \ - $(top_srcdir)/doc/source/example/tutorial/drilldown-sortby.log \ + $(top_srcdir)/doc/source/example/tutorial/drilldown-sort_keys.log \ $(top_srcdir)/doc/source/example/tutorial/index-1.log \ $(top_srcdir)/doc/source/example/tutorial/index-2.log \ $(top_srcdir)/doc/source/example/tutorial/index-3.log \ @@ -1003,13 +1003,13 @@ source_files_relative_from_doc_dir = \ source/example/reference/commands/logical_select/drilldown_limit.log \ source/example/reference/commands/logical_select/drilldown_offset.log \ source/example/reference/commands/logical_select/drilldown_output_columns.log \ - source/example/reference/commands/logical_select/drilldown_sortby.log \ + source/example/reference/commands/logical_select/drilldown_sort_keys.log \ source/example/reference/commands/logical_select/drilldowns_label_calc_types.log \ source/example/reference/commands/logical_select/drilldowns_label_keys.log \ source/example/reference/commands/logical_select/drilldowns_label_limit.log \ source/example/reference/commands/logical_select/drilldowns_label_offset.log \ source/example/reference/commands/logical_select/drilldowns_label_output_columns.log \ - source/example/reference/commands/logical_select/drilldowns_label_sortby.log \ + source/example/reference/commands/logical_select/drilldowns_label_sort_keys.log \ source/example/reference/commands/logical_select/filter.log \ source/example/reference/commands/logical_select/limit.log \ source/example/reference/commands/logical_select/logical_table_existent.log \ @@ -1021,7 +1021,7 @@ source_files_relative_from_doc_dir = \ source/example/reference/commands/logical_select/offset.log \ source/example/reference/commands/logical_select/output_columns.log \ source/example/reference/commands/logical_select/shard_key_existent.log \ - source/example/reference/commands/logical_select/sortby.log \ + source/example/reference/commands/logical_select/sort_keys.log \ source/example/reference/commands/logical_select/usage_plugin_register.log \ source/example/reference/commands/logical_select/usage_setup.log \ source/example/reference/commands/logical_shard_list/logical_table.log \ @@ -1091,7 +1091,7 @@ source_files_relative_from_doc_dir = \ source/example/reference/commands/select/drilldown_output_columns_referenced_type_column_label.log \ source/example/reference/commands/select/drilldown_output_columns_simple.log \ source/example/reference/commands/select/drilldown_simple.log \ - source/example/reference/commands/select/drilldown_sortby_simple.log \ + source/example/reference/commands/select/drilldown_sort_keys_simple.log \ source/example/reference/commands/select/drilldowns_label_keys_multiple.log \ source/example/reference/commands/select/drilldowns_label_output_columns_single_group_key.log \ source/example/reference/commands/select/filter_equal.log \ Renamed: doc/source/example/reference/commands/logical_select/drilldown_sort_keys.log (+1 -1) 95% =================================================================== --- doc/source/example/reference/commands/logical_select/drilldown_sortby.log 2017-01-22 21:38:40 +0900 (54105d8) +++ doc/source/example/reference/commands/logical_select/drilldown_sort_keys.log 2017-01-23 11:49:29 +0900 (36c0d3f) @@ -6,7 +6,7 @@ Execution example:: --limit 0 \ --output_columns _id \ --drilldown tag \ - --drilldown_sortby -_nsubrecs,_key + --drilldown_sort_keys -_nsubrecs,_key # [ # [ # 0, Modified: doc/source/example/reference/commands/logical_select/drilldowns_label_calc_types.log (+4 -4) =================================================================== --- doc/source/example/reference/commands/logical_select/drilldowns_label_calc_types.log 2017-01-22 21:38:40 +0900 (7fae4e3) +++ doc/source/example/reference/commands/logical_select/drilldowns_label_calc_types.log 2017-01-23 11:49:29 +0900 (385ca65) @@ -5,10 +5,10 @@ Execution example:: --shard_key created_at \ --limit 0 \ --output_columns _id \ - --drilldown[tag].keys tag \ - --drilldown[tag].calc_types MAX,MIN,SUM,AVG \ - --drilldown[tag].calc_target n_likes \ - --drilldown[tag].output_columns _key,_nsubrecs,_max,_min,_sum,_avg + --drilldowns[tag].keys tag \ + --drilldowns[tag].calc_types MAX,MIN,SUM,AVG \ + --drilldowns[tag].calc_target n_likes \ + --drilldowns[tag].output_columns _key,_nsubrecs,_max,_min,_sum,_avg # [ # [ # 0, Modified: doc/source/example/reference/commands/logical_select/drilldowns_label_keys.log (+2 -2) =================================================================== --- doc/source/example/reference/commands/logical_select/drilldowns_label_keys.log 2017-01-22 21:38:40 +0900 (235a710) +++ doc/source/example/reference/commands/logical_select/drilldowns_label_keys.log 2017-01-23 11:49:29 +0900 (81e77f5) @@ -5,8 +5,8 @@ Execution example:: --shard_key created_at \ --limit 0 \ --output_columns _id \ - --drilldown[tag.n_likes].keys tag,n_likes \ - --drilldown[tag.n_likes].output_columns _value.tag,_value.n_likes,_nsubrecs + --drilldowns[tag.n_likes].keys tag,n_likes \ + --drilldowns[tag.n_likes].output_columns _value.tag,_value.n_likes,_nsubrecs # [ # [ # 0, Modified: doc/source/example/reference/commands/logical_select/drilldowns_label_limit.log (+2 -2) =================================================================== --- doc/source/example/reference/commands/logical_select/drilldowns_label_limit.log 2017-01-22 21:38:40 +0900 (b8f5aab) +++ doc/source/example/reference/commands/logical_select/drilldowns_label_limit.log 2017-01-23 11:49:29 +0900 (178e895) @@ -5,8 +5,8 @@ Execution example:: --shard_key created_at \ --limit 0 \ --output_columns _id \ - --drilldown[tag.n_likes].keys tag \ - --drilldown[tag.n_likes].limit 2 + --drilldowns[tag.n_likes].keys tag \ + --drilldowns[tag.n_likes].limit 2 # [ # [ # 0, Modified: doc/source/example/reference/commands/logical_select/drilldowns_label_offset.log (+2 -2) =================================================================== --- doc/source/example/reference/commands/logical_select/drilldowns_label_offset.log 2017-01-22 21:38:40 +0900 (17b6ed6) +++ doc/source/example/reference/commands/logical_select/drilldowns_label_offset.log 2017-01-23 11:49:29 +0900 (28e5f07) @@ -5,8 +5,8 @@ Execution example:: --shard_key created_at \ --limit 0 \ --output_columns _id \ - --drilldown[tag.n_likes].keys tag \ - --drilldown[tag.n_likes].offset 1 + --drilldowns[tag.n_likes].keys tag \ + --drilldowns[tag.n_likes].offset 1 # [ # [ # 0, Modified: doc/source/example/reference/commands/logical_select/drilldowns_label_output_columns.log (+2 -2) =================================================================== --- doc/source/example/reference/commands/logical_select/drilldowns_label_output_columns.log 2017-01-22 21:38:40 +0900 (7e3a2af) +++ doc/source/example/reference/commands/logical_select/drilldowns_label_output_columns.log 2017-01-23 11:49:29 +0900 (763ac2a) @@ -5,8 +5,8 @@ Execution example:: --shard_key created_at \ --limit 0 \ --output_columns _id \ - --drilldown[tag].keys tag \ - --drilldown[tag].output_columns _key,_nsubrecs + --drilldowns[tag].keys tag \ + --drilldowns[tag].output_columns _key,_nsubrecs # [ # [ # 0, Renamed: doc/source/example/reference/commands/logical_select/drilldowns_label_sort_keys.log (+3 -3) 85% =================================================================== --- doc/source/example/reference/commands/logical_select/drilldowns_label_sortby.log 2017-01-22 21:38:40 +0900 (8a88259) +++ doc/source/example/reference/commands/logical_select/drilldowns_label_sort_keys.log 2017-01-23 11:49:29 +0900 (c3ae27e) @@ -9,9 +9,9 @@ Execution example:: --max_border "exclude" \ --limit 0 \ --output_columns _id \ - --drilldown[tag.n_likes].keys tag,n_likes \ - --drilldown[tag.n_likes].output_columns _nsubrecs,_value.n_likes,_value.tag \ - --drilldown[tag.n_likes].sortby -_nsubrecs,_value.n_likes,_value.tag + --drilldowns[tag.n_likes].keys tag,n_likes \ + --drilldowns[tag.n_likes].output_columns _nsubrecs,_value.n_likes,_value.tag \ + --drilldowns[tag.n_likes].sort_keys -_nsubrecs,_value.n_likes,_value.tag # [ # [ # 0, Modified: doc/source/example/reference/commands/logical_select/logical_table_nonexistent.log (+3 -3) =================================================================== --- doc/source/example/reference/commands/logical_select/logical_table_nonexistent.log 2017-01-22 21:38:40 +0900 (b9f2d33) +++ doc/source/example/reference/commands/logical_select/logical_table_nonexistent.log 2017-01-23 11:49:29 +0900 (8e7502a) @@ -9,9 +9,9 @@ Execution example:: # "[logical_select] no shard exists: logical_table: <Nonexistent>: shard_key: <created_at>", # [ # [ - # "Groonga::Context.set_groonga_error", - # "lib/mrb/scripts/context.rb", - # 27 + # "Groonga::Sharding::LogicalSelectCommand::Executor.execute_search", + # "/home/kou/work/c/groonga.clean/plugins/sharding/logical_select.rb", + # 469 # ] # ] # ] Renamed: doc/source/example/reference/commands/logical_select/sort_keys.log (+1 -1) 98% =================================================================== --- doc/source/example/reference/commands/logical_select/sortby.log 2017-01-22 21:38:40 +0900 (c026cea) +++ doc/source/example/reference/commands/logical_select/sort_keys.log 2017-01-23 11:49:29 +0900 (f7ee7f4) @@ -7,7 +7,7 @@ Execution example:: --min_border "include" \ --max "2015/07/09 00:00:00" \ --max_border "exclude" \ - --sortby _key + --sort_keys _key # [ # [ # 0, Modified: doc/source/example/reference/commands/select/drilldown_limit_negative.log (+1 -1) =================================================================== --- doc/source/example/reference/commands/select/drilldown_limit_negative.log 2017-01-22 21:38:40 +0900 (80ef1ac) +++ doc/source/example/reference/commands/select/drilldown_limit_negative.log 2017-01-23 11:49:29 +0900 (d4540cc) @@ -4,7 +4,7 @@ Execution example:: --limit 0 \ --output_column _id \ --drilldown tag \ - --drilldown_sortby _key \ + --drilldown_sort_keys _key \ --drilldown_limit -1 # [ # [ Modified: doc/source/example/reference/commands/select/drilldown_limit_simple.log (+1 -1) =================================================================== --- doc/source/example/reference/commands/select/drilldown_limit_simple.log 2017-01-22 21:38:40 +0900 (2a57fe0) +++ doc/source/example/reference/commands/select/drilldown_limit_simple.log 2017-01-23 11:49:29 +0900 (fbfd01bc) @@ -4,7 +4,7 @@ Execution example:: --limit 0 \ --output_column _id \ --drilldown tag \ - --drilldown_sortby _key \ + --drilldown_sort_keys _key \ --drilldown_offset 1 \ --drilldown_limit 2 # [ Modified: doc/source/example/reference/commands/select/drilldown_offset_negative.log (+1 -1) =================================================================== --- doc/source/example/reference/commands/select/drilldown_offset_negative.log 2017-01-22 21:38:40 +0900 (f05231c) +++ doc/source/example/reference/commands/select/drilldown_offset_negative.log 2017-01-23 11:49:29 +0900 (6e0086c) @@ -4,7 +4,7 @@ Execution example:: --limit 0 \ --output_column _id \ --drilldown tag \ - --drilldown_sortby _key \ + --drilldown_sort_keys _key \ --drilldown_offset -2 # [ # [ Modified: doc/source/example/reference/commands/select/drilldown_offset_simple.log (+1 -1) =================================================================== --- doc/source/example/reference/commands/select/drilldown_offset_simple.log 2017-01-22 21:38:40 +0900 (bcb04f7) +++ doc/source/example/reference/commands/select/drilldown_offset_simple.log 2017-01-23 11:49:29 +0900 (ea77c2d) @@ -4,7 +4,7 @@ Execution example:: --limit 0 \ --output_column _id \ --drilldown tag \ - --drilldown_sortby _key \ + --drilldown_sort_keys _key \ --drilldown_offset 1 # [ # [ Copied: doc/source/example/reference/commands/select/drilldown_sort_keys_simple.log (+34 -4) 66% =================================================================== --- doc/source/example/reference/commands/select/drilldown_limit_negative.log 2017-01-22 21:38:40 +0900 (80ef1ac) +++ doc/source/example/reference/commands/select/drilldown_sort_keys_simple.log 2017-01-23 11:49:29 +0900 (140c493) @@ -3,9 +3,8 @@ Execution example:: select Entries \ --limit 0 \ --output_column _id \ - --drilldown tag \ - --drilldown_sortby _key \ - --drilldown_limit -1 + --drilldown 'tag, n_likes' \ + --drilldown_sort_keys '-_nsubrecs, _key' # [ # [ # 0, @@ -59,12 +58,43 @@ Execution example:: # 2 # ], # [ + # "Senna", + # 2 + # ], + # [ # "Hello", # 1 + # ] + # ], + # [ + # [ + # 4 # ], # [ - # "Senna", + # [ + # "_key", + # "UInt32" + # ], + # [ + # "_nsubrecs", + # "Int32" + # ] + # ], + # [ + # 3, # 2 + # ], + # [ + # 5, + # 1 + # ], + # [ + # 10, + # 1 + # ], + # [ + # 15, + # 1 # ] # ] # ] Modified: doc/source/example/reference/commands/select/drilldowns_label_keys_multiple.log (+2 -2) =================================================================== --- doc/source/example/reference/commands/select/drilldowns_label_keys_multiple.log 2017-01-22 21:38:40 +0900 (74a1c59) +++ doc/source/example/reference/commands/select/drilldowns_label_keys_multiple.log 2017-01-23 11:49:29 +0900 (a49606d) @@ -3,8 +3,8 @@ Execution example:: select Entries \ --limit -1 \ --output_column tag,n_likes \ - --drilldown[tag.n_likes].keys tag,n_likes \ - --drilldown[tag.n_likes].output_columns _value.tag,_value.n_likes,_nsubrecs + --drilldowns[tag.n_likes].keys tag,n_likes \ + --drilldowns[tag.n_likes].output_columns _value.tag,_value.n_likes,_nsubrecs # [ # [ # 0, Modified: doc/source/example/reference/commands/select/drilldowns_label_output_columns_single_group_key.log (+2 -2) =================================================================== --- doc/source/example/reference/commands/select/drilldowns_label_output_columns_single_group_key.log 2017-01-22 21:38:40 +0900 (e1772cc) +++ doc/source/example/reference/commands/select/drilldowns_label_output_columns_single_group_key.log 2017-01-23 11:49:29 +0900 (fec2765) @@ -3,8 +3,8 @@ Execution example:: select Entries \ --limit 0 \ --output_column _id \ - --drilldown[tag.n_likes].keys tag,n_likes \ - --drilldown[tag.n_likes].output_columns _value.tag,_value.n_likes + --drilldowns[tag.n_likes].keys tag,n_likes \ + --drilldowns[tag.n_likes].output_columns _value.tag,_value.n_likes # [ # [ # 0, Modified: doc/source/example/reference/commands/select/limit_simple.log (+1 -1) =================================================================== --- doc/source/example/reference/commands/select/limit_simple.log 2017-01-22 21:38:40 +0900 (ebb5713) +++ doc/source/example/reference/commands/select/limit_simple.log 2017-01-23 11:49:29 +0900 (ebbad76) @@ -1,6 +1,6 @@ Execution example:: - select Entries --sortby _id --offset 2 --limit 3 --output_columns _key + select Entries --sort_keys _id --offset 2 --limit 3 --output_columns _key # [ # [ # 0, Modified: doc/source/example/reference/commands/select/offset_negative.log (+1 -1) =================================================================== --- doc/source/example/reference/commands/select/offset_negative.log 2017-01-22 21:38:40 +0900 (6424107) +++ doc/source/example/reference/commands/select/offset_negative.log 2017-01-23 11:49:29 +0900 (b2b009e) @@ -1,6 +1,6 @@ Execution example:: - select Entries --sortby _id --offset -2 --output_columns _key + select Entries --sort_keys _id --offset -2 --output_columns _key # [ # [ # 0, Modified: doc/source/example/reference/commands/select/offset_simple.log (+1 -1) =================================================================== --- doc/source/example/reference/commands/select/offset_simple.log 2017-01-22 21:38:40 +0900 (3f16d75) +++ doc/source/example/reference/commands/select/offset_simple.log 2017-01-23 11:49:29 +0900 (d5345fa) @@ -1,6 +1,6 @@ Execution example:: - select Entries --sortby _id --offset 3 --output_columns _key + select Entries --sort_keys _id --offset 3 --output_columns _key # [ # [ # 0, Modified: doc/source/example/reference/commands/select/table_nonexistent.log (+3 -3) =================================================================== --- doc/source/example/reference/commands/select/table_nonexistent.log 2017-01-22 21:38:40 +0900 (8cc4d6e) +++ doc/source/example/reference/commands/select/table_nonexistent.log 2017-01-23 11:49:29 +0900 (519799f) @@ -6,12 +6,12 @@ Execution example:: # -22, # 1337566253.89858, # 0.000355720520019531, - # "invalid table name: <Nonexistent>", + # "[select][table] invalid name: <Nonexistent>", # [ # [ # "grn_select", - # "proc.c", - # 1217 + # "proc_select.c", + # 2973 # ] # ] # ] Modified: doc/source/reference/commands/logical_select.rst (+69 -31) =================================================================== --- doc/source/reference/commands/logical_select.rst 2017-01-22 21:38:40 +0900 (4ae5791) +++ doc/source/reference/commands/logical_select.rst 2017-01-23 11:49:29 +0900 (1545eb2) @@ -46,12 +46,14 @@ parameters are optional:: [drilldown_limit=10] [drilldown_calc_types=NONE] [drilldown_calc_target=null] + [sort_keys=null] + [drilldown_sort_keys=null] ``logical_select`` has the following named parameters for advanced drilldown: * ``drilldowns[${LABEL}].keys=null`` - * ``drilldowns[${LABEL}].sortby=null`` + * ``drilldowns[${LABEL}].sort_keys=null`` * ``drilldowns[${LABEL}].output_columns="_key, _nsubrecs"`` * ``drilldowns[${LABEL}].offset=0`` * ``drilldowns[${LABEL}].limit=10`` @@ -59,7 +61,14 @@ drilldown: * ``drilldowns[${LABEL}].calc_target=null`` .. deprecated:: 6.1.4 - ``drilldown[...]`` syntax is deprecated, Use ``drilldowns[...]`` instead. + + ``drilldown[...]`` syntax is deprecated. Use ``drilldowns[...]`` + instead. + +.. deprecated:: 6.1.5 + + :ref:`logical-select-drilldowns-sortby` is deprecated. + Use :ref:`logical-select-drilldowns-sort-keys` instead. You can use one or more alphabets, digits, ``_`` and ``.`` for ``${LABEL}``. For example, ``parent.sub1`` is a valid ``${LABEL}``. @@ -69,14 +78,14 @@ Parameters that have the same ``${LABEL}`` are grouped. For example, the following parameters specify one drilldown: * ``--drilldowns[label].keys column`` - * ``--drilldowns[label].sortby -_nsubrecs`` + * ``--drilldowns[label].sort_keys -_nsubrecs`` The following parameters specify two drilldowns: * ``--drilldowns[label1].keys column1`` - * ``--drilldowns[label1].sortby -_nsubrecs`` + * ``--drilldowns[label1].sort_keys -_nsubrecs`` * ``--drilldowns[label2].keys column2`` - * ``--drilldowns[label2].sortby _key`` + * ``--drilldowns[label2].sort_keys _key`` Differences from ``select`` --------------------------- @@ -89,11 +98,12 @@ But there are some differences from :doc:`select`: * ``logical_table`` and ``shard_key`` parameters are required instead of ``table`` parameter. - * ``sortby`` isn't supported when multiple shards are used. (Only + * ``sort_keys`` isn't supported when multiple shards are used. (Only one shard is used, they are supported.) - * ``_value.${KEY_NAME}`` in ``drilldowns[${LABEL}].sortby`` doesn't - work with multiple shards. It works with one shard. ``_key`` in - ``drilldowns[${LABEL}].sortby`` work with multiple shards. + * ``_value.${KEY_NAME}`` in ``drilldowns[${LABEL}].sort_keys`` + doesn't work with multiple shards. It works with one + shard. ``_key`` in ``drilldowns[${LABEL}].sort_keys`` work with + multiple shards. * ``match_columns`` and ``query`` aren't supported yet. * ``cache`` isn't supported yet. * ``match_escalation_threshold`` isn't supported yet. @@ -454,17 +464,26 @@ Here is an example: ``sortby`` """""""""" -Corresponds to :ref:`select-sortby` in :doc:`select`. See -:ref:`select-sortby` for details. +.. deprecated:: 6.1.5 -``sortby`` has a limitation. It works only when the number of search -target shards is one. If the number of search target shards is larger -than one, ``sortby`` doesn't work. + Use :ref:`logical-select-sort-keys` instead. + +.. _logical-select-sort-keys: + +``sort_keys`` +""""""""""""" + +Corresponds to :ref:`select-sort-keys` in :doc:`select`. See +:ref:`select-sort-keys` for details. + +``sort_keys`` has a limitation. It works only when the number of +search target shards is one. If the number of search target shards is +larger than one, ``sort_keys`` doesn't work. Here is an example that uses only one shard: .. groonga-command -.. include:: ../../example/reference/commands/logical_select/sortby.log +.. include:: ../../example/reference/commands/logical_select/sort_keys.log .. logical_select \ .. --logical_table Entries \ .. --shard_key created_at \ @@ -472,7 +491,7 @@ Here is an example that uses only one shard: .. --min_border "include" \ .. --max "2015/07/09 00:00:00" \ .. --max_border "exclude" \ -.. --sortby _key +.. --sort_keys _key .. _logical-select-offset: @@ -546,20 +565,29 @@ Here is an example: ``drilldown_sortby`` """""""""""""""""""" -Corresponds to :ref:`select-drilldown-sortby` in :doc:`select`. See -:ref:`select-drilldown-sortby` for details. +.. deprecated:: 6.1.5 + + Use :ref:`logical-select-drilldown-sort-keys` instead. + +.. _logical-select-drilldown-sort-keys: + +``drilldown_sort_keys`` +""""""""""""""""""""""" + +Corresponds to :ref:`select-drilldown-sort-keys` in :doc:`select`. See +:ref:`select-drilldown-sort-keys` for details. Here is an example: .. groonga-command -.. include:: ../../example/reference/commands/logical_select/drilldown_sortby.log +.. include:: ../../example/reference/commands/logical_select/drilldown_sort_keys.log .. logical_select \ .. --logical_table Entries \ .. --shard_key created_at \ .. --limit 0 \ .. --output_columns _id \ .. --drilldown tag \ -.. --drilldown_sortby -_nsubrecs,_key +.. --drilldown_sort_keys -_nsubrecs,_key .. _logical-select-drilldown-output-columns: @@ -664,9 +692,10 @@ details. There are some limitations: - * ``_value.${KEY_NAME}`` in ``drilldowns[${LABEL}].sortby`` doesn't - work with multiple shards. It works with one shard. ``_key`` in - ``drilldowns[${LABEL}].sortby`` work with multiple shards. + * ``_value.${KEY_NAME}`` in ``drilldowns[${LABEL}].sort_keys`` + doesn't work with multiple shards. It works with one + shard. ``_key`` in ``drilldowns[${LABEL}].sort_key`` work with + multiple shards. .. _logical-select-drilldowns-label-keys: @@ -714,20 +743,29 @@ Here is an example: ``drilldowns[${LABEL}].sortby`` """"""""""""""""""""""""""""""" -Corresponds to :ref:`logical-select-drilldown-sortby` in not labeled -drilldown. +.. deprecated:: 6.1.5 + + Use :ref:`logical-select-drilldowns-label-sort-keys` instead. + +.. _logical-select-drilldowns-label-sort-keys: + +``drilldowns[${LABEL}].sort_keys`` +"""""""""""""""""""""""""""""""""" + +Corresponds to :ref:`logical-select-drilldown-sort-keys` in not +labeled drilldown. -``drilldowns[${LABEL}].sortby`` has a limitation. +``drilldowns[${LABEL}].sort_keys`` has a limitation. -``_value.${KEY_NAME}`` in ``drilldowns[${LABEL}].sortby`` doesn't work -with multiple shards. It works with one shard. ``_key`` in -``drilldowns[${LABEL}].sortby`` work with multiple shards. +``_value.${KEY_NAME}`` in ``drilldowns[${LABEL}].sort_keys`` doesn't +work with multiple shards. It works with one shard. ``_key`` in +``drilldowns[${LABEL}].sort_keys`` work with multiple shards. Here is an example that uses ``_value.${KEY_NAME}`` with only one shard: .. groonga-command -.. include:: ../../example/reference/commands/logical_select/drilldowns_label_sortby.log +.. include:: ../../example/reference/commands/logical_select/drilldowns_label_sort_keys.log .. logical_select \ .. --logical_table Entries \ .. --shard_key created_at \ @@ -739,7 +777,7 @@ shard: .. --output_columns _id \ .. --drilldowns[tag.n_likes].keys tag,n_likes \ .. --drilldowns[tag.n_likes].output_columns _nsubrecs,_value.n_likes,_value.tag \ -.. --drilldowns[tag.n_likes].sortby -_nsubrecs,_value.n_likes,_value.tag +.. --drilldowns[tag.n_likes].sort_keys -_nsubrecs,_value.n_likes,_value.tag .. _logical-select-drilldowns-label-offset: Modified: doc/source/reference/commands/select.rst (+18 -18) =================================================================== --- doc/source/reference/commands/select.rst 2017-01-22 21:38:40 +0900 (f029cb1) +++ doc/source/reference/commands/select.rst 2017-01-23 11:49:29 +0900 (5accf7e) @@ -53,7 +53,7 @@ optional:: ``select`` has the following named parameters for advanced drilldown: * ``drilldowns[${LABEL}].keys=null`` - * ``drilldowns[${LABEL}].sortby=null`` + * ``drilldowns[${LABEL}].sort_keys=null`` * ``drilldowns[${LABEL}].output_columns="_key, _nsubrecs"`` * ``drilldowns[${LABEL}].offset=0`` * ``drilldowns[${LABEL}].limit=10`` @@ -71,14 +71,14 @@ Parameters that have the same ``${LABEL}`` are grouped. For example, the following parameters specify one drilldown: * ``--drilldowns[label].keys column`` - * ``--drilldowns[label].sortby -_nsubrecs`` + * ``--drilldowns[label].sort_keys -_nsubrecs`` The following parameters specify two drilldowns: * ``--drilldowns[label1].keys column1`` - * ``--drilldowns[label1].sortby -_nsubrecs`` + * ``--drilldowns[label1].sort_keys -_nsubrecs`` * ``--drilldowns[label2].keys column2`` - * ``--drilldowns[label2].sortby _key`` + * ``--drilldowns[label2].sort_keys _key`` Usage ----- @@ -852,7 +852,7 @@ record. .. groonga-command .. include:: ../../example/reference/commands/select/offset_simple.log -.. select Entries --sortby _id --offset 3 --output_columns _key +.. select Entries --sort_keys _id --offset 3 --output_columns _key The ``select`` command outputs from the 4th record. @@ -864,7 +864,7 @@ record. .. groonga-command .. include:: ../../example/reference/commands/select/offset_negative.log -.. select Entries --sortby _id --offset -2 --output_columns _key +.. select Entries --sort_keys _id --offset -2 --output_columns _key The ``select`` command outputs from the 4th record because the total number of records is ``5``. @@ -883,7 +883,7 @@ Here is a simple ``limit`` usage example. .. groonga-command .. include:: ../../example/reference/commands/select/limit_simple.log -.. select Entries --sortby _id --offset 2 --limit 3 --output_columns _key +.. select Entries --sort_keys _id --offset 2 --limit 3 --output_columns _key The ``select`` command outputs the 3rd, the 4th and the 5th records. @@ -1003,15 +1003,15 @@ sort key is column name. You can refer the number of grouped records by ``_nsubrecs`` :doc:`/reference/columns/pseudo`. -Here is a simple ``drilldown_sortby`` example: +Here is a simple ``drilldown_sort_keys`` example: .. groonga-command -.. include:: ../../example/reference/commands/select/drilldown_sortby_simple.log +.. include:: ../../example/reference/commands/select/drilldown_sort_keys_simple.log .. select Entries \ .. --limit 0 \ .. --output_column _id \ .. --drilldown tag \ -.. --drilldown_sortby '-_nsubrecs, _key' +.. --drilldown_sort_keys '-_nsubrecs, _key' Drilldown result is sorted by the number of grouped records (= ``_nsubrecs`` ) in descending order. If there are grouped results that @@ -1021,12 +1021,12 @@ are sorted by grouped key (= ``_key`` ) in ascending order. The sort keys are used in all group keys specified in ``drilldown``: .. groonga-command -.. include:: ../../example/reference/commands/select/drilldown_sortby_simple.log +.. include:: ../../example/reference/commands/select/drilldown_sort_keys_simple.log .. select Entries \ .. --limit 0 \ .. --output_column _id \ .. --drilldown 'tag, n_likes' \ -.. --drilldown_sortby '-_nsubrecs, _key' +.. --drilldown_sort_keys '-_nsubrecs, _key' The same sort keys are used in ``tag`` drilldown and ``n_likes`` drilldown. @@ -1134,7 +1134,7 @@ Here is a ``drilldown_offset`` example: .. --limit 0 \ .. --output_column _id \ .. --drilldown tag \ -.. --drilldown_sortby _key \ +.. --drilldown_sort_keys _key \ .. --drilldown_offset 1 The ``select`` command outputs from the 2nd record. @@ -1151,7 +1151,7 @@ grouped result to the 3rd grouped result. .. --limit 0 \ .. --output_column _id \ .. --drilldown tag \ -.. --drilldown_sortby _key \ +.. --drilldown_sort_keys _key \ .. --drilldown_offset -2 The ``select`` command outputs from the 2nd grouped result because the @@ -1175,7 +1175,7 @@ Here is a ``drilldown_limit`` example: .. --limit 0 \ .. --output_column _id \ .. --drilldown tag \ -.. --drilldown_sortby _key \ +.. --drilldown_sort_keys _key \ .. --drilldown_offset 1 \ .. --drilldown_limit 2 @@ -1193,7 +1193,7 @@ Here is a negative ``drilldown_limit`` value example. .. --limit 0 \ .. --output_column _id \ .. --drilldown tag \ -.. --drilldown_sortby _key \ +.. --drilldown_sort_keys _key \ .. --drilldown_limit -1 The ``select`` command outputs all groups. @@ -1386,7 +1386,7 @@ You can use a configuration for each drilldown by the following parameters: * ``drilldowns[${LABEL}].keys`` - * ``drilldowns[${LABEL}].sortby`` + * ``drilldowns[${LABEL}].sort_keys`` * ``drilldowns[${LABEL}].output_columns`` * ``drilldowns[${LABEL}].offset`` * ``drilldowns[${LABEL}].limit`` @@ -1429,7 +1429,7 @@ In ``label2`` group, ``tag`` is used for group key and See document for corresponding ``drilldown_XXX`` parameter to know how to use it for the following parameters: - * ``drilldowns[${LABEL}].sortby``: :ref:`select-drilldown-sortby` + * ``drilldowns[${LABEL}].sort_keys``: :ref:`select-drilldown-sort-keys` * ``drilldowns[${LABEL}].offset``: :ref:`select-drilldown-offset` * ``drilldowns[${LABEL}].limit``: :ref:`select-drilldown-limit` * ``drilldowns[${LABEL}].calc_types``: :ref:`select-drilldown-calc-types` -------------- next part -------------- HTML����������������������������...Download