rroonga 2.0.0-x86-mingw32 → 2.0.1-x86-mingw32

Sign up to get free protection for your applications and to get access to all the features.
Files changed (357) hide show
  1. data/Rakefile +3 -2
  2. data/ext/groonga/rb-grn-expression.c +4 -3
  3. data/ext/groonga/rb-grn-object.c +13 -0
  4. data/ext/groonga/rb-grn-snippet.c +32 -126
  5. data/ext/groonga/rb-grn.h +14 -11
  6. data/lib/1.8/groonga.so +0 -0
  7. data/lib/1.9/groonga.so +0 -0
  8. data/rroonga-build.rb +1 -1
  9. data/vendor/local/bin/{grntest.exe → groonga-benchmark.exe} +0 -0
  10. data/vendor/local/bin/groonga.exe +0 -0
  11. data/vendor/local/bin/libgroonga-0.dll +0 -0
  12. data/vendor/local/bin/libmecab-1.dll +0 -0
  13. data/vendor/local/bin/libmsgpack-3.dll +0 -0
  14. data/vendor/local/bin/libmsgpackc-2.dll +0 -0
  15. data/vendor/local/bin/mecab.exe +0 -0
  16. data/vendor/local/include/groonga/groonga/plugin.h +1 -1
  17. data/vendor/local/include/groonga/groonga.h +10 -3
  18. data/vendor/local/lib/groonga/plugins/suggest/suggest.a +0 -0
  19. data/vendor/local/lib/groonga/plugins/suggest/suggest.dll +0 -0
  20. data/vendor/local/lib/groonga/plugins/suggest/suggest.dll.a +0 -0
  21. data/vendor/local/lib/groonga/plugins/tokenizers/mecab.a +0 -0
  22. data/vendor/local/lib/groonga/plugins/tokenizers/mecab.dll +0 -0
  23. data/vendor/local/lib/groonga/plugins/tokenizers/mecab.dll.a +0 -0
  24. data/vendor/local/lib/libgroonga.a +0 -0
  25. data/vendor/local/lib/libgroonga.dll.a +0 -0
  26. data/vendor/local/lib/libmecab.a +0 -0
  27. data/vendor/local/lib/libmecab.dll.a +0 -0
  28. data/vendor/local/lib/libmsgpack.a +0 -0
  29. data/vendor/local/lib/libmsgpack.dll.a +0 -0
  30. data/vendor/local/lib/libmsgpackc.a +0 -0
  31. data/vendor/local/lib/libmsgpackc.dll.a +0 -0
  32. data/vendor/local/lib/pkgconfig/groonga.pc +2 -2
  33. data/vendor/local/libexec/mecab/mecab-cost-train.exe +0 -0
  34. data/vendor/local/libexec/mecab/mecab-dict-gen.exe +0 -0
  35. data/vendor/local/libexec/mecab/mecab-dict-index.exe +0 -0
  36. data/vendor/local/libexec/mecab/mecab-system-eval.exe +0 -0
  37. data/vendor/local/libexec/mecab/mecab-test-gen.exe +0 -0
  38. data/vendor/local/share/doc/groonga/en/html/.buildinfo +1 -1
  39. data/vendor/local/share/doc/groonga/en/html/_sources/commands/suggest.txt +19 -0
  40. data/vendor/local/share/doc/groonga/en/html/_sources/community.txt +2 -2
  41. data/vendor/local/share/doc/groonga/en/html/_sources/install.txt +72 -8
  42. data/vendor/local/share/doc/groonga/en/html/_sources/news.txt +45 -1
  43. data/vendor/local/share/doc/groonga/en/html/_sources/tutorial/data.txt +112 -33
  44. data/vendor/local/share/doc/groonga/en/html/_sources/tutorial/introduction.txt +109 -99
  45. data/vendor/local/share/doc/groonga/en/html/_sources/tutorial/network.txt +76 -40
  46. data/vendor/local/share/doc/groonga/en/html/_sources/type.txt +30 -21
  47. data/vendor/local/share/doc/groonga/en/html/_static/favicon.ico +0 -0
  48. data/vendor/local/share/doc/groonga/en/html/_static/groonga.css +309 -101
  49. data/vendor/local/share/doc/groonga/en/html/_static/jquery.js +4 -154
  50. data/vendor/local/share/doc/groonga/en/html/_static/logo.png +0 -0
  51. data/vendor/local/share/doc/groonga/en/html/_static/navigation-bar.png +0 -0
  52. data/vendor/local/share/doc/groonga/en/html/_static/underscore.js +29 -21
  53. data/vendor/local/share/doc/groonga/en/html/characteristic.html +1 -1
  54. data/vendor/local/share/doc/groonga/en/html/command_version.html +1 -1
  55. data/vendor/local/share/doc/groonga/en/html/commands/cache_limit.html +1 -1
  56. data/vendor/local/share/doc/groonga/en/html/commands/check.html +1 -1
  57. data/vendor/local/share/doc/groonga/en/html/commands/clearlock.html +1 -1
  58. data/vendor/local/share/doc/groonga/en/html/commands/column_create.html +1 -1
  59. data/vendor/local/share/doc/groonga/en/html/commands/column_list.html +1 -1
  60. data/vendor/local/share/doc/groonga/en/html/commands/column_remove.html +1 -1
  61. data/vendor/local/share/doc/groonga/en/html/commands/define_selector.html +1 -1
  62. data/vendor/local/share/doc/groonga/en/html/commands/defrag.html +1 -1
  63. data/vendor/local/share/doc/groonga/en/html/commands/delete.html +1 -1
  64. data/vendor/local/share/doc/groonga/en/html/commands/dump.html +1 -1
  65. data/vendor/local/share/doc/groonga/en/html/commands/load.html +1 -1
  66. data/vendor/local/share/doc/groonga/en/html/commands/log_level.html +1 -1
  67. data/vendor/local/share/doc/groonga/en/html/commands/log_put.html +1 -1
  68. data/vendor/local/share/doc/groonga/en/html/commands/log_reopen.html +1 -1
  69. data/vendor/local/share/doc/groonga/en/html/commands/quit.html +1 -1
  70. data/vendor/local/share/doc/groonga/en/html/commands/select.html +1 -1
  71. data/vendor/local/share/doc/groonga/en/html/commands/shutdown.html +1 -1
  72. data/vendor/local/share/doc/groonga/en/html/commands/status.html +1 -1
  73. data/vendor/local/share/doc/groonga/en/html/commands/suggest.html +21 -1
  74. data/vendor/local/share/doc/groonga/en/html/commands/table_create.html +1 -1
  75. data/vendor/local/share/doc/groonga/en/html/commands/table_list.html +1 -1
  76. data/vendor/local/share/doc/groonga/en/html/commands/table_remove.html +1 -1
  77. data/vendor/local/share/doc/groonga/en/html/commands/view_add.html +1 -1
  78. data/vendor/local/share/doc/groonga/en/html/commands.html +1 -1
  79. data/vendor/local/share/doc/groonga/en/html/community.html +3 -3
  80. data/vendor/local/share/doc/groonga/en/html/contribution/development/com.html +1 -1
  81. data/vendor/local/share/doc/groonga/en/html/contribution/development/document.html +1 -1
  82. data/vendor/local/share/doc/groonga/en/html/contribution/development/query.html +1 -1
  83. data/vendor/local/share/doc/groonga/en/html/contribution/development/test.html +1 -1
  84. data/vendor/local/share/doc/groonga/en/html/contribution/development.html +1 -1
  85. data/vendor/local/share/doc/groonga/en/html/contribution/documentation/c-api.html +1 -1
  86. data/vendor/local/share/doc/groonga/en/html/contribution/documentation/i18n.html +1 -1
  87. data/vendor/local/share/doc/groonga/en/html/contribution/documentation.html +1 -1
  88. data/vendor/local/share/doc/groonga/en/html/contribution/report.html +1 -1
  89. data/vendor/local/share/doc/groonga/en/html/contribution.html +1 -1
  90. data/vendor/local/share/doc/groonga/en/html/executables/grnslap.html +1 -1
  91. data/vendor/local/share/doc/groonga/en/html/executables/grntest.html +1 -1
  92. data/vendor/local/share/doc/groonga/en/html/executables/groonga-http.html +1 -1
  93. data/vendor/local/share/doc/groonga/en/html/executables/groonga-suggest-create-dataset.html +1 -1
  94. data/vendor/local/share/doc/groonga/en/html/executables/groonga.html +1 -1
  95. data/vendor/local/share/doc/groonga/en/html/executables.html +1 -1
  96. data/vendor/local/share/doc/groonga/en/html/expr.html +1 -1
  97. data/vendor/local/share/doc/groonga/en/html/functions/edit_distance.html +1 -1
  98. data/vendor/local/share/doc/groonga/en/html/functions/geo_distance.html +1 -1
  99. data/vendor/local/share/doc/groonga/en/html/functions/geo_in_circle.html +1 -1
  100. data/vendor/local/share/doc/groonga/en/html/functions/geo_in_rectangle.html +1 -1
  101. data/vendor/local/share/doc/groonga/en/html/functions/now.html +1 -1
  102. data/vendor/local/share/doc/groonga/en/html/functions/rand.html +1 -1
  103. data/vendor/local/share/doc/groonga/en/html/functions.html +1 -1
  104. data/vendor/local/share/doc/groonga/en/html/genindex.html +1 -1
  105. data/vendor/local/share/doc/groonga/en/html/geolocation_search.html +1 -1
  106. data/vendor/local/share/doc/groonga/en/html/index.html +25 -18
  107. data/vendor/local/share/doc/groonga/en/html/indexing.html +1 -1
  108. data/vendor/local/share/doc/groonga/en/html/install.html +59 -9
  109. data/vendor/local/share/doc/groonga/en/html/limitations.html +1 -1
  110. data/vendor/local/share/doc/groonga/en/html/log.html +1 -1
  111. data/vendor/local/share/doc/groonga/en/html/news/0.x.html +1 -1
  112. data/vendor/local/share/doc/groonga/en/html/news/1.0.x.html +1 -1
  113. data/vendor/local/share/doc/groonga/en/html/news/1.1.x.html +1 -1
  114. data/vendor/local/share/doc/groonga/en/html/news/1.2.x.html +1 -1
  115. data/vendor/local/share/doc/groonga/en/html/news/senna.html +1 -1
  116. data/vendor/local/share/doc/groonga/en/html/news.html +66 -15
  117. data/vendor/local/share/doc/groonga/en/html/objects.inv +0 -0
  118. data/vendor/local/share/doc/groonga/en/html/output.html +1 -1
  119. data/vendor/local/share/doc/groonga/en/html/pseudo_column.html +1 -1
  120. data/vendor/local/share/doc/groonga/en/html/reference.html +1 -1
  121. data/vendor/local/share/doc/groonga/en/html/search.html +1 -1
  122. data/vendor/local/share/doc/groonga/en/html/searchindex.js +1 -1
  123. data/vendor/local/share/doc/groonga/en/html/spec/search.html +1 -1
  124. data/vendor/local/share/doc/groonga/en/html/spec.html +1 -1
  125. data/vendor/local/share/doc/groonga/en/html/suggest/completion.html +1 -1
  126. data/vendor/local/share/doc/groonga/en/html/suggest/correction.html +1 -1
  127. data/vendor/local/share/doc/groonga/en/html/suggest/introduction.html +1 -1
  128. data/vendor/local/share/doc/groonga/en/html/suggest/suggestion.html +1 -1
  129. data/vendor/local/share/doc/groonga/en/html/suggest/tutorial.html +1 -1
  130. data/vendor/local/share/doc/groonga/en/html/suggest.html +1 -1
  131. data/vendor/local/share/doc/groonga/en/html/troubleshooting/different_results_with_the_same_keyword.html +1 -1
  132. data/vendor/local/share/doc/groonga/en/html/troubleshooting.html +1 -1
  133. data/vendor/local/share/doc/groonga/en/html/tutorial/data.html +141 -53
  134. data/vendor/local/share/doc/groonga/en/html/tutorial/drilldown.html +1 -1
  135. data/vendor/local/share/doc/groonga/en/html/tutorial/index.html +1 -1
  136. data/vendor/local/share/doc/groonga/en/html/tutorial/introduction.html +112 -106
  137. data/vendor/local/share/doc/groonga/en/html/tutorial/lexicon.html +1 -1
  138. data/vendor/local/share/doc/groonga/en/html/tutorial/match_columns.html +1 -1
  139. data/vendor/local/share/doc/groonga/en/html/tutorial/micro_blog.html +2 -2
  140. data/vendor/local/share/doc/groonga/en/html/tutorial/network.html +92 -58
  141. data/vendor/local/share/doc/groonga/en/html/tutorial/patricia_trie.html +1 -1
  142. data/vendor/local/share/doc/groonga/en/html/tutorial/query_expansion.html +1 -1
  143. data/vendor/local/share/doc/groonga/en/html/tutorial/search.html +5 -5
  144. data/vendor/local/share/doc/groonga/en/html/tutorial.html +21 -14
  145. data/vendor/local/share/doc/groonga/en/html/type.html +30 -22
  146. data/vendor/local/share/doc/groonga/ja/html/.buildinfo +1 -1
  147. data/vendor/local/share/doc/groonga/ja/html/_sources/commands/suggest.txt +19 -0
  148. data/vendor/local/share/doc/groonga/ja/html/_sources/community.txt +2 -2
  149. data/vendor/local/share/doc/groonga/ja/html/_sources/install.txt +72 -8
  150. data/vendor/local/share/doc/groonga/ja/html/_sources/news.txt +45 -1
  151. data/vendor/local/share/doc/groonga/ja/html/_sources/tutorial/data.txt +112 -33
  152. data/vendor/local/share/doc/groonga/ja/html/_sources/tutorial/introduction.txt +109 -99
  153. data/vendor/local/share/doc/groonga/ja/html/_sources/tutorial/network.txt +76 -40
  154. data/vendor/local/share/doc/groonga/ja/html/_sources/type.txt +30 -21
  155. data/vendor/local/share/doc/groonga/ja/html/_static/favicon.ico +0 -0
  156. data/vendor/local/share/doc/groonga/ja/html/_static/groonga.css +309 -101
  157. data/vendor/local/share/doc/groonga/ja/html/_static/jquery.js +4 -154
  158. data/vendor/local/share/doc/groonga/ja/html/_static/logo.png +0 -0
  159. data/vendor/local/share/doc/groonga/ja/html/_static/navigation-bar.png +0 -0
  160. data/vendor/local/share/doc/groonga/ja/html/_static/underscore.js +29 -21
  161. data/vendor/local/share/doc/groonga/ja/html/characteristic.html +1 -1
  162. data/vendor/local/share/doc/groonga/ja/html/command_version.html +1 -1
  163. data/vendor/local/share/doc/groonga/ja/html/commands/cache_limit.html +1 -1
  164. data/vendor/local/share/doc/groonga/ja/html/commands/check.html +1 -1
  165. data/vendor/local/share/doc/groonga/ja/html/commands/clearlock.html +1 -1
  166. data/vendor/local/share/doc/groonga/ja/html/commands/column_create.html +1 -1
  167. data/vendor/local/share/doc/groonga/ja/html/commands/column_list.html +1 -1
  168. data/vendor/local/share/doc/groonga/ja/html/commands/column_remove.html +1 -1
  169. data/vendor/local/share/doc/groonga/ja/html/commands/define_selector.html +1 -1
  170. data/vendor/local/share/doc/groonga/ja/html/commands/defrag.html +1 -1
  171. data/vendor/local/share/doc/groonga/ja/html/commands/delete.html +1 -1
  172. data/vendor/local/share/doc/groonga/ja/html/commands/dump.html +1 -1
  173. data/vendor/local/share/doc/groonga/ja/html/commands/load.html +1 -1
  174. data/vendor/local/share/doc/groonga/ja/html/commands/log_level.html +1 -1
  175. data/vendor/local/share/doc/groonga/ja/html/commands/log_put.html +1 -1
  176. data/vendor/local/share/doc/groonga/ja/html/commands/log_reopen.html +1 -1
  177. data/vendor/local/share/doc/groonga/ja/html/commands/quit.html +1 -1
  178. data/vendor/local/share/doc/groonga/ja/html/commands/select.html +1 -1
  179. data/vendor/local/share/doc/groonga/ja/html/commands/shutdown.html +1 -1
  180. data/vendor/local/share/doc/groonga/ja/html/commands/status.html +1 -1
  181. data/vendor/local/share/doc/groonga/ja/html/commands/suggest.html +19 -1
  182. data/vendor/local/share/doc/groonga/ja/html/commands/table_create.html +1 -1
  183. data/vendor/local/share/doc/groonga/ja/html/commands/table_list.html +1 -1
  184. data/vendor/local/share/doc/groonga/ja/html/commands/table_remove.html +1 -1
  185. data/vendor/local/share/doc/groonga/ja/html/commands/view_add.html +1 -1
  186. data/vendor/local/share/doc/groonga/ja/html/commands.html +1 -1
  187. data/vendor/local/share/doc/groonga/ja/html/community.html +3 -3
  188. data/vendor/local/share/doc/groonga/ja/html/contribution/development/com.html +1 -1
  189. data/vendor/local/share/doc/groonga/ja/html/contribution/development/document.html +1 -1
  190. data/vendor/local/share/doc/groonga/ja/html/contribution/development/query.html +1 -1
  191. data/vendor/local/share/doc/groonga/ja/html/contribution/development/test.html +1 -1
  192. data/vendor/local/share/doc/groonga/ja/html/contribution/development.html +1 -1
  193. data/vendor/local/share/doc/groonga/ja/html/contribution/documentation/c-api.html +1 -1
  194. data/vendor/local/share/doc/groonga/ja/html/contribution/documentation/i18n.html +1 -1
  195. data/vendor/local/share/doc/groonga/ja/html/contribution/documentation.html +1 -1
  196. data/vendor/local/share/doc/groonga/ja/html/contribution/report.html +1 -1
  197. data/vendor/local/share/doc/groonga/ja/html/contribution.html +1 -1
  198. data/vendor/local/share/doc/groonga/ja/html/executables/grnslap.html +1 -1
  199. data/vendor/local/share/doc/groonga/ja/html/executables/grntest.html +1 -1
  200. data/vendor/local/share/doc/groonga/ja/html/executables/groonga-http.html +1 -1
  201. data/vendor/local/share/doc/groonga/ja/html/executables/groonga-suggest-create-dataset.html +1 -1
  202. data/vendor/local/share/doc/groonga/ja/html/executables/groonga.html +1 -1
  203. data/vendor/local/share/doc/groonga/ja/html/executables.html +1 -1
  204. data/vendor/local/share/doc/groonga/ja/html/expr.html +1 -1
  205. data/vendor/local/share/doc/groonga/ja/html/functions/edit_distance.html +1 -1
  206. data/vendor/local/share/doc/groonga/ja/html/functions/geo_distance.html +1 -1
  207. data/vendor/local/share/doc/groonga/ja/html/functions/geo_in_circle.html +1 -1
  208. data/vendor/local/share/doc/groonga/ja/html/functions/geo_in_rectangle.html +1 -1
  209. data/vendor/local/share/doc/groonga/ja/html/functions/now.html +1 -1
  210. data/vendor/local/share/doc/groonga/ja/html/functions/rand.html +1 -1
  211. data/vendor/local/share/doc/groonga/ja/html/functions.html +1 -1
  212. data/vendor/local/share/doc/groonga/ja/html/genindex.html +1 -1
  213. data/vendor/local/share/doc/groonga/ja/html/geolocation_search.html +1 -1
  214. data/vendor/local/share/doc/groonga/ja/html/index.html +25 -18
  215. data/vendor/local/share/doc/groonga/ja/html/indexing.html +1 -1
  216. data/vendor/local/share/doc/groonga/ja/html/install.html +72 -22
  217. data/vendor/local/share/doc/groonga/ja/html/limitations.html +1 -1
  218. data/vendor/local/share/doc/groonga/ja/html/log.html +1 -1
  219. data/vendor/local/share/doc/groonga/ja/html/news/0.x.html +1 -1
  220. data/vendor/local/share/doc/groonga/ja/html/news/1.0.x.html +1 -1
  221. data/vendor/local/share/doc/groonga/ja/html/news/1.1.x.html +1 -1
  222. data/vendor/local/share/doc/groonga/ja/html/news/1.2.x.html +1 -1
  223. data/vendor/local/share/doc/groonga/ja/html/news/senna.html +1 -1
  224. data/vendor/local/share/doc/groonga/ja/html/news.html +60 -14
  225. data/vendor/local/share/doc/groonga/ja/html/objects.inv +0 -0
  226. data/vendor/local/share/doc/groonga/ja/html/output.html +1 -1
  227. data/vendor/local/share/doc/groonga/ja/html/pseudo_column.html +1 -1
  228. data/vendor/local/share/doc/groonga/ja/html/reference.html +1 -1
  229. data/vendor/local/share/doc/groonga/ja/html/search.html +1 -1
  230. data/vendor/local/share/doc/groonga/ja/html/searchindex.js +1 -1
  231. data/vendor/local/share/doc/groonga/ja/html/spec/search.html +1 -1
  232. data/vendor/local/share/doc/groonga/ja/html/spec.html +1 -1
  233. data/vendor/local/share/doc/groonga/ja/html/suggest/completion.html +1 -1
  234. data/vendor/local/share/doc/groonga/ja/html/suggest/correction.html +1 -1
  235. data/vendor/local/share/doc/groonga/ja/html/suggest/introduction.html +1 -1
  236. data/vendor/local/share/doc/groonga/ja/html/suggest/suggestion.html +1 -1
  237. data/vendor/local/share/doc/groonga/ja/html/suggest/tutorial.html +1 -1
  238. data/vendor/local/share/doc/groonga/ja/html/suggest.html +1 -1
  239. data/vendor/local/share/doc/groonga/ja/html/troubleshooting/different_results_with_the_same_keyword.html +1 -1
  240. data/vendor/local/share/doc/groonga/ja/html/troubleshooting.html +1 -1
  241. data/vendor/local/share/doc/groonga/ja/html/tutorial/data.html +141 -53
  242. data/vendor/local/share/doc/groonga/ja/html/tutorial/drilldown.html +1 -1
  243. data/vendor/local/share/doc/groonga/ja/html/tutorial/index.html +1 -1
  244. data/vendor/local/share/doc/groonga/ja/html/tutorial/introduction.html +108 -102
  245. data/vendor/local/share/doc/groonga/ja/html/tutorial/lexicon.html +1 -1
  246. data/vendor/local/share/doc/groonga/ja/html/tutorial/match_columns.html +1 -1
  247. data/vendor/local/share/doc/groonga/ja/html/tutorial/micro_blog.html +2 -2
  248. data/vendor/local/share/doc/groonga/ja/html/tutorial/network.html +92 -55
  249. data/vendor/local/share/doc/groonga/ja/html/tutorial/patricia_trie.html +1 -1
  250. data/vendor/local/share/doc/groonga/ja/html/tutorial/query_expansion.html +1 -1
  251. data/vendor/local/share/doc/groonga/ja/html/tutorial/search.html +5 -5
  252. data/vendor/local/share/doc/groonga/ja/html/tutorial.html +21 -14
  253. data/vendor/local/share/doc/groonga/ja/html/type.html +30 -22
  254. data/vendor/local/share/doc/groonga/source/commands/suggest.txt +19 -0
  255. data/vendor/local/share/doc/groonga/source/community.txt +2 -2
  256. data/vendor/local/share/doc/groonga/source/example/tutorial/data-1.log +2 -15
  257. data/vendor/local/share/doc/groonga/source/example/tutorial/data-2.log +11 -7
  258. data/vendor/local/share/doc/groonga/source/example/tutorial/data-3.log +13 -7
  259. data/vendor/local/share/doc/groonga/source/example/tutorial/data-4.log +13 -0
  260. data/vendor/local/share/doc/groonga/source/example/tutorial/data-5.log +13 -0
  261. data/vendor/local/share/doc/groonga/source/example/tutorial/data-6.log +13 -0
  262. data/vendor/local/share/doc/groonga/source/example/tutorial/data-7.log +10 -0
  263. data/vendor/local/share/doc/groonga/source/example/tutorial/data-8.log +10 -0
  264. data/vendor/local/share/doc/groonga/source/example/tutorial/introduction-1.log +0 -2
  265. data/vendor/local/share/doc/groonga/source/example/tutorial/introduction-10.log +2 -2
  266. data/vendor/local/share/doc/groonga/source/example/tutorial/introduction-11.log +2 -2
  267. data/vendor/local/share/doc/groonga/source/example/tutorial/introduction-12.log +2 -2
  268. data/vendor/local/share/doc/groonga/source/example/tutorial/introduction-13.log +2 -2
  269. data/vendor/local/share/doc/groonga/source/example/tutorial/introduction-14.log +2 -6
  270. data/vendor/local/share/doc/groonga/source/example/tutorial/introduction-15.log +6 -2
  271. data/vendor/local/share/doc/groonga/source/example/tutorial/introduction-16.log +2 -2
  272. data/vendor/local/share/doc/groonga/source/example/tutorial/introduction-17.log +2 -2
  273. data/vendor/local/share/doc/groonga/source/example/tutorial/introduction-18.log +5 -0
  274. data/vendor/local/share/doc/groonga/source/example/tutorial/introduction-2.log +3 -2
  275. data/vendor/local/share/doc/groonga/source/example/tutorial/introduction-3.log +2 -2
  276. data/vendor/local/share/doc/groonga/source/example/tutorial/introduction-4.log +1 -3
  277. data/vendor/local/share/doc/groonga/source/example/tutorial/introduction-5.log +4 -2
  278. data/vendor/local/share/doc/groonga/source/example/tutorial/introduction-6.log +13 -2
  279. data/vendor/local/share/doc/groonga/source/example/tutorial/introduction-7.log +2 -13
  280. data/vendor/local/share/doc/groonga/source/example/tutorial/introduction-8.log +2 -2
  281. data/vendor/local/share/doc/groonga/source/example/tutorial/introduction-9.log +2 -2
  282. data/vendor/local/share/doc/groonga/source/example/tutorial/network-1.log +1 -1
  283. data/vendor/local/share/doc/groonga/source/example/tutorial/network-3.log +6 -6
  284. data/vendor/local/share/doc/groonga/source/install.txt +72 -8
  285. data/vendor/local/share/doc/groonga/source/news.txt +45 -1
  286. data/vendor/local/share/doc/groonga/source/tutorial/data.txt +112 -33
  287. data/vendor/local/share/doc/groonga/source/tutorial/introduction.txt +109 -99
  288. data/vendor/local/share/doc/groonga/source/tutorial/network.txt +76 -40
  289. data/vendor/local/share/doc/groonga/source/type.txt +30 -21
  290. data/vendor/local/share/groonga/html/admin/css/admin.css +1 -1
  291. data/vendor/local/share/groonga/html/admin/favicon.ico +0 -0
  292. data/vendor/local/share/groonga/html/admin/favicon.png +0 -0
  293. data/vendor/local/share/groonga/html/admin/favicon.svg +107 -547
  294. data/vendor/local/share/groonga/html/admin/images/groonga.png +0 -0
  295. data/vendor/local/share/groonga/html/admin/index.html +1 -1
  296. data/vendor/local/share/groonga/images/logo/groonga-icon-foreground-white.png +0 -0
  297. data/vendor/local/share/groonga/images/logo/groonga-icon-foreground-white.svg +118 -0
  298. data/vendor/local/share/groonga/images/logo/groonga-icon-full-size.png +0 -0
  299. data/vendor/local/share/groonga/images/logo/groonga-icon-full-size.svg +97 -0
  300. data/vendor/local/share/groonga/images/logo/groonga-icon.png +0 -0
  301. data/vendor/local/share/groonga/images/logo/groonga-icon.svg +93 -0
  302. data/vendor/local/share/groonga/images/logo/groonga-logo-foreground-white.png +0 -0
  303. data/vendor/local/share/groonga/images/logo/groonga-logo-foreground-white.svg +108 -0
  304. data/vendor/local/share/groonga/images/logo/groonga-logo.png +0 -0
  305. data/vendor/local/share/groonga/images/logo/groonga-logo.svg +118 -0
  306. data/vendor/local/share/groonga/images/logo/groonga-powered-by-banner-bar-foreground-white.png +0 -0
  307. data/vendor/local/share/groonga/images/logo/groonga-powered-by-banner-bar-foreground-white.svg +170 -0
  308. data/vendor/local/share/groonga/images/logo/groonga-powered-by-banner-bar.png +0 -0
  309. data/vendor/local/share/groonga/images/logo/groonga-powered-by-banner-bar.svg +186 -0
  310. data/vendor/local/share/groonga/images/logo/groonga-powered-by-banner-foreground-white.png +0 -0
  311. data/vendor/local/share/groonga/images/logo/groonga-powered-by-banner-foreground-white.svg +183 -0
  312. data/vendor/local/share/groonga/images/logo/groonga-powered-by-banner-large.png +0 -0
  313. data/vendor/local/share/groonga/images/logo/groonga-powered-by-banner-large.svg +179 -0
  314. data/vendor/local/share/groonga/images/logo/groonga-powered-by-banner.png +0 -0
  315. data/vendor/local/share/groonga/images/logo/groonga-powered-by-banner.svg +201 -0
  316. data/vendor/local/share/groonga/images/logo/mroonga-icon-foreground-white.png +0 -0
  317. data/vendor/local/share/groonga/images/logo/mroonga-icon-foreground-white.svg +106 -0
  318. data/vendor/local/share/groonga/images/logo/mroonga-icon-full-size.png +0 -0
  319. data/vendor/local/share/groonga/images/logo/mroonga-icon-full-size.svg +97 -0
  320. data/vendor/local/share/groonga/images/logo/mroonga-icon.png +0 -0
  321. data/vendor/local/share/groonga/images/logo/mroonga-icon.svg +93 -0
  322. data/vendor/local/share/groonga/images/logo/mroonga-logo-foreground-white.png +0 -0
  323. data/vendor/local/share/groonga/images/logo/mroonga-logo-foreground-white.svg +122 -0
  324. data/vendor/local/share/groonga/images/logo/mroonga-logo.png +0 -0
  325. data/vendor/local/share/groonga/images/logo/mroonga-logo.svg +106 -0
  326. data/vendor/local/share/groonga/images/logo/nroonga-icon-foreground-white.png +0 -0
  327. data/vendor/local/share/groonga/images/logo/nroonga-icon-foreground-white.svg +106 -0
  328. data/vendor/local/share/groonga/images/logo/nroonga-icon-full-size.png +0 -0
  329. data/vendor/local/share/groonga/images/logo/nroonga-icon-full-size.svg +107 -0
  330. data/vendor/local/share/groonga/images/logo/nroonga-icon.png +0 -0
  331. data/vendor/local/share/groonga/images/logo/nroonga-icon.svg +93 -0
  332. data/vendor/local/share/groonga/images/logo/nroonga-logo-foreground-white.png +0 -0
  333. data/vendor/local/share/groonga/images/logo/nroonga-logo-foreground-white.svg +122 -0
  334. data/vendor/local/share/groonga/images/logo/nroonga-logo.png +0 -0
  335. data/vendor/local/share/groonga/images/logo/nroonga-logo.svg +117 -0
  336. data/vendor/local/share/groonga/images/logo/rroonga-icon-foreground-white.png +0 -0
  337. data/vendor/local/share/groonga/images/logo/rroonga-icon-foreground-white.svg +106 -0
  338. data/vendor/local/share/groonga/images/logo/rroonga-icon-full-size.png +0 -0
  339. data/vendor/local/share/groonga/images/logo/rroonga-icon-full-size.svg +107 -0
  340. data/vendor/local/share/groonga/images/logo/rroonga-icon.png +0 -0
  341. data/vendor/local/share/groonga/images/logo/rroonga-icon.svg +93 -0
  342. data/vendor/local/share/groonga/images/logo/rroonga-logo-foreground-white.png +0 -0
  343. data/vendor/local/share/groonga/images/logo/rroonga-logo-foreground-white.svg +122 -0
  344. data/vendor/local/share/groonga/images/logo/rroonga-logo.png +0 -0
  345. data/vendor/local/share/groonga/images/logo/rroonga-logo.svg +117 -0
  346. data/vendor/local/share/man/ja/man1/groonga.1 +510 -214
  347. data/vendor/local/share/man/man1/groonga.1 +510 -211
  348. metadata +62 -15
  349. data/vendor/local/bin/groonga-query-log-analyzer +0 -1419
  350. data/vendor/local/share/doc/groonga/en/html/_static/default.css +0 -278
  351. data/vendor/local/share/doc/groonga/en/html/_static/footer-bar.png +0 -0
  352. data/vendor/local/share/doc/groonga/en/html/_static/menu-header.png +0 -0
  353. data/vendor/local/share/doc/groonga/en/html/_static/sidebar.js +0 -151
  354. data/vendor/local/share/doc/groonga/ja/html/_static/default.css +0 -278
  355. data/vendor/local/share/doc/groonga/ja/html/_static/footer-bar.png +0 -0
  356. data/vendor/local/share/doc/groonga/ja/html/_static/menu-header.png +0 -0
  357. data/vendor/local/share/doc/groonga/ja/html/_static/sidebar.js +0 -151
