Kouhei Sutou
null+****@clear*****
Thu Jul 9 15:07:46 JST 2015
Kouhei Sutou 2015-07-09 15:07:46 +0900 (Thu, 09 Jul 2015) New Revision: e562eaee7afc684e5579f70086bd493f9b8f9e83 https://github.com/groonga/groonga/commit/e562eaee7afc684e5579f70086bd493f9b8f9e83 Message: doc logical_select: describe more parameters Added files: doc/source/example/reference/commands/logical_select/drilldown_label_calc_types.log doc/source/example/reference/commands/logical_select/drilldown_label_keys.log doc/source/example/reference/commands/logical_select/drilldown_label_limit.log doc/source/example/reference/commands/logical_select/drilldown_label_offset.log doc/source/example/reference/commands/logical_select/drilldown_label_output_columns.log doc/source/example/reference/commands/logical_select/drilldown_label_sortby.log doc/source/example/reference/commands/logical_select/drilldown_offset.log doc/source/example/reference/commands/logical_select/drilldown_output_columns.log Copied files: doc/source/example/reference/commands/logical_select/drilldown.log (from doc/source/example/reference/commands/logical_select/max.log) doc/source/example/reference/commands/logical_select/drilldown_limit.log (from doc/source/example/reference/commands/logical_select/min_border.log) doc/source/example/reference/commands/logical_select/drilldown_sortby.log (from doc/source/example/reference/commands/logical_select/min_border.log) doc/source/example/reference/commands/logical_select/filter.log (from doc/source/example/reference/commands/logical_select/min.log) doc/source/example/reference/commands/logical_select/limit.log (from doc/source/example/reference/commands/logical_select/max.log) doc/source/example/reference/commands/logical_select/offset.log (from doc/source/example/reference/commands/logical_select/min.log) doc/source/example/reference/commands/logical_select/output_columns.log (from doc/source/example/reference/commands/logical_select/logical_table_existent.log) doc/source/example/reference/commands/logical_select/sortby.log (from doc/source/example/reference/commands/logical_select/max_border.log) Modified files: doc/source/example/reference/commands/logical_select/logical_table_existent.log doc/source/example/reference/commands/logical_select/max.log doc/source/example/reference/commands/logical_select/max_border.log doc/source/example/reference/commands/logical_select/min.log doc/source/example/reference/commands/logical_select/min_border.log doc/source/reference/commands/logical_select.rst doc/source/reference/commands/select.rst Copied: doc/source/example/reference/commands/logical_select/drilldown.log (+38 -23) 54% =================================================================== --- doc/source/example/reference/commands/logical_select/max.log 2015-07-09 14:59:18 +0900 (5b58be6) +++ doc/source/example/reference/commands/logical_select/drilldown.log 2015-07-09 15:07:46 +0900 (0cf478f) @@ -3,7 +3,8 @@ Execution example:: logical_select \ --logical_table Entries \ --shard_key created_at \ - --max "2015/07/08 23:59:59" + --output_columns _key,tag \ + --drilldown tag # [ # [ # 0, @@ -13,7 +14,7 @@ Execution example:: # [ # [ # [ - # 3 + # 5 # ], # [ # [ @@ -21,42 +22,56 @@ Execution example:: # "ShortText" # ], # [ - # "content", - # "Text" - # ], - # [ - # "created_at", - # "Time" - # ], - # [ - # "n_likes", - # "UInt32" - # ], - # [ # "tag", # "ShortText" # ] # ], # [ # "The first post!", - # "Welcome! This is my first post!", - # 1436281200.0, - # 5, # "Hello" # ], # [ # "Groonga", - # "I started to use Groonga. It's very fast!", - # 1436284800.0, - # 10, # "Groonga" # ], # [ # "Mroonga", - # "I also started to use Mroonga. It's also very fast! Really fast!", - # 1436288400.0, - # 15, # "Groonga" + # ], + # [ + # "Good-bye Senna", + # "Senna" + # ], + # [ + # "Good-bye Tritonn", + # "Senna" + # ] + # ], + # [ + # [ + # 3 + # ], + # [ + # [ + # "_key", + # "ShortText" + # ], + # [ + # "_nsubrecs", + # "Int32" + # ] + # ], + # [ + # "Hello", + # 1 + # ], + # [ + # "Groonga", + # 2 + # ], + # [ + # "Senna", + # 2 # ] # ] # ] Added: doc/source/example/reference/commands/logical_select/drilldown_label_calc_types.log (+88 -0) 100644 =================================================================== --- /dev/null +++ doc/source/example/reference/commands/logical_select/drilldown_label_calc_types.log 2015-07-09 15:07:46 +0900 (7fae4e3) @@ -0,0 +1,88 @@ +Execution example:: + + logical_select \ + --logical_table Entries \ + --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 + # [ + # [ + # 0, + # 1337566253.89858, + # 0.000355720520019531 + # ], + # [ + # [ + # [ + # 5 + # ], + # [ + # [ + # "_id", + # "UInt32" + # ] + # ] + # ], + # { + # "tag": [ + # [ + # 3 + # ], + # [ + # [ + # "_key", + # "ShortText" + # ], + # [ + # "_nsubrecs", + # "Int32" + # ], + # [ + # "_max", + # "Int64" + # ], + # [ + # "_min", + # "Int64" + # ], + # [ + # "_sum", + # "Int64" + # ], + # [ + # "_avg", + # "Float" + # ] + # ], + # [ + # "Hello", + # 1, + # 5, + # 5, + # 5, + # 5.0 + # ], + # [ + # "Groonga", + # 2, + # 15, + # 10, + # 25, + # 12.5 + # ], + # [ + # "Senna", + # 2, + # 3, + # 3, + # 6, + # 3.0 + # ] + # ] + # } + # ] + # ] Added: doc/source/example/reference/commands/logical_select/drilldown_label_keys.log (+70 -0) 100644 =================================================================== --- /dev/null +++ doc/source/example/reference/commands/logical_select/drilldown_label_keys.log 2015-07-09 15:07:46 +0900 (235a710) @@ -0,0 +1,70 @@ +Execution example:: + + logical_select \ + --logical_table Entries \ + --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 + # [ + # [ + # 0, + # 1337566253.89858, + # 0.000355720520019531 + # ], + # [ + # [ + # [ + # 5 + # ], + # [ + # [ + # "_id", + # "UInt32" + # ] + # ] + # ], + # { + # "tag.n_likes": [ + # [ + # 4 + # ], + # [ + # [ + # "tag", + # "ShortText" + # ], + # [ + # "n_likes", + # "UInt32" + # ], + # [ + # "_nsubrecs", + # "Int32" + # ] + # ], + # [ + # "Hello", + # 5, + # 1 + # ], + # [ + # "Groonga", + # 10, + # 1 + # ], + # [ + # "Groonga", + # 15, + # 1 + # ], + # [ + # "Senna", + # 3, + # 2 + # ] + # ] + # } + # ] + # ] Added: doc/source/example/reference/commands/logical_select/drilldown_label_limit.log (+54 -0) 100644 =================================================================== --- /dev/null +++ doc/source/example/reference/commands/logical_select/drilldown_label_limit.log 2015-07-09 15:07:46 +0900 (b8f5aab) @@ -0,0 +1,54 @@ +Execution example:: + + logical_select \ + --logical_table Entries \ + --shard_key created_at \ + --limit 0 \ + --output_columns _id \ + --drilldown[tag.n_likes].keys tag \ + --drilldown[tag.n_likes].limit 2 + # [ + # [ + # 0, + # 1337566253.89858, + # 0.000355720520019531 + # ], + # [ + # [ + # [ + # 5 + # ], + # [ + # [ + # "_id", + # "UInt32" + # ] + # ] + # ], + # { + # "tag.n_likes": [ + # [ + # 3 + # ], + # [ + # [ + # "_key", + # "ShortText" + # ], + # [ + # "_nsubrecs", + # "Int32" + # ] + # ], + # [ + # "Hello", + # 1 + # ], + # [ + # "Groonga", + # 2 + # ] + # ] + # } + # ] + # ] Added: doc/source/example/reference/commands/logical_select/drilldown_label_offset.log (+54 -0) 100644 =================================================================== --- /dev/null +++ doc/source/example/reference/commands/logical_select/drilldown_label_offset.log 2015-07-09 15:07:46 +0900 (17b6ed6) @@ -0,0 +1,54 @@ +Execution example:: + + logical_select \ + --logical_table Entries \ + --shard_key created_at \ + --limit 0 \ + --output_columns _id \ + --drilldown[tag.n_likes].keys tag \ + --drilldown[tag.n_likes].offset 1 + # [ + # [ + # 0, + # 1337566253.89858, + # 0.000355720520019531 + # ], + # [ + # [ + # [ + # 5 + # ], + # [ + # [ + # "_id", + # "UInt32" + # ] + # ] + # ], + # { + # "tag.n_likes": [ + # [ + # 3 + # ], + # [ + # [ + # "_key", + # "ShortText" + # ], + # [ + # "_nsubrecs", + # "Int32" + # ] + # ], + # [ + # "Groonga", + # 2 + # ], + # [ + # "Senna", + # 2 + # ] + # ] + # } + # ] + # ] Added: doc/source/example/reference/commands/logical_select/drilldown_label_output_columns.log (+58 -0) 100644 =================================================================== --- /dev/null +++ doc/source/example/reference/commands/logical_select/drilldown_label_output_columns.log 2015-07-09 15:07:46 +0900 (7e3a2af) @@ -0,0 +1,58 @@ +Execution example:: + + logical_select \ + --logical_table Entries \ + --shard_key created_at \ + --limit 0 \ + --output_columns _id \ + --drilldown[tag].keys tag \ + --drilldown[tag].output_columns _key,_nsubrecs + # [ + # [ + # 0, + # 1337566253.89858, + # 0.000355720520019531 + # ], + # [ + # [ + # [ + # 5 + # ], + # [ + # [ + # "_id", + # "UInt32" + # ] + # ] + # ], + # { + # "tag": [ + # [ + # 3 + # ], + # [ + # [ + # "_key", + # "ShortText" + # ], + # [ + # "_nsubrecs", + # "Int32" + # ] + # ], + # [ + # "Hello", + # 1 + # ], + # [ + # "Groonga", + # 2 + # ], + # [ + # "Senna", + # 2 + # ] + # ] + # } + # ] + # ] Added: doc/source/example/reference/commands/logical_select/drilldown_label_sortby.log (+70 -0) 100644 =================================================================== --- /dev/null +++ doc/source/example/reference/commands/logical_select/drilldown_label_sortby.log 2015-07-09 15:07:46 +0900 (8a88259) @@ -0,0 +1,70 @@ +Execution example:: + + logical_select \ + --logical_table Entries \ + --shard_key created_at \ + --min "2015/07/08 00:00:00" \ + --min_border "include" \ + --max "2015/07/09 00:00:00" \ + --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 + # [ + # [ + # 0, + # 1337566253.89858, + # 0.000355720520019531 + # ], + # [ + # [ + # [ + # 3 + # ], + # [ + # [ + # "_id", + # "UInt32" + # ] + # ] + # ], + # { + # "tag.n_likes": [ + # [ + # 3 + # ], + # [ + # [ + # "_nsubrecs", + # "Int32" + # ], + # [ + # "n_likes", + # "UInt32" + # ], + # [ + # "tag", + # "ShortText" + # ] + # ], + # [ + # 1, + # 5, + # "Hello" + # ], + # [ + # 1, + # 10, + # "Groonga" + # ], + # [ + # 1, + # 15, + # "Groonga" + # ] + # ] + # } + # ] + # ] Copied: doc/source/example/reference/commands/logical_select/drilldown_limit.log (+24 -22) 50% =================================================================== --- doc/source/example/reference/commands/logical_select/min_border.log 2015-07-09 14:59:18 +0900 (3fc2728) +++ doc/source/example/reference/commands/logical_select/drilldown_limit.log 2015-07-09 15:07:46 +0900 (ddd8977) @@ -3,8 +3,10 @@ Execution example:: logical_select \ --logical_table Entries \ --shard_key created_at \ - --min "2015/07/09 00:00:00" \ - --min_border "exclude" + --limit 0 \ + --output_columns _id \ + --drilldown tag \ + --drilldown_limit 2 # [ # [ # 0, @@ -14,7 +16,18 @@ Execution example:: # [ # [ # [ - # 1 + # 5 + # ], + # [ + # [ + # "_id", + # "UInt32" + # ] + # ] + # ], + # [ + # [ + # 3 # ], # [ # [ @@ -22,28 +35,17 @@ Execution example:: # "ShortText" # ], # [ - # "content", - # "Text" - # ], - # [ - # "created_at", - # "Time" - # ], - # [ - # "n_likes", - # "UInt32" - # ], - # [ - # "tag", - # "ShortText" + # "_nsubrecs", + # "Int32" # ] # ], # [ - # "Good-bye Tritonn", - # "I also migrated all Tritonn system!", - # 1436371200.0, - # 3, - # "Senna" + # "Hello", + # 1 + # ], + # [ + # "Groonga", + # 2 # ] # ] # ] Added: doc/source/example/reference/commands/logical_select/drilldown_offset.log (+52 -0) 100644 =================================================================== --- /dev/null +++ doc/source/example/reference/commands/logical_select/drilldown_offset.log 2015-07-09 15:07:46 +0900 (bf03781) @@ -0,0 +1,52 @@ +Execution example:: + + logical_select \ + --logical_table Entries \ + --shard_key created_at \ + --limit 0 \ + --output_columns _id \ + --drilldown tag \ + --drilldown_offset 1 + # [ + # [ + # 0, + # 1337566253.89858, + # 0.000355720520019531 + # ], + # [ + # [ + # [ + # 5 + # ], + # [ + # [ + # "_id", + # "UInt32" + # ] + # ] + # ], + # [ + # [ + # 3 + # ], + # [ + # [ + # "_key", + # "ShortText" + # ], + # [ + # "_nsubrecs", + # "Int32" + # ] + # ], + # [ + # "Groonga", + # 2 + # ], + # [ + # "Senna", + # 2 + # ] + # ] + # ] + # ] Added: doc/source/example/reference/commands/logical_select/drilldown_output_columns.log (+49 -0) 100644 =================================================================== --- /dev/null +++ doc/source/example/reference/commands/logical_select/drilldown_output_columns.log 2015-07-09 15:07:46 +0900 (e1fcd71) @@ -0,0 +1,49 @@ +Execution example:: + + logical_select \ + --logical_table Entries \ + --shard_key created_at \ + --limit 0 \ + --output_columns _id \ + --drilldown tag \ + --drilldown_output_columns _key + # [ + # [ + # 0, + # 1337566253.89858, + # 0.000355720520019531 + # ], + # [ + # [ + # [ + # 5 + # ], + # [ + # [ + # "_id", + # "UInt32" + # ] + # ] + # ], + # [ + # [ + # 3 + # ], + # [ + # [ + # "_key", + # "ShortText" + # ] + # ], + # [ + # "Hello" + # ], + # [ + # "Groonga" + # ], + # [ + # "Senna" + # ] + # ] + # ] + # ] Copied: doc/source/example/reference/commands/logical_select/drilldown_sortby.log (+28 -22) 50% =================================================================== --- doc/source/example/reference/commands/logical_select/min_border.log 2015-07-09 14:59:18 +0900 (3fc2728) +++ doc/source/example/reference/commands/logical_select/drilldown_sortby.log 2015-07-09 15:07:46 +0900 (54105d8) @@ -3,8 +3,10 @@ Execution example:: logical_select \ --logical_table Entries \ --shard_key created_at \ - --min "2015/07/09 00:00:00" \ - --min_border "exclude" + --limit 0 \ + --output_columns _id \ + --drilldown tag \ + --drilldown_sortby -_nsubrecs,_key # [ # [ # 0, @@ -14,7 +16,18 @@ Execution example:: # [ # [ # [ - # 1 + # 5 + # ], + # [ + # [ + # "_id", + # "UInt32" + # ] + # ] + # ], + # [ + # [ + # 3 # ], # [ # [ @@ -22,28 +35,21 @@ Execution example:: # "ShortText" # ], # [ - # "content", - # "Text" - # ], - # [ - # "created_at", - # "Time" - # ], - # [ - # "n_likes", - # "UInt32" - # ], - # [ - # "tag", - # "ShortText" + # "_nsubrecs", + # "Int32" # ] # ], # [ - # "Good-bye Tritonn", - # "I also migrated all Tritonn system!", - # 1436371200.0, - # 3, - # "Senna" + # "Groonga", + # 2 + # ], + # [ + # "Senna", + # 2 + # ], + # [ + # "Hello", + # 1 # ] # ] # ] Copied: doc/source/example/reference/commands/logical_select/filter.log (+16 -2) 75% =================================================================== --- doc/source/example/reference/commands/logical_select/min.log 2015-07-09 14:59:18 +0900 (eee6214) +++ doc/source/example/reference/commands/logical_select/filter.log 2015-07-09 15:07:46 +0900 (34ac1d8) @@ -3,7 +3,7 @@ Execution example:: logical_select \ --logical_table Entries \ --shard_key created_at \ - --min "2015/07/09 00:00:00" + --filter "n_likes <= 5" # [ # [ # 0, @@ -13,10 +13,14 @@ Execution example:: # [ # [ # [ - # 2 + # 3 # ], # [ # [ + # "_id", + # "UInt32" + # ], + # [ # "_key", # "ShortText" # ], @@ -38,6 +42,15 @@ Execution example:: # ] # ], # [ + # 1, + # "The first post!", + # "Welcome! This is my first post!", + # 1436281200.0, + # 5, + # "Hello" + # ], + # [ + # 1, # "Good-bye Senna", # "I migrated all Senna system!", # 1436367600.0, @@ -45,6 +58,7 @@ Execution example:: # "Senna" # ], # [ + # 2, # "Good-bye Tritonn", # "I also migrated all Tritonn system!", # 1436371200.0, Copied: doc/source/example/reference/commands/logical_select/limit.log (+8 -9) 80% =================================================================== --- doc/source/example/reference/commands/logical_select/max.log 2015-07-09 14:59:18 +0900 (5b58be6) +++ doc/source/example/reference/commands/logical_select/limit.log 2015-07-09 15:07:46 +0900 (417df6a) @@ -3,7 +3,7 @@ Execution example:: logical_select \ --logical_table Entries \ --shard_key created_at \ - --max "2015/07/08 23:59:59" + --limit 2 # [ # [ # 0, @@ -13,10 +13,14 @@ Execution example:: # [ # [ # [ - # 3 + # 5 # ], # [ # [ + # "_id", + # "UInt32" + # ], + # [ # "_key", # "ShortText" # ], @@ -38,6 +42,7 @@ Execution example:: # ] # ], # [ + # 1, # "The first post!", # "Welcome! This is my first post!", # 1436281200.0, @@ -45,18 +50,12 @@ Execution example:: # "Hello" # ], # [ + # 2, # "Groonga", # "I started to use Groonga. It's very fast!", # 1436284800.0, # 10, # "Groonga" - # ], - # [ - # "Mroonga", - # "I also started to use Mroonga. It's also very fast! Really fast!", - # 1436288400.0, - # 15, - # "Groonga" # ] # ] # ] Modified: doc/source/example/reference/commands/logical_select/logical_table_existent.log (+9 -0) =================================================================== --- doc/source/example/reference/commands/logical_select/logical_table_existent.log 2015-07-09 14:59:18 +0900 (0f93849) +++ doc/source/example/reference/commands/logical_select/logical_table_existent.log 2015-07-09 15:07:46 +0900 (b701a52) @@ -14,6 +14,10 @@ Execution example:: # ], # [ # [ + # "_id", + # "UInt32" + # ], + # [ # "_key", # "ShortText" # ], @@ -35,6 +39,7 @@ Execution example:: # ] # ], # [ + # 1, # "The first post!", # "Welcome! This is my first post!", # 1436281200.0, @@ -42,6 +47,7 @@ Execution example:: # "Hello" # ], # [ + # 2, # "Groonga", # "I started to use Groonga. It's very fast!", # 1436284800.0, @@ -49,6 +55,7 @@ Execution example:: # "Groonga" # ], # [ + # 3, # "Mroonga", # "I also started to use Mroonga. It's also very fast! Really fast!", # 1436288400.0, @@ -56,6 +63,7 @@ Execution example:: # "Groonga" # ], # [ + # 1, # "Good-bye Senna", # "I migrated all Senna system!", # 1436367600.0, @@ -63,6 +71,7 @@ Execution example:: # "Senna" # ], # [ + # 2, # "Good-bye Tritonn", # "I also migrated all Tritonn system!", # 1436371200.0, Modified: doc/source/example/reference/commands/logical_select/max.log (+7 -0) =================================================================== --- doc/source/example/reference/commands/logical_select/max.log 2015-07-09 14:59:18 +0900 (5b58be6) +++ doc/source/example/reference/commands/logical_select/max.log 2015-07-09 15:07:46 +0900 (93c9f6e) @@ -17,6 +17,10 @@ Execution example:: # ], # [ # [ + # "_id", + # "UInt32" + # ], + # [ # "_key", # "ShortText" # ], @@ -38,6 +42,7 @@ Execution example:: # ] # ], # [ + # 1, # "The first post!", # "Welcome! This is my first post!", # 1436281200.0, @@ -45,6 +50,7 @@ Execution example:: # "Hello" # ], # [ + # 2, # "Groonga", # "I started to use Groonga. It's very fast!", # 1436284800.0, @@ -52,6 +58,7 @@ Execution example:: # "Groonga" # ], # [ + # 3, # "Mroonga", # "I also started to use Mroonga. It's also very fast! Really fast!", # 1436288400.0, Modified: doc/source/example/reference/commands/logical_select/max_border.log (+7 -0) =================================================================== --- doc/source/example/reference/commands/logical_select/max_border.log 2015-07-09 14:59:18 +0900 (32c1d3b) +++ doc/source/example/reference/commands/logical_select/max_border.log 2015-07-09 15:07:46 +0900 (438f008) @@ -18,6 +18,10 @@ Execution example:: # ], # [ # [ + # "_id", + # "UInt32" + # ], + # [ # "_key", # "ShortText" # ], @@ -39,6 +43,7 @@ Execution example:: # ] # ], # [ + # 1, # "The first post!", # "Welcome! This is my first post!", # 1436281200.0, @@ -46,6 +51,7 @@ Execution example:: # "Hello" # ], # [ + # 2, # "Groonga", # "I started to use Groonga. It's very fast!", # 1436284800.0, @@ -53,6 +59,7 @@ Execution example:: # "Groonga" # ], # [ + # 3, # "Mroonga", # "I also started to use Mroonga. It's also very fast! Really fast!", # 1436288400.0, Modified: doc/source/example/reference/commands/logical_select/min.log (+6 -0) =================================================================== --- doc/source/example/reference/commands/logical_select/min.log 2015-07-09 14:59:18 +0900 (eee6214) +++ doc/source/example/reference/commands/logical_select/min.log 2015-07-09 15:07:46 +0900 (e804db1) @@ -17,6 +17,10 @@ Execution example:: # ], # [ # [ + # "_id", + # "UInt32" + # ], + # [ # "_key", # "ShortText" # ], @@ -38,6 +42,7 @@ Execution example:: # ] # ], # [ + # 1, # "Good-bye Senna", # "I migrated all Senna system!", # 1436367600.0, @@ -45,6 +50,7 @@ Execution example:: # "Senna" # ], # [ + # 2, # "Good-bye Tritonn", # "I also migrated all Tritonn system!", # 1436371200.0, Modified: doc/source/example/reference/commands/logical_select/min_border.log (+5 -0) =================================================================== --- doc/source/example/reference/commands/logical_select/min_border.log 2015-07-09 14:59:18 +0900 (3fc2728) +++ doc/source/example/reference/commands/logical_select/min_border.log 2015-07-09 15:07:46 +0900 (88d677c) @@ -18,6 +18,10 @@ Execution example:: # ], # [ # [ + # "_id", + # "UInt32" + # ], + # [ # "_key", # "ShortText" # ], @@ -39,6 +43,7 @@ Execution example:: # ] # ], # [ + # 2, # "Good-bye Tritonn", # "I also migrated all Tritonn system!", # 1436371200.0, Copied: doc/source/example/reference/commands/logical_select/offset.log (+16 -2) 74% =================================================================== --- doc/source/example/reference/commands/logical_select/min.log 2015-07-09 14:59:18 +0900 (eee6214) +++ doc/source/example/reference/commands/logical_select/offset.log 2015-07-09 15:07:46 +0900 (4b28760) @@ -3,7 +3,7 @@ Execution example:: logical_select \ --logical_table Entries \ --shard_key created_at \ - --min "2015/07/09 00:00:00" + --offset 2 # [ # [ # 0, @@ -13,10 +13,14 @@ Execution example:: # [ # [ # [ - # 2 + # 5 # ], # [ # [ + # "_id", + # "UInt32" + # ], + # [ # "_key", # "ShortText" # ], @@ -38,6 +42,15 @@ Execution example:: # ] # ], # [ + # 3, + # "Mroonga", + # "I also started to use Mroonga. It's also very fast! Really fast!", + # 1436288400.0, + # 15, + # "Groonga" + # ], + # [ + # 1, # "Good-bye Senna", # "I migrated all Senna system!", # 1436367600.0, @@ -45,6 +58,7 @@ Execution example:: # "Senna" # ], # [ + # 2, # "Good-bye Tritonn", # "I also migrated all Tritonn system!", # 1436371200.0, Copied: doc/source/example/reference/commands/logical_select/output_columns.log (+4 -1) 93% =================================================================== --- doc/source/example/reference/commands/logical_select/logical_table_existent.log 2015-07-09 14:59:18 +0900 (0f93849) +++ doc/source/example/reference/commands/logical_select/output_columns.log 2015-07-09 15:07:46 +0900 (a167b13) @@ -1,6 +1,9 @@ Execution example:: - logical_select --logical_table Entries --shard_key created_at + logical_select \ + --logical_table Entries \ + --shard_key created_at \ + --output_columns '_key, *' # [ # [ # 0, Copied: doc/source/example/reference/commands/logical_select/sortby.log (+18 -8) 84% =================================================================== --- doc/source/example/reference/commands/logical_select/max_border.log 2015-07-09 14:59:18 +0900 (32c1d3b) +++ doc/source/example/reference/commands/logical_select/sortby.log 2015-07-09 15:07:46 +0900 (c026cea) @@ -3,8 +3,11 @@ Execution example:: logical_select \ --logical_table Entries \ --shard_key created_at \ + --min "2015/07/08 00:00:00" \ + --min_border "include" \ --max "2015/07/09 00:00:00" \ - --max_border "exclude" + --max_border "exclude" \ + --sortby _key # [ # [ # 0, @@ -18,6 +21,10 @@ Execution example:: # ], # [ # [ + # "_id", + # "UInt32" + # ], + # [ # "_key", # "ShortText" # ], @@ -39,13 +46,7 @@ Execution example:: # ] # ], # [ - # "The first post!", - # "Welcome! This is my first post!", - # 1436281200.0, - # 5, - # "Hello" - # ], - # [ + # 2, # "Groonga", # "I started to use Groonga. It's very fast!", # 1436284800.0, @@ -53,11 +54,20 @@ Execution example:: # "Groonga" # ], # [ + # 3, # "Mroonga", # "I also started to use Mroonga. It's also very fast! Really fast!", # 1436288400.0, # 15, # "Groonga" + # ], + # [ + # 1, + # "The first post!", + # "Welcome! This is my first post!", + # 1436281200.0, + # 5, + # "Hello" # ] # ] # ] Modified: doc/source/reference/commands/logical_select.rst (+455 -5) =================================================================== --- doc/source/reference/commands/logical_select.rst 2015-07-09 14:59:18 +0900 (2c44a62) +++ doc/source/reference/commands/logical_select.rst 2015-07-09 15:07:46 +0900 (44058dc) @@ -40,7 +40,7 @@ parameters are optional:: [max_border="include"] [filter=null] [sortby=null] - [output_columns="_key, *"] + [output_columns="_id, _key, *"] [offset=0] [limit=10] [drilldown=null] @@ -88,10 +88,6 @@ But there are some differences from :doc:`select`: * ``logical_table`` and ``shard_key`` parameters are required instead of ``table`` parameter. - * The default ``output_columns`` value doesn't include - ``_id``. Because ``_id`` is meaningless when multiple shards are - used. ``_id`` may be duplicated because ``_id`` is managed in each - shard not in all shards. * ``sortby``, ``drilldown_sortby`` and ``drilldown[${LABEL}].sortby`` aren't supported when multiple shards are used. (Only one shard is used, they are supported.) @@ -258,6 +254,8 @@ Optional parameters There are optional parameters. +.. _logical-select-min: + ``min`` """"""" @@ -278,6 +276,8 @@ table. ``Entry_20150708`` isn't used. .. --shard_key created_at \ .. --min "2015/07/09 00:00:00" +.. _logical-select-min-border: + ``min_border`` """""""""""""" @@ -306,6 +306,8 @@ Here is an example for ``exclude``. The result doesn't include the .. --min "2015/07/09 00:00:00" \ .. --min_border "exclude" +.. _logical-select-max: + ``max`` """"""" @@ -326,6 +328,8 @@ table. ``Entry_20150709`` isn't used. .. --shard_key created_at \ .. --max "2015/07/08 23:59:59" +.. _logical-select-max-border: + ``max_border`` """""""""""""" @@ -354,9 +358,455 @@ Here is an example for ``exclude``. The result doesn't include the .. --max "2015/07/09 00:00:00" \ .. --max_border "exclude" +.. _logical-select-search-related-parameters: + +Search related parameters +^^^^^^^^^^^^^^^^^^^^^^^^^ + +``logical_select`` provides :doc:`select` compatible search related +parameters. + +``match_columns`` and ``query`` aren't supported yet. ``filter`` is +only supported for now. + +.. _logical-select-match-columns: + +``match_columns`` +""""""""""""""""" + +Not implemented yet. + +.. _logical-select-query: + +``query`` +""""""""" + +Not implemented yet. + +.. _logical-select-filter: + ``filter`` """""""""" +Corresponds to :ref:`select-filter` in :doc:`select`. See +:ref:`select-filter` for details. + +Here is an example: + +.. groonga-command +.. include:: ../../example/reference/commands/logical_select/filter.log +.. logical_select \ +.. --logical_table Entries \ +.. --shard_key created_at \ +.. --filter "n_likes <= 5" + +.. _logical-select-advanced-search-parameters: + +Advanced search parameters +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +``logical_select`` doesn't implement advanced search parameters yet. + +.. _logical-select-match-escalation-threshold: + +``match_escalation_threshold`` +"""""""""""""""""""""""""""""" + +Not implemented yet. + +.. _logical-select-match-escalation-threshold: + +``match_escalation_threshold`` +"""""""""""""""""""""""""""""" + +Not implemented yet. + +.. _logical-select-query-flags: + +``query_flags`` +""""""""""""""" + +Not implemented yet. + +.. _logical-select-query-expander: + +``query_expander`` +"""""""""""""""""" + +Not implemented yet. + +Output related parameters +^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. _logical-select-output-columns: + +``output_columns`` +"""""""""""""""""" + +Corresponds to :ref:`select-output-columns` in :doc:`select`. See +:ref:`select-output-columns` for details. + +Here is an example: + +.. groonga-command +.. include:: ../../example/reference/commands/logical_select/output_columns.log +.. logical_select \ +.. --logical_table Entries \ +.. --shard_key created_at \ +.. --output_columns '_key, *' + +.. _logical-select-sortby: + +``sortby`` +"""""""""" + +Corresponds to :ref:`select-sortby` in :doc:`select`. See +:ref:`select-sortby` for details. + +``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. + +Here is an example that uses only one shard: + +.. groonga-command +.. include:: ../../example/reference/commands/logical_select/sortby.log +.. logical_select \ +.. --logical_table Entries \ +.. --shard_key created_at \ +.. --min "2015/07/08 00:00:00" \ +.. --min_border "include" \ +.. --max "2015/07/09 00:00:00" \ +.. --max_border "exclude" \ +.. --sortby _key + +.. _logical-select-offset: + +``offset`` +"""""""""" + +Corresponds to :ref:`select-offset` in :doc:`select`. See +:ref:`select-offset` for details. + +Here is an example: + +.. groonga-command +.. include:: ../../example/reference/commands/logical_select/offset.log +.. logical_select \ +.. --logical_table Entries \ +.. --shard_key created_at \ +.. --offset 2 + +.. _logical-select-limit: + +``limit`` +""""""""" + +Corresponds to :ref:`select-limit` in :doc:`select`. See +:ref:`select-limit` for details. + +Here is an example: + +.. groonga-command +.. include:: ../../example/reference/commands/logical_select/limit.log +.. logical_select \ +.. --logical_table Entries \ +.. --shard_key created_at \ +.. --limit 2 + +.. _logical-select-scorer: + +``scorer`` +"""""""""" + +Not implemented yet. + +.. _logical-select-drilldown-related-parameters: + +Drilldown related parameters +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Most of drilldown related parameters in :doc:`select` are supported. +See :ref:`select-drilldown-related-parameters` for details. + +The following parameters aren't supported yet: + + * ``drilldown_calc_types`` + * ``drilldown_calc_target`` + +.. _logical-select-drilldown: + +``drilldown`` +""""""""""""" + +Corresponds to :ref:`select-drilldown` in :doc:`select`. See +:ref:`select-drilldown` for details. + +Here is an example: + +.. groonga-command +.. include:: ../../example/reference/commands/logical_select/drilldown.log +.. logical_select \ +.. --logical_table Entries \ +.. --shard_key created_at \ +.. --output_columns _key,tag \ +.. --drilldown tag + +.. _logical-select-drilldown-sortby: + +``drilldown_sortby`` +"""""""""""""""""""" + +Corresponds to :ref:`select-drilldown-sortby` in :doc:`select`. See +:ref:`select-drilldown-sortby` for details. + +Here is an example: + +.. groonga-command +.. include:: ../../example/reference/commands/logical_select/drilldown_sortby.log +.. logical_select \ +.. --logical_table Entries \ +.. --shard_key created_at \ +.. --limit 0 \ +.. --output_columns _id \ +.. --drilldown tag \ +.. --drilldown_sortby -_nsubrecs,_key + +.. _logical-select-drilldown-output-columns: + +``drilldown_output_columns`` +"""""""""""""""""""""""""""" + +Corresponds to :ref:`select-drilldown-output-columns` in +:doc:`select`. See :ref:`select-drilldown-output-columns` for details. + +Here is an example: + +.. groonga-command +.. include:: ../../example/reference/commands/logical_select/drilldown_output_columns.log +.. logical_select \ +.. --logical_table Entries \ +.. --shard_key created_at \ +.. --limit 0 \ +.. --output_columns _id \ +.. --drilldown tag \ +.. --drilldown_output_columns _key + +.. _logical-select-drilldown-offset: + +``drilldown_offset`` +"""""""""""""""""""" + +Corresponds to :ref:`select-drilldown-offset` in :doc:`select`. See +:ref:`select-drilldown-offset` for details. + +Here is an example: + +.. groonga-command +.. include:: ../../example/reference/commands/logical_select/drilldown_offset.log +.. logical_select \ +.. --logical_table Entries \ +.. --shard_key created_at \ +.. --limit 0 \ +.. --output_columns _id \ +.. --drilldown tag \ +.. --drilldown_offset 1 + +.. _logical-select-drilldown-limit: + +``drilldown_limit`` +""""""""""""""""""" + +Corresponds to :ref:`select-drilldown-limit` in :doc:`select`. See +:ref:`select-drilldown-limit` for details. + +Here is an example: + +.. groonga-command +.. include:: ../../example/reference/commands/logical_select/drilldown_limit.log +.. logical_select \ +.. --logical_table Entries \ +.. --shard_key created_at \ +.. --limit 0 \ +.. --output_columns _id \ +.. --drilldown tag \ +.. --drilldown_limit 2 + +.. _logical-select-drilldown-calc-types: + +``drilldown_calc_types`` +"""""""""""""""""""""""" + +Not implemented yet. + +.. _logical-select-drilldown-calc-target: + +``drilldown_calc_target`` +""""""""""""""""""""""""" + +Not implemented yet. + +.. _logical-select-advanced-drilldown-related-parameters: + +Advanced drilldown related parameters +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +All advanced drilldown related parameters in :doc:`select` are +supported. See :ref:`select-advanced-drilldown-related-parameters` for +details. + +There are some limitations: + + * ``_value.${KEY_NAME}`` in ``drilldown[${LABEL}].sortby`` doesn't + work with multiple shards. It works with one shard. ``_key`` in + ``drilldown[${LABEL}].sortby`` work with multiple shards. + +.. _logical-select-drilldown-label-keys: + +``drilldown[${LABEL}].keys`` +"""""""""""""""""""""""""""" + +Corresponds to :ref:`select-drilldown-label-keys` in +:doc:`select`. See :ref:`select-drilldown-label-keys` for details. + +Here is an example: + +.. groonga-command +.. include:: ../../example/reference/commands/logical_select/drilldown_label_keys.log +.. logical_select \ +.. --logical_table Entries \ +.. --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 + +.. _logical-select-drilldown-label-output-columns: + +``drilldown[${LABEL}].output_columns`` +"""""""""""""""""""""""""""""""""""""" + +Corresponds to :ref:`select-drilldown-label-output-columns` in +:doc:`select`. See :ref:`select-drilldown-label-output-columns` for +details. + +Here is an example: + +.. groonga-command +.. include:: ../../example/reference/commands/logical_select/drilldown_label_output_columns.log +.. logical_select \ +.. --logical_table Entries \ +.. --shard_key created_at \ +.. --limit 0 \ +.. --output_columns _id \ +.. --drilldown[tag].keys tag \ +.. --drilldown[tag].output_columns _key,_nsubrecs + +.. _logical-select-drilldown-label-sortby: + +``drilldown[${LABEL}].sortby`` +"""""""""""""""""""""""""""""" + +Corresponds to :ref:`logical-select-drilldown-sortby` in not labeled +drilldown. + +``drilldown[${LABEL}].sortby`` has a limitation. + +``_value.${KEY_NAME}`` in ``drilldown[${LABEL}].sortby`` doesn't work +with multiple shards. It works with one shard. ``_key`` in +``drilldown[${LABEL}].sortby`` 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/drilldown_label_sortby.log +.. logical_select \ +.. --logical_table Entries \ +.. --shard_key created_at \ +.. --min "2015/07/08 00:00:00" \ +.. --min_border "include" \ +.. --max "2015/07/09 00:00:00" \ +.. --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 + +.. _logical-select-drilldown-label-offset: + +``drilldown[${LABEL}].offset`` +"""""""""""""""""""""""""""""" + +Corresponds to :ref:`logical-select-drilldown-offset` in not labeled +drilldown. + +Here is an example: + +.. groonga-command +.. include:: ../../example/reference/commands/logical_select/drilldown_label_offset.log +.. logical_select \ +.. --logical_table Entries \ +.. --shard_key created_at \ +.. --limit 0 \ +.. --output_columns _id \ +.. --drilldown[tag.n_likes].keys tag \ +.. --drilldown[tag.n_likes].offset 1 + +.. _logical-select-drilldown-label-limit: + +``drilldown[${LABEL}].limit`` +""""""""""""""""""""""""""""" + +Corresponds to :ref:`logical-select-drilldown-limit` in not labeled +drilldown. + +Here is an example: + +.. groonga-command +.. include:: ../../example/reference/commands/logical_select/drilldown_label_limit.log +.. logical_select \ +.. --logical_table Entries \ +.. --shard_key created_at \ +.. --limit 0 \ +.. --output_columns _id \ +.. --drilldown[tag.n_likes].keys tag \ +.. --drilldown[tag.n_likes].limit 2 + +.. _logical-select-drilldown-label-calc-types: + +``drilldown[${LABEL}].calc_types`` +"""""""""""""""""""""""""""""""""" + +Corresponds to :ref:`logical-select-drilldown-calc-types` in not +labeled drilldown. + +Here is an example: + +.. groonga-command +.. include:: ../../example/reference/commands/logical_select/drilldown_label_calc_types.log +.. logical_select \ +.. --logical_table Entries \ +.. --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 + +.. _logical-select-drilldown-label-calc-target: + +``drilldown[${LABEL}].calc_target`` +""""""""""""""""""""""""""""""""""" + +Corresponds to :ref:`logical-select-drilldown-calc-target` in not +labeled drilldown. + +See also :ref:`logical-select-drilldown-label-calc-types` +for an example. + Return value ------------ Modified: doc/source/reference/commands/select.rst (+18 -6) =================================================================== --- doc/source/reference/commands/select.rst 2015-07-09 14:59:18 +0900 (ff50b6d) +++ doc/source/reference/commands/select.rst 2015-07-09 15:07:46 +0900 (b99e9fc) @@ -307,6 +307,8 @@ If nonexistent table is specified, an error is returned. .. include:: ../../example/reference/commands/select/table_nonexistent.log .. select Nonexistent +.. _select-search-related-parameters: + Search related parameters ^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -487,10 +489,12 @@ is less than ``11`` from ``Entries`` table. See :doc:`/reference/grn_expr/script_syntax` for other operators. +.. _select-advanced-search-parameters: + Advanced search parameters ^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. _match-escalation-threshold: +.. _select-match-escalation-threshold: ``match_escalation_threshold`` """""""""""""""""""""""""""""" @@ -540,14 +544,14 @@ storategy escalation is not used because the number of matched records (0) is larger than ``match_escalation_threshold`` (-1). So no more searches aren't executed. And no records are matched. -.. _query-expansion: +.. _select-query-expansion: ``query_expansion`` """"""""""""""""""" -Deprecated. Use :ref:`query-expander` instead. +Deprecated. Use :ref:`select-query-expander` instead. -.. _query-flags: +.. _select-query-flags: ``query_flags`` """"""""""""""" @@ -639,7 +643,7 @@ specified. See also :doc:`/reference/grn_expr/query_syntax`. -.. _query-expander: +.. _select-query-expander: ``query_expander`` """""""""""""""""" @@ -872,6 +876,8 @@ The ``select`` command outputs all records. The default value is ``10``. +.. _select-scorer: + ``scorer`` """""""""" @@ -1362,7 +1368,9 @@ parameters: * ``.`` * ``_`` -.. You can use more characters but it's better that you use only these +.. note:: + + You can use more characters but it's better that you use only these characters. Parameters that has the same ``${LABEL}`` value are grouped. Grouped @@ -1855,6 +1863,10 @@ The following value part is the same format as ``SEARCH_RESULT``:: RECORDS ] +See also :ref:`select-drilldown-label-output-format` for +``drilldown[${LABEL}]`` style drilldown output format. + + See also --------