@@ -8,46 +8,48 @@
8
8
  Basic operations
9
9
  ================
10
10
 
11
- The groonga package provides a C library (libgroonga) and a command line tool (groonga). This tutorial explains how to use the groonga command, with which you can create/operate databases, start a server, establish a connection with a server, etc.
11
+ A groonga package provides a C library (libgroonga) and a command line tool (groonga). This tutorial explains how to use the command line tool, with which you can create/operate databases, start a server, establish a connection with a server, etc.
12
12
 
13
13
  Create a database
14
14
  -----------------
15
15
 
16
- You can create a new database with the following command.
16
+ The first step to using groonga is to create a new database. The following shows how to do it.
17
17
 
18
18
  Form::
19
19
 
20
- groonga -n DB_PATH_NAME
20
+ groonga -n DB_PATH
21
21
 
22
- The '-n' option specifies to create a new database. DB_PATH_NAME specifies the path of the new database. Note that this command fails if the specified path already exists.
22
+ The `-n` option specifies to create a new database and DB_PATH specifies the path of the new database. Actually, a database consists of a series of files and DB_PATH specifies the file which will be the entrance to the new database. DB_PATH also specifies the path prefix for other files. Note that database creation fails if DB_PATH points to an existing file.
23
23
 
24
- This command creates a database and then enters into interactive mode in which groonga prompts you to enter commands for operating that database. You can terminate this mode with Ctrl-d.
24
+ This command creates a new database and then enters into interactive mode in which groonga prompts you to enter commands for operating that database. You can terminate this mode with Ctrl-d.
25
25
 
26
- Execution example::
26
+ .. groonga-command
27
+ .. include:: ../example/tutorial/introduction-1.log
28
+ .. .. % groonga -n /tmp/groonga-databases/introduction.db
27
29
 
28
- % groonga -n /tmp/tutorial.db
29
- > Ctrl-d
30
- %
30
+ After this database creation, you can find a series of files in /tmp/groonga-databases.
31
31
 
32
32
  Operate a database
33
33
  ------------------
34
34
 
35
+ The following shows how to operate an existing database.
36
+
35
37
  Form::
36
38
 
37
- groonga DB_PATH_NAME [COMMAND]
39
+ groonga DB_PATH [COMMAND]
38
40
 
39
- DB_PATH_NAME specifies the path of a target database.
41
+ DB_PATH specifies the path of a target database. This command fails if the specified database does not exist.
40
42
 
41
- If COMMAND is specified, groonga executes COMMAND and returns the result. Otherwise, groonga starts in interactive mode that reads commands from the standard input and execute them one by one. This tutorial focuses on the interactive mode.
43
+ If COMMAND is specified, groonga executes COMMAND and returns the result. Otherwise, groonga starts in interactive mode that reads commands from the standard input and executes them one by one. This tutorial focuses on the interactive mode.
42
44
 
43
- Let's try to see the status of a groonga process by using a :doc:`/commands/status` command.
45
+ Let's see the status of a groonga process by using a :doc:`/commands/status` command.
44
46
 
45
47
  .. groonga-command
46
- .. include:: ../example/tutorial/introduction-1.log
47
- .. .. % groonga -n /tmp/groonga-databases/introduction.db
48
+ .. include:: ../example/tutorial/introduction-2.log
49
+ .. .. % groonga /tmp/groonga-databases/introduction.db
48
50
  .. status
49
51
 
50
- As shown in the above example, a command basically returns a JSON array. The first element contains an error code, execution time, etc. The second element is the result of an operation.
52
+ As shown in the above example, a command returns a JSON array. The first element contains an error code, execution time, etc. The second element is the result of an operation.
51
53
 
52
54
  Command format
53
55
  --------------
@@ -87,84 +89,54 @@ Basic commands
87
89
  Create a table
88
90
  --------------
89
91
 
90
- A :doc:`/commands/table_create` command creates a table.
92
+ A :doc:`/commands/table_create` command creates a new table.
91
93
 
92
- In most cases, a table of groonga has a primary key which must be specified with its data type and index type.
94
+ In most cases, a table has a primary key which must be specified with its data type and index type.
93
95
 
94
- There are various data types such as integers, floating-point numbers, etc. The index type determines the search performance and the availability of prefix searches. We will explain the details later.
96
+ There are various data types such as integers, strings, etc. See also :doc:`/type` for more details. The index type determines the search performance and the availability of prefix searches. The details will be described later.
95
97
 
96
- Let's create a 'Site' table which has a primary key of ShortText. In this example, the index type is HASH.
98
+ Let's create a table. The following example creates a table with a primary key. The `name` parameter specifies the name of the table. The `flags` parameter specifies the index type for the primary key. The `key_type` parameter specifies the data type of the primary key.
97
99
 
98
100
  .. groonga-command
99
- .. include:: ../example/tutorial/introduction-2.log
101
+ .. include:: ../example/tutorial/introduction-3.log
100
102
  .. table_create --name Site --flags TABLE_HASH_KEY --key_type ShortText
101
103
 
104
+ The second element of the result indicates that the operation succeeded.
105
+
102
106
  View a table
103
107
  ------------
104
108
 
105
- A :doc:`/commands/select` command shows contents of table.
109
+ A :doc:`/commands/select` command can enumerate records in a table.
106
110
 
107
111
  .. groonga-command
108
- .. include:: ../example/tutorial/introduction-3.log
112
+ .. include:: ../example/tutorial/introduction-4.log
109
113
  .. select --table Site
110
114
 
111
- When only a table is specified, the 'select' command returns the first (at most) 10 records of that table. "[0]" in the result shows the number of records in the 'Site' table. The next array is a list of columns. ["_id","Uint32"] is a column of UInt32, named "_id". ["_key","ShortText"] is a column of ShortText, named "_key".
115
+ When only a table name is specified with a `table` parameter, a :doc:`/commands/select` command returns the first (at most) 10 records in the table. [0] in the result shows the number of records in the table. The next array is a list of columns. ["_id","Uint32"] is a column of UInt32, named _id. ["_key","ShortText"] is a column of ShortText, named _key.
112
116
 
113
- The above two columns, '_id' and '_key', are the necessary columns. The '_id' column stores IDs those are automatically allocated by groonga. The '_key' column is associated with the primary key. You are not allowed to rename these columns.
117
+ The above two columns, _id and _key, are the necessary columns. The _id column stores IDs those are automatically allocated by groonga. The _key column is associated with the primary key. You are not allowed to rename these columns.
114
118
 
115
119
  Create a column
116
120
  ---------------
117
121
 
118
- A :doc:`/commands/column_create` command adds a column to a table.
119
-
120
- Let's add a column of ShortText to store titles. You may give a descriptive name 'title' to the column.
121
-
122
- .. groonga-command
123
- .. include:: ../example/tutorial/introduction-4.log
124
- .. column_create --table Site --name title --flags COLUMN_SCALAR --type ShortText
125
- .. select --table Site
126
-
127
- The COLUMN_SCALAR flag specifies to add a regular column.
128
-
129
- Create a lexicon table for full text searches
130
- ---------------------------------------------
131
-
132
- Let's go on to how to make a full text search.
133
-
134
- Groonga uses an inverted index to provide fast full text search. So, the first step is to create a lexicon table which stores an inverted index, also known as postings lists. The primary key of this table is associated with a vocabulary made up of index terms and each record stores postings lists for one index term.
122
+ A :doc:`/commands/column_create` command creates a new column.
135
123
 
136
- The following shows a command which creates a lexicon table named 'Terms'. The data type of its primary key is ShortText.
124
+ Let's add a column. The following example adds a column to the Site table. The `table` parameter specifies the target table. The `name` parameter specifies the name of the column. The `type` parameter specifies the data type of the column.
137
125
 
138
126
  .. groonga-command
139
127
  .. include:: ../example/tutorial/introduction-5.log
140
- .. table_create --name Terms --flags TABLE_PAT_KEY|KEY_NORMALIZE --key_type ShortText --default_tokenizer TokenBigram
141
-
142
- The table_create command takes many parameters but you don't need to understand all of them. Please skip the next paragraph if you are not interested in how it works.
143
-
144
- The 'TABLE_PAT_KEY' flag specifies to store index terms in a patricia trie. The 'KEY_NORMALIZE' flag specifies to normalize index terms. In this example, both flags are validated by using a '|'. The 'default_tokenizer' parameter specifies a method for tokenizing text. This example specifies 'TokenBigram' that is generally called 'N-gram'.
145
-
146
- Create an index column for full text search
147
- -------------------------------------------
148
-
149
- The second step is to create an index column, which allows you to search records from its associated column. That is to say this step specifies which column needs an index.
150
-
151
- Let's create an index column for the 'title' column in the 'Site' table.
152
-
153
- .. groonga-command
154
- .. include:: ../example/tutorial/introduction-6.log
155
- .. column_create --table Terms --name blog_title --flags COLUMN_INDEX|WITH_POSITION --type Site --source title
156
-
157
- This command creates an index column 'blog_title' in the 'Terms' table. The '--type' option specifies a target table and the '--source' option specifies a target column. Then, the 'COLUMN_INDEX' flag specifies to create an index column and the 'WITH_POSITION' flag specifies to create a full inverted index, which contains the positions of each index term. This combination 'COLUMN_INDEX|WITH_POSITION' is recommended for the general purpose.
128
+ .. column_create --table Site --name title --type ShortText
129
+ .. select --table Site
158
130
 
159
- Load data
160
- ---------
131
+ Load records
132
+ ------------
161
133
 
162
134
  A :doc:`/commands/load` command loads JSON-formatted records into a table.
163
135
 
164
- The following adds nine records to the 'Site' table.
136
+ The following example loads nine records into the Site table.
165
137
 
166
138
  .. groonga-command
167
- .. include:: ../example/tutorial/introduction-7.log
139
+ .. include:: ../example/tutorial/introduction-6.log
168
140
  .. load --table Site
169
141
  .. [
170
142
  .. {"_key":"http://example.org/","title":"This is test record 1!"},
@@ -178,99 +150,137 @@ The following adds nine records to the 'Site' table.
178
150
  .. {"_key":"http://example.com/vdw","title":"test test record nine."},
179
151
  .. ]
180
152
 
153
+ The second element of the result indicates how many records were successfully loaded. In this case, all the records are successfully loaded.
154
+
181
155
  Let's make sure that these records are correctly stored.
182
156
 
183
157
  .. groonga-command
184
- .. include:: ../example/tutorial/introduction-8.log
158
+ .. include:: ../example/tutorial/introduction-7.log
185
159
  .. select --table Site
186
160
 
187
- Search data
188
- -----------
161
+ Get a record
162
+ ------------
163
+
164
+ A :doc:`/commands/select` command can search records in a table.
189
165
 
190
- Before a full text search, let's try to search data by '_id' and '_key'. These columns work as unique keys.
166
+ If a search condition is specified with a `query` parameter, a :doc:`/commands/select` command searches records matching the search condition and returns the matched records.
191
167
 
192
- You can search records by using a 'select' command with a 'query' parameter.
168
+ Let's get a record having a specified record ID. The following example gets the first record in the Site table. More precisely, the `query` parameter specifies a record whose _id column stores 1.
193
169
 
194
170
  .. groonga-command
195
- .. include:: ../example/tutorial/introduction-9.log
171
+ .. include:: ../example/tutorial/introduction-8.log
196
172
  .. select --table Site --query _id:1
197
173
 
198
- '_id:1' specifies to search a record whose ID is 1.
174
+ Next, let's get a record having a specified key. The following example gets the record whose primary key is "http://example.org/". More precisely, the `query` parameter specifies a record whose _key column stores "http://example.org/".
199
175
 
200
- Next, let's search a record by a primary key.
176
+ .. groonga-command
177
+ .. include:: ../example/tutorial/introduction-9.log
178
+ .. select --table Site --query '_key:"http://example.org/"'
179
+
180
+ Create a lexicon table for full text search
181
+ -------------------------------------------
182
+
183
+ Let's go on to how to make full text search.
184
+
185
+ Groonga uses an inverted index to provide fast full text search. So, the first step is to create a lexicon table which stores an inverted index, also known as postings lists. The primary key of this table is associated with a vocabulary made up of index terms and each record stores postings lists for one index term.
186
+
187
+ The following shows a command which creates a lexicon table named Terms. The data type of its primary key is ShortText.
201
188
 
202
189
  .. groonga-command
203
190
  .. include:: ../example/tutorial/introduction-10.log
204
- .. select --table Site --query "_key:\"http://example.org/\""
191
+ .. table_create --name Terms --flags TABLE_PAT_KEY|KEY_NORMALIZE --key_type ShortText --default_tokenizer TokenBigram
192
+
193
+ The :doc:`/commands/table_create` command takes many parameters but you don't need to understand all of them. Please skip the next paragraph if you are not interested in how it works.
194
+
195
+ The TABLE_PAT_KEY flag specifies to store index terms in a patricia trie. The KEY_NORMALIZE flag specifies to normalize index terms. In this example, both flags are validated by using a '|'. The `default_tokenizer` parameter specifies the method for tokenizing text. This example uses TokenBigram that is generally called N-gram.
196
+
197
+ Create an index column for full text search
198
+ -------------------------------------------
199
+
200
+ The second step is to create an index column, which allows you to search records from its associated column. That is to say this step specifies which column needs an index.
201
+
202
+ Let's create an index column. The following example creates an index column for a column in the Site table.
205
203
 
206
- '_key:\"http://example.org/\"' specifies to search a record whose primary key is "http://example.org/".
204
+ .. groonga-command
205
+ .. include:: ../example/tutorial/introduction-11.log
206
+ .. column_create --table Terms --name blog_title --flags COLUMN_INDEX|WITH_POSITION --type Site --source title
207
+
208
+ The `table` parameter specifies the index table and the `name` parameter specifies the index column. The `type` parameter specifies the target table and the `source` parameter specifies the target column. The COLUMN_INDEX flag specifies to create an index column and the WITH_POSITION flag specifies to create a full inverted index, which contains the positions of each index term. This combination, COLUMN_INDEX|WITH_POSITION, is recommended for the general purpose.
209
+
210
+ .. note::
211
+
212
+ You can create a lexicon table and index columns before/during/after loading records. If a target column already has records, groonga creates an inverted index in a static manner. In contrast, if you load records into an already indexed column, groonga updates the inverted index in a dynamic manner.
207
213
 
208
214
  Full text search
209
215
  ----------------
210
216
 
211
- It's time to make a full text search. You can make a full text search query with the same 'query' parameter.
217
+ It's time. You can make full text search with a :doc:`/commands/select` command.
218
+
219
+ A query for full text search is specified with a `query` parameter. The following example searches records whose "title" column contains "this". The '@' specifies to make full text search. Note that a lower case query matches upper case and capitalized terms in a record if KEY_NORMALIZE was specified when creating a lexcon table.
212
220
 
213
221
  .. groonga-command
214
- .. include:: ../example/tutorial/introduction-11.log
222
+ .. include:: ../example/tutorial/introduction-12.log
215
223
  .. select --table Site --query title:@this
216
224
 
217
- This command searches records whose 'title' column contains a string 'this'. In this case, only one record matches this query. Note that the lower case query 'this' matches a capitalized 'This' in the 1st record because 'KEY_NORMALIZE' was specified in lexicon column creation.
225
+ In this example, the first record matches the query because its title contains "This", that is the capitalized form of the query.
218
226
 
219
- The 'select' command has an optional parameter 'match_columns'. This parameter specifies default target columns and it is used when target columns are not specified in a query.[1]_
227
+ A :doc:`/commands/select` command accepts an optional parameter, named `match_columns`, that specifies the default target columns. This parameter is used if target columns are not specified in a query. [#]_
220
228
 
221
- A combination of '--match_columns title' and '--query this' brings you the same result that '--query title:@this' does.
229
+ The combination of "`--match_columns` title" and "`--query` this" brings you the same result that "`--query` title:@this" does.
222
230
 
223
231
  .. groonga-command
224
- .. include:: ../example/tutorial/introduction-12.log
232
+ .. include:: ../example/tutorial/introduction-13.log
225
233
  .. select --table Site --match_columns title --query this
226
234
 
227
235
  Specify output columns
228
236
  ----------------------
229
237
 
230
- An 'output_columns' parameter in a 'select' command specifies columns to be shown in the search result. If you want to specify more than one columns, please separate column names by commas (,).
238
+ An `output_columns` parameter of a :doc:`/commands/select` command specifies columns to appear in the search result. If you want to specify more than one columns, please separate column names by commas (',').
231
239
 
232
240
  .. groonga-command
233
- .. include:: ../example/tutorial/introduction-13.log
241
+ .. include:: ../example/tutorial/introduction-14.log
234
242
  .. select --table Site --output_columns _key,title,_score --query title:@test
235
243
 
236
- This command specifies three output columns including the '_score' column, which stores the relevance score of each record.
244
+ This example specifies three output columns including the _score column, which stores the relevance score of each record.
237
245
 
238
246
  Specify output ranges
239
247
  ---------------------
240
248
 
241
- A 'select' command returns a part of its search result if 'offset' and/or 'limit' parameters are specified. These parameters are useful to paginate a search result, a widely-used interface which shows a search result on a page by page basis.
249
+ A :doc:`/commands/select` command returns a part of its search result if `offset` and/or `limit` parameters are specified. These parameters are useful to paginate a search result, a widely-used interface which shows a search result on a page by page basis.
242
250
 
243
- An 'offset' parameter specifies the starting point and a 'limit' parameter specifies the maximum number of records to be returned. If you need the first record in a search result, the offset parameter must be 0 or omitted.
251
+ An `offset` parameter specifies the starting point and a `limit` parameter specifies the maximum number of records to be returned. If you need the first record in a search result, the offset parameter must be 0 or omitted.
244
252
 
245
253
  .. groonga-command
246
- .. include:: ../example/tutorial/introduction-14.log
254
+ .. include:: ../example/tutorial/introduction-15.log
247
255
  .. select --table Site --offset 0 --limit 3
248
256
  .. select --table Site --offset 3 --limit 3
249
257
  .. select --table Site --offset 7 --limit 3
250
258
 
251
- Sort
252
- ----
259
+ Sort a search result
260
+ --------------------
261
+
262
+ A :doc:`/commands/select` command sorts its result when used with a `sortby` parameter.
253
263
 
254
- A 'select' command sorts its result when used with a 'sortby' parameter.
264
+ A `sortby` parameter specifies a column as a sorting creteria. A search result is arranged in ascending order of the column values. If you want to sort a search result in reverse order, please add a leading hyphen ('-') to the column name in a parameter.
255
265
 
256
- A 'sortby' parameter specifies a column as a sorting creteria. A search result is arranged in ascending order of the column values. If you want to sort a search result in reverse order, please add a leading hyphen (-) to the column name of a parameter.
266
+ The following example shows records in the Site table in reverse order.
257
267
 
258
268
  .. groonga-command
259
- .. include:: ../example/tutorial/introduction-15.log
269
+ .. include:: ../example/tutorial/introduction-16.log
260
270
  .. select --table Site --sortby -_id
261
271
 
262
- You can use the '_score' column as a sorting criteria for ranking a search result.
272
+ The next example uses the _score column as the sorting criteria for ranking the search result. The result is sorted in relevance order.
263
273
 
264
274
  .. groonga-command
265
- .. include:: ../example/tutorial/introduction-16.log
266
- .. select --table Site --query title:@test --output_columns _id,_score,title --sortby _score
275
+ .. include:: ../example/tutorial/introduction-17.log
276
+ .. select --table Site --query title:@test --output_columns _id,_score,title --sortby -_score
267
277
 
268
- If you want to specify more than one columns, please separate column names by commas. In such a case, a search result is sorted in order of the column values in the first column, and then records having the same values in the first column are sorted in order of the second column values.
278
+ If you want to specify more than one columns, please separate column names by commas (','). In such a case, a search result is sorted in order of the values in the first column, and then records having the same values in the first column are sorted in order of the second column values.
269
279
 
270
280
  .. groonga-command
271
- .. include:: ../example/tutorial/introduction-17.log
272
- .. select --table Site --query title:@test --output_columns _id,_score,title --sortby _score,_id
281
+ .. include:: ../example/tutorial/introduction-18.log
282
+ .. select --table Site --query title:@test --output_columns _id,_score,title --sortby -_score,_id
273
283
 
274
284
  .. rubric:: footnote
275
285
 
276
- .. [1] Currently, a 'match_columns' parameter is available iff there exists an inverted index for full text search. A 'match_columns' parameter for a regular column is not supported.
286
+ .. [#] Currently, a `match_columns` parameter is available iff there exists an inverted index for full text search. A `match_columns` parameter for a regular column is not supported.
@@ -7,25 +7,43 @@
7
7
  .. groonga-command
8
8
  .. database: tutorial
9
9
 
10
- How to use groonga with network
11
- ===============================
10
+ Remote access
11
+ =============
12
12
 
13
- You can use groonga with network. When you run groonga by using the groonga original protocol or HTTP, groonga accepts connection for network.
13
+ You can use groonga as a server which allows remote access. Groonga supports the original protocol (gqtp), the memcached binary protocol and HTTP.
14
14
 
15
- Connect with groonga's original protocol
16
- ----------------------------------------
15
+ Groonga query transfer protocol (gqtp)
16
+ --------------------------------------
17
17
 
18
- Run groonga daemon
19
- ^^^^^^^^^^^^^^^^^^
18
+ How to run a gqtp server
19
+ ^^^^^^^^^^^^^^^^^^^^^^^^
20
+
21
+ Groonga has a special protocol, named groonga query transfer ptorotocl (gqtp), for remote access to a database. The following form shows how to run groonga as a gqtp server.
22
+
23
+ Form::
24
+
25
+ groonga [-p PORT_NUMBER] -s DB_PATH
26
+
27
+ The `-s` option specifies to run groonga as a server. DB_PATH specifies the path of the existing database to be hosted. The `-p` option and its argument, PORT_NUMBER, specify the port number of the server. The default port number is 10041, which is used when you don't specify PORT_NUMBER.
28
+
29
+ The following command runs a server that listens on the default port number. The server accepts operations to the specified database.
30
+
31
+ Execution example::
32
+
33
+ % groonga -s /tmp/groonga-databases/introduction.db
34
+ Ctrl-c
35
+ %
36
+
37
+ How to run a gqtp daemon
38
+ ^^^^^^^^^^^^^^^^^^^^^^^^
39
+
40
+ You can also run a gqtp server as a daemon by using the `-d` option, instead of the `-s` option.
20
41
 
21
42
  Form::
22
43
 
23
- groonga [-p PORT_NUMBER] -d DB_PATH_NAME
44
+ groonga [-p PORT_NUMBER] -d DB_PATH
24
45
 
25
- The DB_PATH_NAME is set the full-path of existing database.
26
- With this form, you can run groonga as a daemon and connect by
27
- with groonga original protocol on PORT_NUMBER.
28
- (The port number is 10041 when you don't specify PORT_NUMBER.)
46
+ A groonga daemon prints its process ID as follows. In this example, the process ID is 12345. Then, the daemon opens a specified database and accepts operations to that database.
29
47
 
30
48
  Execution example::
31
49
 
@@ -33,20 +51,16 @@ Execution example::
33
51
  12345
34
52
  %
35
53
 
36
- Groonga shows its process ID on daemon mode.
54
+ How to run a gqtp client
55
+ ^^^^^^^^^^^^^^^^^^^^^^^^
37
56
 
38
- Connect to groonga server
39
- ^^^^^^^^^^^^^^^^^^^^^^^^^
57
+ You can run groonga as a gqtp client as follows:
40
58
 
41
59
  Form::
42
60
 
43
61
  groonga [-p PORT_NUMBER] -c [HOST_NAME_OR_IP_ADDRESS]
44
62
 
45
- This command connects to groonga server running at specified HOST_NAME_OR_IP_ADDRESS.
46
-
47
- When you don't specify HOST_NAME_OR_IP_ADDRESS, this command connects to groonga server running at localhost. When you don't specify PORT_NUMBER, 10041 is used.
48
-
49
- Groonga runs in interactive mode after connect to groonga server successfully. Groonga reads command from standard input and evaluates it repeatedly.
63
+ This command establishes a connection with a gqtp server and then enters into interactive mode. HOST_NAME_OR_IP_ADDRESS specifies the hostname or the IP address of the server. If not specifed, groonga uses the default hostname "localhost". The `-p` option and its argument, PORT_NUMBER, specify the port number of the server. If not specified, groonga uses the default port number 10041.
50
64
 
51
65
  .. groonga-command
52
66
  .. include:: ../example/tutorial/network-1.log
@@ -55,10 +69,12 @@ Groonga runs in interactive mode after connect to groonga server successfully. G
55
69
  .. .. > ctrl-d
56
70
  .. .. %
57
71
 
58
- Terminate groonga daemon
59
- ^^^^^^^^^^^^^^^^^^^^^^^^
72
+ In interactive mode, groonga reads commands from the standard input and executes them one by one.
73
+
74
+ How to terminate a gqtp server
75
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
60
76
 
61
- You can terminate groonga daemon with shutdown command.
77
+ You can terminate a gqtp server with a :doc:`/commands/shutdown` command.
62
78
 
63
79
  .. groonga-command
64
80
  .. include:: ../example/tutorial/network-2.log
@@ -66,41 +82,61 @@ You can terminate groonga daemon with shutdown command.
66
82
  .. .. > shutdown
67
83
  .. .. %
68
84
 
69
- Connect with HTTP
70
- -----------------
85
+ Memcached binary protocol
86
+ -------------------------
87
+
88
+ Groonga supports the memcached binary protocol. The following form shows how to run groonga as a memcached binary protocol server daemon.
89
+
90
+ Form::
91
+
92
+ groonga [-p PORT_NUMBER] -d --protocol memcached DB_PATH
71
93
 
72
- You need to run groonga in HTTP protocol mode when you want to use groonga via HTTP.
94
+ The `--protocol` option and its argument specify the protocol of the server. "memcached" specifies to use the memcached binary protocol.
95
+
96
+ Hypertext transfer protocol (HTTP)
97
+ -----------------------------------
98
+
99
+ How to run an HTTP server
100
+ ^^^^^^^^^^^^^^^^^^^^^^^^^
101
+
102
+ Groonga supports the hypertext transfer protocol (HTTP). The following form shows how to run groonga as an HTTP server daemon.
73
103
 
74
104
  Form::
75
105
 
76
- groonga [-p PORT_NUMBER] -d --protocol http DB_PATH_NAME
106
+ groonga [-p PORT_NUMBER] -d --protocol http DB_PATH
77
107
 
78
- `--protocol` option specifies a protocol of groonga server. `http` means that groonga accepts connections via HTTP.
108
+ The `--protocol` option and its argument specify the protocol of the server. "http" specifies to use HTTP.
79
109
 
80
- Administration tool based on HTML
81
- ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
110
+ The following command runs an HTTP server that listens on the port number 80.
82
111
 
83
- You can access administration tool based on HTML at `http://[HOST_NAME_OR_IP_ADDRESS]:[PORT_NUMBER]/` after the above command is ran. Your browser must enable JavaScript.
112
+ Execution example::
113
+
114
+ % groonga -p 80 -d --protocol http /tmp/groonga-databases/introduction.db
115
+ %
84
116
 
85
- Run command with HTTP
86
- ^^^^^^^^^^^^^^^^^^^^^
117
+ How to send a command to an HTTP server
118
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
87
119
 
88
- You can run command at `/d/COMMAND_NAME` when groonga is ran in HTTP protocol mode.
120
+ You can send a command to an HTTP server by sending a GET request to /d/COMMAND_NAME. Command parameters can be passed as parameters of the GET request. The format is "?NAME_1=VALUE_1&NAME_2=VALUE_2&...".
89
121
 
90
- Command options are passed as HTTP's GET parameters. They are in `?OPTION=VALUE&OPTION=VALUE&...` form.
122
+ The following example shows how to send commands to an HTTP server.
91
123
 
92
124
  .. groonga-command
93
125
  .. include:: ../example/tutorial/network-3.log
94
- .. .. http://[HOST_NAME_OR_IP_ADDRESS]:[PORT_NUMBER]/d/status
126
+ .. .. http://HOST_NAME_OR_IP_ADDRESS[:PORT_NUMBER]/d/status
95
127
  .. .. Executed command:
96
128
  .. status
97
129
  .. ..
98
- .. .. http://[HOST_NAME_OR_IP_ADDRESS]:[PORT_NUMBER]/d/select?table=Site&query=title:@this
130
+ .. .. http://HOST_NAME_OR_IP_ADDRESS[:PORT_NUMBER]/d/select?table=Site&query=title:@this
99
131
  .. .. Executed command:
100
132
  .. select --table Site --query title:@this
101
133
 
134
+ Administration tool (HTTP)
135
+ --------------------------
136
+
137
+ An HTTP server of groonga provides a browser based administration tool that makes database management easy. After starting an HTTP server, you can use the administration tool by accessing http://HOST_NAME_OR_IP_ADDRESS[:PORT_NUMBER]/. Note that Javascript must be enabled for the tool to work properly.
102
138
 
103
- Security
104
- --------
139
+ Security issues
140
+ ---------------
105
141
 
106
- Network service of groonga doesn't support authentication. Everyone can view and modify the database. We recommend that you restrict client accesses by IP address. You can use iptables or any similar tool for it.
142
+ Groonga servers don't support user authentication. Everyone can view and modify databases hosted by groonga servers. You are recommended to restrict IP addresses that can access groonga servers. You can use iptables or similar for this purpose.
@@ -30,75 +30,84 @@ groongaのデータベースでは、テーブルの主キーや、カラムの
30
30
 
31
31
  ``Object``
32
32
 
33
- 任意のテーブルに属する全てのレコード [#]_
33
+ 任意のテーブルに属する全てのレコードです。 [#]_
34
34
 
35
35
  ``Bool``
36
36
 
37
- bool型。trueとfalse
37
+ ブーリアン型やブール型などと呼ばれる型であり、真偽値を表します。取り得る値はtrueとfalseです。(デフォルト値: false)
38
+
39
+ :doc:`/commands/load` コマンドで値を格納するときは、false、0、空文字列のいずれかを指定するとfalseになり、それ以外を指定するとtrueになります。
38
40
 
39
41
  ``Int8``
40
42
 
41
- 8bit符号付き整数。
43
+ 8bit符号付き整数であり、-128以上127以下の整数を表します。(デフォルト値: 0)
42
44
 
43
45
  ``UInt8``
44
46
 
45
- 8bit符号なし整数。
47
+ 8bit符号なし整数であり、0以上255以下の整数を表します。(デフォルト値: 0)
46
48
 
47
49
  ``Int16``
48
50
 
49
- 16bit符号付き整数。
51
+ 16bit符号付き整数であり、-32,768以上32,767以下の整数を表します。(デフォルト値: 0)
50
52
 
51
53
  ``UInt16``
52
54
 
53
- 16bit符号なし整数。
55
+ 16bit符号なし整数であり、0以上65,535以下の整数を表します。(デフォルト値: 0)
54
56
 
55
57
  ``Int32``
56
58
 
57
- 32bit符号付き整数。
59
+ 32bit符号付き整数であり、-2,147,483,648以上2,147,483,647以下の整数を表します。(デフォルト値: 0)
58
60
 
59
61
  ``UInt32``
60
62
 
61
- 32bit符号なし整数。
63
+ 32bit符号なし整数であり、0以上4,294,967,295以下の整数を表します。(デフォルト値: 0)
62
64
 
63
65
  ``Int64``
64
66
 
65
- 64bit符号付き整数。
67
+ 64bit符号付き整数であり、-9,223,372,036,854,775,808以上9,223,372,036,854,775,807以下の整数を表します。(デフォルト値: 0)
66
68
 
67
69
  ``UInt64``
68
70
 
69
- 64bit符号なし整数。
71
+ 64bit符号なし整数であり、0以上18,446,744,073,709,551,615以下の整数を表します。(デフォルト値: 0)
70
72
 
71
73
  ``Float``
72
74
 
73
- ieee754形式の64bit浮動小数点数。
75
+ IEEE 754形式の倍精度浮動小数点数であり、実数を表します。(デフォルト値: 0.0)
76
+
77
+ IEEE 754形式の詳細については、 `IEEE 754 - Wikipedia <http://ja.wikipedia.org/wiki/IEEE_754>`_ や `IEEE 754: Standard for Binary Floating-Point <http://grouper.ieee.org/groups/754/>`_ を参照してください。
74
78
 
75
79
  ``Time``
76
80
 
77
- 1970年1月1日0時0分0秒からの経過マイクロ秒数を64bit符号付き整数で表現した値。
81
+ 日時を表す型であり、1970年1月1日0時0分0秒からの経過時間を、マイクロ秒単位で64bit符号付き整数により表現します。(デフォルト値: 0)
82
+
83
+ :doc:`/commands/load` コマンドで値を格納するときは、1970年1月1日0時0分0秒からの経過秒数を指定します。秒単位より詳細な日時を指定するには、小数を使います。
78
84
 
79
85
  ``ShortText``
80
86
 
81
- 4Kbyte以下の文字列。
87
+ 4,095バイト以下の文字列を表します。(デフォルト値: "")
82
88
 
83
89
  ``Text``
84
90
 
85
- 64Kbyte以下の文字列。
91
+ 65,535バイト以下の文字列を表します。(デフォルト値: "")
86
92
 
87
93
  ``LongText``
88
94
 
89
- 2Gbyte以下の文字列。
95
+ 2,147,483,647バイト以下の文字列を表します。(デフォルト値: "")
90
96
 
91
97
  ``TokyoGeoPoint``
92
98
 
93
- 日本測地系緯度経度座標。緯度と経度はミリ秒単位での整数。
94
- "経度のミリ秒x緯度のミリ秒"という文字列表現を持つ。
95
- 度分秒形式であれば、x度y分z秒は(((x * 60) + y) * 60 + z) * 1000という計算式で変換した値を代入します。
99
+ 旧日本測地系による経緯度であり、経度と緯度をミリ秒単位で表現した整数の組により表現します。(デフォルト値: 0x0)
100
+
101
+ 度分秒形式でx度y分z秒となる経度・緯度は、(((x * 60) + y) * 60 + z) * 1000という計算式でミリ秒単位へと変換されます。
102
+ :doc:`/commands/load` コマンドで値を格納するときは、"ミリ秒単位の経度xミリ秒単位の緯度" もしくは "経度の小数表記x緯度の小数表記" という文字列表現を使って指定します。経度と緯度の区切りとしては、'x' のほかに ',' を使うことができます。
103
+
104
+ 測地系の詳細については、 `測地系 - Wikipedia <http://ja.wikipedia.org/wiki/%E6%B8%AC%E5%9C%B0%E7%B3%BB>`_ を参照してください。
96
105
 
97
106
  ``WGS84GeoPoint``
98
107
 
99
- 世界測地系緯度経度座標。緯度と経度はミリ秒単位での整数。
100
- "経度のミリ秒x緯度のミリ秒"という文字列表現を持つ。
101
- 度分秒形式であれば、x度y分z秒は(((x * 60) + y) * 60 + z) * 1000という計算式で変換した値を代入します。
108
+ 世界測地系(World Geodetic System, WGS 84)による経緯度であり、経度と緯度をミリ秒単位で表現した整数の組により表現します。(デフォルト値: 0x0)
109
+
110
+ 度分秒形式からミリ秒形式への変換方法や :doc:`/commands/load` コマンドにおける指定方法はTokyoGeoPointと同じです。
102
111
 
103
112
  型に関する制限事項
104
113
  ------------------