rroonga 3.0.8-x64-mingw32 → 3.0.9-x64-mingw32

Sign up to get free protection for your applications and to get access to all the features.
Files changed (431) hide show
  1. checksums.yaml +4 -4
  2. data/doc/text/news.textile +15 -1
  3. data/ext/groonga/rb-grn-index-column.c +4 -0
  4. data/ext/groonga/rb-grn-object.c +2 -3
  5. data/ext/groonga/rb-grn.h +1 -1
  6. data/lib/1.9/groonga.so +0 -0
  7. data/lib/2.0/groonga.so +0 -0
  8. data/lib/2.1/groonga.so +0 -0
  9. data/lib/groonga/schema.rb +1 -1
  10. data/rroonga-build.rb +1 -1
  11. data/rroonga.gemspec +1 -1
  12. data/test/test-database.rb +74 -0
  13. data/test/test-index-column.rb +22 -0
  14. data/vendor/local/bin/groonga-benchmark.exe +0 -0
  15. data/vendor/local/bin/groonga.exe +0 -0
  16. data/vendor/local/bin/libgroonga-0.dll +0 -0
  17. data/vendor/local/bin/libmecab-1.dll +0 -0
  18. data/vendor/local/bin/libmsgpack-3.dll +0 -0
  19. data/vendor/local/bin/libmsgpackc-2.dll +0 -0
  20. data/vendor/local/bin/mecab.exe +0 -0
  21. data/vendor/local/lib/groonga/plugins/query_expanders/tsv.a +0 -0
  22. data/vendor/local/lib/groonga/plugins/query_expanders/tsv.dll +0 -0
  23. data/vendor/local/lib/groonga/plugins/query_expanders/tsv.dll.a +0 -0
  24. data/vendor/local/lib/groonga/plugins/suggest/suggest.a +0 -0
  25. data/vendor/local/lib/groonga/plugins/suggest/suggest.dll +0 -0
  26. data/vendor/local/lib/groonga/plugins/suggest/suggest.dll.a +0 -0
  27. data/vendor/local/lib/groonga/plugins/table/table.a +0 -0
  28. data/vendor/local/lib/groonga/plugins/table/table.dll +0 -0
  29. data/vendor/local/lib/groonga/plugins/table/table.dll.a +0 -0
  30. data/vendor/local/lib/groonga/plugins/tokenizers/mecab.a +0 -0
  31. data/vendor/local/lib/groonga/plugins/tokenizers/mecab.dll +0 -0
  32. data/vendor/local/lib/groonga/plugins/tokenizers/mecab.dll.a +0 -0
  33. data/vendor/local/lib/libgroonga.a +0 -0
  34. data/vendor/local/lib/libgroonga.dll.a +0 -0
  35. data/vendor/local/lib/libmecab.a +0 -0
  36. data/vendor/local/lib/libmecab.dll.a +0 -0
  37. data/vendor/local/lib/libmsgpack.a +0 -0
  38. data/vendor/local/lib/libmsgpack.dll.a +0 -0
  39. data/vendor/local/lib/libmsgpackc.a +0 -0
  40. data/vendor/local/lib/libmsgpackc.dll.a +0 -0
  41. data/vendor/local/lib/pkgconfig/groonga.pc +2 -2
  42. data/vendor/local/libexec/mecab/mecab-cost-train.exe +0 -0
  43. data/vendor/local/libexec/mecab/mecab-dict-gen.exe +0 -0
  44. data/vendor/local/libexec/mecab/mecab-dict-index.exe +0 -0
  45. data/vendor/local/libexec/mecab/mecab-system-eval.exe +0 -0
  46. data/vendor/local/libexec/mecab/mecab-test-gen.exe +0 -0
  47. data/vendor/local/share/doc/groonga/en/html/.buildinfo +1 -1
  48. data/vendor/local/share/doc/groonga/en/html/_sources/contribution/development/document.txt +3 -0
  49. data/vendor/local/share/doc/groonga/en/html/_sources/index.txt +0 -5
  50. data/vendor/local/share/doc/groonga/en/html/_sources/install/centos.txt +3 -3
  51. data/vendor/local/share/doc/groonga/en/html/_sources/install/debian.txt +3 -3
  52. data/vendor/local/share/doc/groonga/en/html/_sources/install/fedora.txt +3 -3
  53. data/vendor/local/share/doc/groonga/en/html/_sources/install/mac_os_x.txt +3 -3
  54. data/vendor/local/share/doc/groonga/en/html/_sources/install/others.txt +15 -3
  55. data/vendor/local/share/doc/groonga/en/html/_sources/install/solaris.txt +3 -3
  56. data/vendor/local/share/doc/groonga/en/html/_sources/install/ubuntu.txt +43 -3
  57. data/vendor/local/share/doc/groonga/en/html/_sources/install/windows.txt +9 -9
  58. data/vendor/local/share/doc/groonga/en/html/_sources/news.txt +54 -0
  59. data/vendor/local/share/doc/groonga/en/html/_sources/reference.txt +1 -0
  60. data/vendor/local/share/doc/groonga/en/html/_sources/reference/commands/cache_limit.txt +3 -3
  61. data/vendor/local/share/doc/groonga/en/html/_sources/reference/commands/column_create.txt +38 -30
  62. data/vendor/local/share/doc/groonga/en/html/_sources/reference/commands/normalize.txt +81 -10
  63. data/vendor/local/share/doc/groonga/en/html/_sources/reference/commands/ruby_eval.txt +13 -19
  64. data/vendor/local/share/doc/groonga/en/html/_sources/reference/commands/ruby_load.txt +71 -0
  65. data/vendor/local/share/doc/groonga/en/html/_sources/reference/commands/tokenize.txt +7 -6
  66. data/vendor/local/share/doc/groonga/en/html/_sources/reference/executables/groonga-httpd.txt +87 -33
  67. data/vendor/local/share/doc/groonga/en/html/_sources/reference/executables/groonga-suggest-create-dataset.txt +15 -2
  68. data/vendor/local/share/doc/groonga/en/html/_sources/reference/executables/groonga-suggest-httpd.txt +68 -0
  69. data/vendor/local/share/doc/groonga/en/html/_sources/reference/executables/groonga-suggest-learner.txt +40 -0
  70. data/vendor/local/share/doc/groonga/en/html/_sources/reference/executables/groonga.txt +0 -3
  71. data/vendor/local/share/doc/groonga/en/html/_sources/reference/tuning.txt +176 -0
  72. data/vendor/local/share/doc/groonga/en/html/_sources/suggest/completion.txt +69 -0
  73. data/vendor/local/share/doc/groonga/en/html/_sources/troubleshooting/mmap_cannot_allocate_memory.txt +45 -0
  74. data/vendor/local/share/doc/groonga/en/html/_static/basic.css +0 -4
  75. data/vendor/local/share/doc/groonga/en/html/characteristic.html +5 -5
  76. data/vendor/local/share/doc/groonga/en/html/community.html +5 -5
  77. data/vendor/local/share/doc/groonga/en/html/contribution.html +5 -5
  78. data/vendor/local/share/doc/groonga/en/html/contribution/development.html +5 -5
  79. data/vendor/local/share/doc/groonga/en/html/contribution/development/com.html +5 -5
  80. data/vendor/local/share/doc/groonga/en/html/contribution/development/cooperation.html +5 -5
  81. data/vendor/local/share/doc/groonga/en/html/contribution/development/document.html +7 -5
  82. data/vendor/local/share/doc/groonga/en/html/contribution/development/query.html +5 -5
  83. data/vendor/local/share/doc/groonga/en/html/contribution/development/release.html +5 -5
  84. data/vendor/local/share/doc/groonga/en/html/contribution/development/repository.html +5 -5
  85. data/vendor/local/share/doc/groonga/en/html/contribution/development/test.html +5 -5
  86. data/vendor/local/share/doc/groonga/en/html/contribution/documentation.html +5 -5
  87. data/vendor/local/share/doc/groonga/en/html/contribution/documentation/c-api.html +5 -5
  88. data/vendor/local/share/doc/groonga/en/html/contribution/documentation/i18n.html +5 -5
  89. data/vendor/local/share/doc/groonga/en/html/contribution/report.html +5 -5
  90. data/vendor/local/share/doc/groonga/en/html/development.html +10 -10
  91. data/vendor/local/share/doc/groonga/en/html/development/travis-ci.html +5 -5
  92. data/vendor/local/share/doc/groonga/en/html/genindex.html +127 -7
  93. data/vendor/local/share/doc/groonga/en/html/geolocation_search.html +5 -5
  94. data/vendor/local/share/doc/groonga/en/html/index.html +54 -42
  95. data/vendor/local/share/doc/groonga/en/html/install.html +7 -6
  96. data/vendor/local/share/doc/groonga/en/html/install/centos.html +8 -8
  97. data/vendor/local/share/doc/groonga/en/html/install/debian.html +8 -8
  98. data/vendor/local/share/doc/groonga/en/html/install/fedora.html +8 -8
  99. data/vendor/local/share/doc/groonga/en/html/install/mac_os_x.html +8 -8
  100. data/vendor/local/share/doc/groonga/en/html/install/others.html +20 -8
  101. data/vendor/local/share/doc/groonga/en/html/install/solaris.html +8 -8
  102. data/vendor/local/share/doc/groonga/en/html/install/ubuntu.html +46 -10
  103. data/vendor/local/share/doc/groonga/en/html/install/windows.html +14 -14
  104. data/vendor/local/share/doc/groonga/en/html/limitations.html +5 -5
  105. data/vendor/local/share/doc/groonga/en/html/news.html +226 -165
  106. data/vendor/local/share/doc/groonga/en/html/news/0.x.html +5 -5
  107. data/vendor/local/share/doc/groonga/en/html/news/1.0.x.html +5 -5
  108. data/vendor/local/share/doc/groonga/en/html/news/1.1.x.html +5 -5
  109. data/vendor/local/share/doc/groonga/en/html/news/1.2.x.html +5 -5
  110. data/vendor/local/share/doc/groonga/en/html/news/senna.html +5 -5
  111. data/vendor/local/share/doc/groonga/en/html/objects.inv +0 -0
  112. data/vendor/local/share/doc/groonga/en/html/reference.html +46 -36
  113. data/vendor/local/share/doc/groonga/en/html/reference/api.html +35 -35
  114. data/vendor/local/share/doc/groonga/en/html/reference/api/grn_cache.html +24 -24
  115. data/vendor/local/share/doc/groonga/en/html/reference/api/grn_column.html +24 -24
  116. data/vendor/local/share/doc/groonga/en/html/reference/api/grn_command_version.html +24 -24
  117. data/vendor/local/share/doc/groonga/en/html/reference/api/grn_ctx.html +24 -24
  118. data/vendor/local/share/doc/groonga/en/html/reference/api/grn_db.html +24 -24
  119. data/vendor/local/share/doc/groonga/en/html/reference/api/grn_encoding.html +24 -24
  120. data/vendor/local/share/doc/groonga/en/html/reference/api/grn_expr.html +22 -22
  121. data/vendor/local/share/doc/groonga/en/html/reference/api/grn_geo.html +24 -24
  122. data/vendor/local/share/doc/groonga/en/html/reference/api/grn_hook.html +24 -24
  123. data/vendor/local/share/doc/groonga/en/html/reference/api/grn_ii.html +24 -24
  124. data/vendor/local/share/doc/groonga/en/html/reference/api/grn_index_cursor.html +24 -24
  125. data/vendor/local/share/doc/groonga/en/html/reference/api/grn_info.html +24 -24
  126. data/vendor/local/share/doc/groonga/en/html/reference/api/grn_match_escalation.html +24 -24
  127. data/vendor/local/share/doc/groonga/en/html/reference/api/grn_obj.html +24 -24
  128. data/vendor/local/share/doc/groonga/en/html/reference/api/grn_proc.html +24 -24
  129. data/vendor/local/share/doc/groonga/en/html/reference/api/grn_search.html +24 -24
  130. data/vendor/local/share/doc/groonga/en/html/reference/api/grn_table.html +24 -24
  131. data/vendor/local/share/doc/groonga/en/html/reference/api/grn_table_cursor.html +24 -24
  132. data/vendor/local/share/doc/groonga/en/html/reference/api/grn_type.html +24 -24
  133. data/vendor/local/share/doc/groonga/en/html/reference/api/grn_user_data.html +20 -20
  134. data/vendor/local/share/doc/groonga/en/html/reference/cast.html +5 -5
  135. data/vendor/local/share/doc/groonga/en/html/reference/command.html +16 -15
  136. data/vendor/local/share/doc/groonga/en/html/reference/command/command_version.html +5 -5
  137. data/vendor/local/share/doc/groonga/en/html/reference/command/output_format.html +5 -5
  138. data/vendor/local/share/doc/groonga/en/html/reference/command/return_code.html +5 -5
  139. data/vendor/local/share/doc/groonga/en/html/reference/commands/cache_limit.html +8 -8
  140. data/vendor/local/share/doc/groonga/en/html/reference/commands/check.html +5 -5
  141. data/vendor/local/share/doc/groonga/en/html/reference/commands/clearlock.html +6 -6
  142. data/vendor/local/share/doc/groonga/en/html/reference/commands/column_create.html +48 -47
  143. data/vendor/local/share/doc/groonga/en/html/reference/commands/column_list.html +6 -6
  144. data/vendor/local/share/doc/groonga/en/html/reference/commands/column_remove.html +5 -5
  145. data/vendor/local/share/doc/groonga/en/html/reference/commands/column_rename.html +5 -5
  146. data/vendor/local/share/doc/groonga/en/html/reference/commands/define_selector.html +5 -5
  147. data/vendor/local/share/doc/groonga/en/html/reference/commands/defrag.html +5 -5
  148. data/vendor/local/share/doc/groonga/en/html/reference/commands/delete.html +5 -5
  149. data/vendor/local/share/doc/groonga/en/html/reference/commands/dump.html +5 -5
  150. data/vendor/local/share/doc/groonga/en/html/reference/commands/load.html +5 -5
  151. data/vendor/local/share/doc/groonga/en/html/reference/commands/log_level.html +5 -5
  152. data/vendor/local/share/doc/groonga/en/html/reference/commands/log_put.html +5 -5
  153. data/vendor/local/share/doc/groonga/en/html/reference/commands/log_reopen.html +5 -5
  154. data/vendor/local/share/doc/groonga/en/html/reference/commands/normalize.html +95 -14
  155. data/vendor/local/share/doc/groonga/en/html/reference/commands/quit.html +5 -5
  156. data/vendor/local/share/doc/groonga/en/html/reference/commands/register.html +5 -5
  157. data/vendor/local/share/doc/groonga/en/html/reference/commands/ruby_eval.html +24 -40
  158. data/vendor/local/share/doc/groonga/en/html/reference/commands/ruby_load.html +196 -0
  159. data/vendor/local/share/doc/groonga/en/html/reference/commands/select.html +90 -90
  160. data/vendor/local/share/doc/groonga/en/html/reference/commands/shutdown.html +27 -27
  161. data/vendor/local/share/doc/groonga/en/html/reference/commands/status.html +29 -29
  162. data/vendor/local/share/doc/groonga/en/html/reference/commands/suggest.html +31 -31
  163. data/vendor/local/share/doc/groonga/en/html/reference/commands/table_create.html +47 -47
  164. data/vendor/local/share/doc/groonga/en/html/reference/commands/table_list.html +27 -27
  165. data/vendor/local/share/doc/groonga/en/html/reference/commands/table_remove.html +29 -29
  166. data/vendor/local/share/doc/groonga/en/html/reference/commands/tokenize.html +45 -44
  167. data/vendor/local/share/doc/groonga/en/html/reference/commands/truncate.html +25 -25
  168. data/vendor/local/share/doc/groonga/en/html/reference/commands_not_implemented/add.html +5 -5
  169. data/vendor/local/share/doc/groonga/en/html/reference/commands_not_implemented/get.html +5 -5
  170. data/vendor/local/share/doc/groonga/en/html/reference/commands_not_implemented/set.html +5 -5
  171. data/vendor/local/share/doc/groonga/en/html/reference/executables.html +7 -5
  172. data/vendor/local/share/doc/groonga/en/html/reference/executables/grnslap.html +5 -5
  173. data/vendor/local/share/doc/groonga/en/html/reference/executables/grntest.html +5 -5
  174. data/vendor/local/share/doc/groonga/en/html/reference/executables/groonga-httpd.html +61 -17
  175. data/vendor/local/share/doc/groonga/en/html/reference/executables/groonga-server-http.html +5 -5
  176. data/vendor/local/share/doc/groonga/en/html/reference/executables/groonga-suggest-create-dataset.html +24 -12
  177. data/vendor/local/share/doc/groonga/en/html/reference/executables/groonga-suggest-httpd.html +221 -0
  178. data/vendor/local/share/doc/groonga/en/html/reference/executables/groonga-suggest-learner.html +174 -0
  179. data/vendor/local/share/doc/groonga/en/html/reference/executables/groonga.html +7 -9
  180. data/vendor/local/share/doc/groonga/en/html/reference/function.html +5 -5
  181. data/vendor/local/share/doc/groonga/en/html/reference/functions/edit_distance.html +5 -5
  182. data/vendor/local/share/doc/groonga/en/html/reference/functions/geo_distance.html +5 -5
  183. data/vendor/local/share/doc/groonga/en/html/reference/functions/geo_in_circle.html +5 -5
  184. data/vendor/local/share/doc/groonga/en/html/reference/functions/geo_in_rectangle.html +5 -5
  185. data/vendor/local/share/doc/groonga/en/html/reference/functions/html_untag.html +5 -5
  186. data/vendor/local/share/doc/groonga/en/html/reference/functions/now.html +5 -5
  187. data/vendor/local/share/doc/groonga/en/html/reference/functions/query.html +5 -5
  188. data/vendor/local/share/doc/groonga/en/html/reference/functions/rand.html +5 -5
  189. data/vendor/local/share/doc/groonga/en/html/reference/functions/snippet_html.html +5 -5
  190. data/vendor/local/share/doc/groonga/en/html/reference/functions/sub_filter.html +5 -5
  191. data/vendor/local/share/doc/groonga/en/html/reference/grn_expr.html +5 -5
  192. data/vendor/local/share/doc/groonga/en/html/reference/grn_expr/query_syntax.html +5 -5
  193. data/vendor/local/share/doc/groonga/en/html/reference/grn_expr/script_syntax.html +5 -5
  194. data/vendor/local/share/doc/groonga/en/html/reference/indexing.html +5 -5
  195. data/vendor/local/share/doc/groonga/en/html/reference/log.html +11 -11
  196. data/vendor/local/share/doc/groonga/en/html/reference/normalizers.html +5 -5
  197. data/vendor/local/share/doc/groonga/en/html/reference/output.html +10 -10
  198. data/vendor/local/share/doc/groonga/en/html/reference/pseudo_column.html +5 -5
  199. data/vendor/local/share/doc/groonga/en/html/reference/query_expanders.html +5 -5
  200. data/vendor/local/share/doc/groonga/en/html/reference/query_expanders/tsv.html +5 -5
  201. data/vendor/local/share/doc/groonga/en/html/reference/tables.html +5 -5
  202. data/vendor/local/share/doc/groonga/en/html/reference/tokenizers.html +5 -5
  203. data/vendor/local/share/doc/groonga/en/html/reference/tuning.html +290 -0
  204. data/vendor/local/share/doc/groonga/en/html/reference/types.html +9 -9
  205. data/vendor/local/share/doc/groonga/en/html/search.html +5 -5
  206. data/vendor/local/share/doc/groonga/en/html/searchindex.js +1 -1
  207. data/vendor/local/share/doc/groonga/en/html/server.html +5 -5
  208. data/vendor/local/share/doc/groonga/en/html/server/gqtp.html +5 -5
  209. data/vendor/local/share/doc/groonga/en/html/server/http.html +5 -5
  210. data/vendor/local/share/doc/groonga/en/html/server/http/comparison.html +5 -5
  211. data/vendor/local/share/doc/groonga/en/html/server/http/groonga-httpd.html +5 -5
  212. data/vendor/local/share/doc/groonga/en/html/server/http/groonga.html +5 -5
  213. data/vendor/local/share/doc/groonga/en/html/server/package.html +5 -5
  214. data/vendor/local/share/doc/groonga/en/html/spec.html +9 -9
  215. data/vendor/local/share/doc/groonga/en/html/spec/gqtp.html +5 -5
  216. data/vendor/local/share/doc/groonga/en/html/spec/search.html +5 -5
  217. data/vendor/local/share/doc/groonga/en/html/suggest.html +6 -5
  218. data/vendor/local/share/doc/groonga/en/html/suggest/completion.html +194 -5
  219. data/vendor/local/share/doc/groonga/en/html/suggest/correction.html +5 -5
  220. data/vendor/local/share/doc/groonga/en/html/suggest/introduction.html +5 -5
  221. data/vendor/local/share/doc/groonga/en/html/suggest/suggestion.html +5 -5
  222. data/vendor/local/share/doc/groonga/en/html/suggest/tutorial.html +5 -5
  223. data/vendor/local/share/doc/groonga/en/html/troubleshooting.html +10 -5
  224. data/vendor/local/share/doc/groonga/en/html/troubleshooting/different_results_with_the_same_keyword.html +10 -10
  225. data/vendor/local/share/doc/groonga/en/html/troubleshooting/mmap_cannot_allocate_memory.html +167 -0
  226. data/vendor/local/share/doc/groonga/en/html/tutorial.html +5 -5
  227. data/vendor/local/share/doc/groonga/en/html/tutorial/data.html +5 -5
  228. data/vendor/local/share/doc/groonga/en/html/tutorial/drilldown.html +5 -5
  229. data/vendor/local/share/doc/groonga/en/html/tutorial/index.html +5 -5
  230. data/vendor/local/share/doc/groonga/en/html/tutorial/introduction.html +5 -5
  231. data/vendor/local/share/doc/groonga/en/html/tutorial/lexicon.html +5 -5
  232. data/vendor/local/share/doc/groonga/en/html/tutorial/match_columns.html +5 -5
  233. data/vendor/local/share/doc/groonga/en/html/tutorial/micro_blog.html +5 -5
  234. data/vendor/local/share/doc/groonga/en/html/tutorial/network.html +5 -5
  235. data/vendor/local/share/doc/groonga/en/html/tutorial/patricia_trie.html +5 -5
  236. data/vendor/local/share/doc/groonga/en/html/tutorial/query_expansion.html +5 -5
  237. data/vendor/local/share/doc/groonga/en/html/tutorial/search.html +5 -5
  238. data/vendor/local/share/doc/groonga/ja/html/.buildinfo +1 -1
  239. data/vendor/local/share/doc/groonga/ja/html/_sources/contribution/development/document.txt +3 -0
  240. data/vendor/local/share/doc/groonga/ja/html/_sources/index.txt +0 -5
  241. data/vendor/local/share/doc/groonga/ja/html/_sources/install/centos.txt +3 -3
  242. data/vendor/local/share/doc/groonga/ja/html/_sources/install/debian.txt +3 -3
  243. data/vendor/local/share/doc/groonga/ja/html/_sources/install/fedora.txt +3 -3
  244. data/vendor/local/share/doc/groonga/ja/html/_sources/install/mac_os_x.txt +3 -3
  245. data/vendor/local/share/doc/groonga/ja/html/_sources/install/others.txt +15 -3
  246. data/vendor/local/share/doc/groonga/ja/html/_sources/install/solaris.txt +3 -3
  247. data/vendor/local/share/doc/groonga/ja/html/_sources/install/ubuntu.txt +43 -3
  248. data/vendor/local/share/doc/groonga/ja/html/_sources/install/windows.txt +9 -9
  249. data/vendor/local/share/doc/groonga/ja/html/_sources/news.txt +54 -0
  250. data/vendor/local/share/doc/groonga/ja/html/_sources/reference.txt +1 -0
  251. data/vendor/local/share/doc/groonga/ja/html/_sources/reference/commands/cache_limit.txt +3 -3
  252. data/vendor/local/share/doc/groonga/ja/html/_sources/reference/commands/column_create.txt +38 -30
  253. data/vendor/local/share/doc/groonga/ja/html/_sources/reference/commands/normalize.txt +81 -10
  254. data/vendor/local/share/doc/groonga/ja/html/_sources/reference/commands/ruby_eval.txt +13 -19
  255. data/vendor/local/share/doc/groonga/ja/html/_sources/reference/commands/ruby_load.txt +71 -0
  256. data/vendor/local/share/doc/groonga/ja/html/_sources/reference/commands/tokenize.txt +7 -6
  257. data/vendor/local/share/doc/groonga/ja/html/_sources/reference/executables/groonga-httpd.txt +87 -33
  258. data/vendor/local/share/doc/groonga/ja/html/_sources/reference/executables/groonga-suggest-create-dataset.txt +15 -2
  259. data/vendor/local/share/doc/groonga/ja/html/_sources/reference/executables/groonga-suggest-httpd.txt +68 -0
  260. data/vendor/local/share/doc/groonga/ja/html/_sources/reference/executables/groonga-suggest-learner.txt +40 -0
  261. data/vendor/local/share/doc/groonga/ja/html/_sources/reference/executables/groonga.txt +0 -3
  262. data/vendor/local/share/doc/groonga/ja/html/_sources/reference/tuning.txt +176 -0
  263. data/vendor/local/share/doc/groonga/ja/html/_sources/suggest/completion.txt +69 -0
  264. data/vendor/local/share/doc/groonga/ja/html/_sources/troubleshooting/mmap_cannot_allocate_memory.txt +45 -0
  265. data/vendor/local/share/doc/groonga/ja/html/_static/basic.css +0 -4
  266. data/vendor/local/share/doc/groonga/ja/html/characteristic.html +6 -6
  267. data/vendor/local/share/doc/groonga/ja/html/community.html +6 -6
  268. data/vendor/local/share/doc/groonga/ja/html/contribution.html +6 -6
  269. data/vendor/local/share/doc/groonga/ja/html/contribution/development.html +6 -6
  270. data/vendor/local/share/doc/groonga/ja/html/contribution/development/com.html +6 -6
  271. data/vendor/local/share/doc/groonga/ja/html/contribution/development/cooperation.html +6 -6
  272. data/vendor/local/share/doc/groonga/ja/html/contribution/development/document.html +7 -6
  273. data/vendor/local/share/doc/groonga/ja/html/contribution/development/query.html +6 -6
  274. data/vendor/local/share/doc/groonga/ja/html/contribution/development/release.html +6 -6
  275. data/vendor/local/share/doc/groonga/ja/html/contribution/development/repository.html +6 -6
  276. data/vendor/local/share/doc/groonga/ja/html/contribution/development/test.html +6 -6
  277. data/vendor/local/share/doc/groonga/ja/html/contribution/documentation.html +6 -6
  278. data/vendor/local/share/doc/groonga/ja/html/contribution/documentation/c-api.html +6 -6
  279. data/vendor/local/share/doc/groonga/ja/html/contribution/documentation/i18n.html +6 -6
  280. data/vendor/local/share/doc/groonga/ja/html/contribution/report.html +6 -6
  281. data/vendor/local/share/doc/groonga/ja/html/development.html +11 -11
  282. data/vendor/local/share/doc/groonga/ja/html/development/travis-ci.html +6 -6
  283. data/vendor/local/share/doc/groonga/ja/html/genindex.html +127 -7
  284. data/vendor/local/share/doc/groonga/ja/html/geolocation_search.html +6 -6
  285. data/vendor/local/share/doc/groonga/ja/html/index.html +55 -42
  286. data/vendor/local/share/doc/groonga/ja/html/install.html +8 -7
  287. data/vendor/local/share/doc/groonga/ja/html/install/centos.html +9 -9
  288. data/vendor/local/share/doc/groonga/ja/html/install/debian.html +9 -9
  289. data/vendor/local/share/doc/groonga/ja/html/install/fedora.html +9 -9
  290. data/vendor/local/share/doc/groonga/ja/html/install/mac_os_x.html +9 -9
  291. data/vendor/local/share/doc/groonga/ja/html/install/others.html +17 -9
  292. data/vendor/local/share/doc/groonga/ja/html/install/solaris.html +9 -9
  293. data/vendor/local/share/doc/groonga/ja/html/install/ubuntu.html +43 -11
  294. data/vendor/local/share/doc/groonga/ja/html/install/windows.html +15 -15
  295. data/vendor/local/share/doc/groonga/ja/html/limitations.html +6 -6
  296. data/vendor/local/share/doc/groonga/ja/html/news.html +245 -169
  297. data/vendor/local/share/doc/groonga/ja/html/news/0.x.html +6 -6
  298. data/vendor/local/share/doc/groonga/ja/html/news/1.0.x.html +6 -6
  299. data/vendor/local/share/doc/groonga/ja/html/news/1.1.x.html +6 -6
  300. data/vendor/local/share/doc/groonga/ja/html/news/1.2.x.html +6 -6
  301. data/vendor/local/share/doc/groonga/ja/html/news/senna.html +6 -6
  302. data/vendor/local/share/doc/groonga/ja/html/objects.inv +0 -0
  303. data/vendor/local/share/doc/groonga/ja/html/reference.html +47 -37
  304. data/vendor/local/share/doc/groonga/ja/html/reference/api.html +36 -36
  305. data/vendor/local/share/doc/groonga/ja/html/reference/api/grn_cache.html +25 -25
  306. data/vendor/local/share/doc/groonga/ja/html/reference/api/grn_column.html +25 -25
  307. data/vendor/local/share/doc/groonga/ja/html/reference/api/grn_command_version.html +25 -25
  308. data/vendor/local/share/doc/groonga/ja/html/reference/api/grn_ctx.html +25 -25
  309. data/vendor/local/share/doc/groonga/ja/html/reference/api/grn_db.html +25 -25
  310. data/vendor/local/share/doc/groonga/ja/html/reference/api/grn_encoding.html +25 -25
  311. data/vendor/local/share/doc/groonga/ja/html/reference/api/grn_expr.html +23 -23
  312. data/vendor/local/share/doc/groonga/ja/html/reference/api/grn_geo.html +25 -25
  313. data/vendor/local/share/doc/groonga/ja/html/reference/api/grn_hook.html +25 -25
  314. data/vendor/local/share/doc/groonga/ja/html/reference/api/grn_ii.html +25 -25
  315. data/vendor/local/share/doc/groonga/ja/html/reference/api/grn_index_cursor.html +25 -25
  316. data/vendor/local/share/doc/groonga/ja/html/reference/api/grn_info.html +25 -25
  317. data/vendor/local/share/doc/groonga/ja/html/reference/api/grn_match_escalation.html +25 -25
  318. data/vendor/local/share/doc/groonga/ja/html/reference/api/grn_obj.html +25 -25
  319. data/vendor/local/share/doc/groonga/ja/html/reference/api/grn_proc.html +25 -25
  320. data/vendor/local/share/doc/groonga/ja/html/reference/api/grn_search.html +25 -25
  321. data/vendor/local/share/doc/groonga/ja/html/reference/api/grn_table.html +25 -25
  322. data/vendor/local/share/doc/groonga/ja/html/reference/api/grn_table_cursor.html +25 -25
  323. data/vendor/local/share/doc/groonga/ja/html/reference/api/grn_type.html +25 -25
  324. data/vendor/local/share/doc/groonga/ja/html/reference/api/grn_user_data.html +21 -21
  325. data/vendor/local/share/doc/groonga/ja/html/reference/cast.html +6 -6
  326. data/vendor/local/share/doc/groonga/ja/html/reference/command.html +17 -16
  327. data/vendor/local/share/doc/groonga/ja/html/reference/command/command_version.html +6 -6
  328. data/vendor/local/share/doc/groonga/ja/html/reference/command/output_format.html +6 -6
  329. data/vendor/local/share/doc/groonga/ja/html/reference/command/return_code.html +6 -6
  330. data/vendor/local/share/doc/groonga/ja/html/reference/commands/cache_limit.html +9 -9
  331. data/vendor/local/share/doc/groonga/ja/html/reference/commands/check.html +6 -6
  332. data/vendor/local/share/doc/groonga/ja/html/reference/commands/clearlock.html +7 -7
  333. data/vendor/local/share/doc/groonga/ja/html/reference/commands/column_create.html +52 -48
  334. data/vendor/local/share/doc/groonga/ja/html/reference/commands/column_list.html +7 -7
  335. data/vendor/local/share/doc/groonga/ja/html/reference/commands/column_remove.html +6 -6
  336. data/vendor/local/share/doc/groonga/ja/html/reference/commands/column_rename.html +6 -6
  337. data/vendor/local/share/doc/groonga/ja/html/reference/commands/define_selector.html +6 -6
  338. data/vendor/local/share/doc/groonga/ja/html/reference/commands/defrag.html +6 -6
  339. data/vendor/local/share/doc/groonga/ja/html/reference/commands/delete.html +6 -6
  340. data/vendor/local/share/doc/groonga/ja/html/reference/commands/dump.html +6 -6
  341. data/vendor/local/share/doc/groonga/ja/html/reference/commands/load.html +6 -6
  342. data/vendor/local/share/doc/groonga/ja/html/reference/commands/log_level.html +6 -6
  343. data/vendor/local/share/doc/groonga/ja/html/reference/commands/log_put.html +6 -6
  344. data/vendor/local/share/doc/groonga/ja/html/reference/commands/log_reopen.html +6 -6
  345. data/vendor/local/share/doc/groonga/ja/html/reference/commands/normalize.html +93 -11
  346. data/vendor/local/share/doc/groonga/ja/html/reference/commands/quit.html +6 -6
  347. data/vendor/local/share/doc/groonga/ja/html/reference/commands/register.html +6 -6
  348. data/vendor/local/share/doc/groonga/ja/html/reference/commands/ruby_eval.html +24 -44
  349. data/vendor/local/share/doc/groonga/ja/html/reference/commands/ruby_load.html +196 -0
  350. data/vendor/local/share/doc/groonga/ja/html/reference/commands/select.html +91 -91
  351. data/vendor/local/share/doc/groonga/ja/html/reference/commands/shutdown.html +28 -28
  352. data/vendor/local/share/doc/groonga/ja/html/reference/commands/status.html +30 -30
  353. data/vendor/local/share/doc/groonga/ja/html/reference/commands/suggest.html +32 -32
  354. data/vendor/local/share/doc/groonga/ja/html/reference/commands/table_create.html +48 -48
  355. data/vendor/local/share/doc/groonga/ja/html/reference/commands/table_list.html +28 -28
  356. data/vendor/local/share/doc/groonga/ja/html/reference/commands/table_remove.html +30 -30
  357. data/vendor/local/share/doc/groonga/ja/html/reference/commands/tokenize.html +44 -43
  358. data/vendor/local/share/doc/groonga/ja/html/reference/commands/truncate.html +26 -26
  359. data/vendor/local/share/doc/groonga/ja/html/reference/commands_not_implemented/add.html +6 -6
  360. data/vendor/local/share/doc/groonga/ja/html/reference/commands_not_implemented/get.html +6 -6
  361. data/vendor/local/share/doc/groonga/ja/html/reference/commands_not_implemented/set.html +6 -6
  362. data/vendor/local/share/doc/groonga/ja/html/reference/executables.html +8 -6
  363. data/vendor/local/share/doc/groonga/ja/html/reference/executables/grnslap.html +6 -6
  364. data/vendor/local/share/doc/groonga/ja/html/reference/executables/grntest.html +6 -6
  365. data/vendor/local/share/doc/groonga/ja/html/reference/executables/groonga-httpd.html +56 -20
  366. data/vendor/local/share/doc/groonga/ja/html/reference/executables/groonga-server-http.html +6 -6
  367. data/vendor/local/share/doc/groonga/ja/html/reference/executables/groonga-suggest-create-dataset.html +26 -13
  368. data/vendor/local/share/doc/groonga/ja/html/reference/executables/groonga-suggest-httpd.html +222 -0
  369. data/vendor/local/share/doc/groonga/ja/html/reference/executables/groonga-suggest-learner.html +175 -0
  370. data/vendor/local/share/doc/groonga/ja/html/reference/executables/groonga.html +8 -10
  371. data/vendor/local/share/doc/groonga/ja/html/reference/function.html +6 -6
  372. data/vendor/local/share/doc/groonga/ja/html/reference/functions/edit_distance.html +6 -6
  373. data/vendor/local/share/doc/groonga/ja/html/reference/functions/geo_distance.html +6 -6
  374. data/vendor/local/share/doc/groonga/ja/html/reference/functions/geo_in_circle.html +6 -6
  375. data/vendor/local/share/doc/groonga/ja/html/reference/functions/geo_in_rectangle.html +6 -6
  376. data/vendor/local/share/doc/groonga/ja/html/reference/functions/html_untag.html +6 -6
  377. data/vendor/local/share/doc/groonga/ja/html/reference/functions/now.html +6 -6
  378. data/vendor/local/share/doc/groonga/ja/html/reference/functions/query.html +6 -6
  379. data/vendor/local/share/doc/groonga/ja/html/reference/functions/rand.html +6 -6
  380. data/vendor/local/share/doc/groonga/ja/html/reference/functions/snippet_html.html +6 -6
  381. data/vendor/local/share/doc/groonga/ja/html/reference/functions/sub_filter.html +6 -6
  382. data/vendor/local/share/doc/groonga/ja/html/reference/grn_expr.html +6 -6
  383. data/vendor/local/share/doc/groonga/ja/html/reference/grn_expr/query_syntax.html +6 -6
  384. data/vendor/local/share/doc/groonga/ja/html/reference/grn_expr/script_syntax.html +6 -6
  385. data/vendor/local/share/doc/groonga/ja/html/reference/indexing.html +6 -6
  386. data/vendor/local/share/doc/groonga/ja/html/reference/log.html +12 -12
  387. data/vendor/local/share/doc/groonga/ja/html/reference/normalizers.html +6 -6
  388. data/vendor/local/share/doc/groonga/ja/html/reference/output.html +11 -11
  389. data/vendor/local/share/doc/groonga/ja/html/reference/pseudo_column.html +6 -6
  390. data/vendor/local/share/doc/groonga/ja/html/reference/query_expanders.html +6 -6
  391. data/vendor/local/share/doc/groonga/ja/html/reference/query_expanders/tsv.html +6 -6
  392. data/vendor/local/share/doc/groonga/ja/html/reference/tables.html +6 -6
  393. data/vendor/local/share/doc/groonga/ja/html/reference/tokenizers.html +6 -6
  394. data/vendor/local/share/doc/groonga/ja/html/reference/tuning.html +289 -0
  395. data/vendor/local/share/doc/groonga/ja/html/reference/types.html +10 -10
  396. data/vendor/local/share/doc/groonga/ja/html/search.html +5 -5
  397. data/vendor/local/share/doc/groonga/ja/html/searchindex.js +1 -1
  398. data/vendor/local/share/doc/groonga/ja/html/server.html +6 -6
  399. data/vendor/local/share/doc/groonga/ja/html/server/gqtp.html +6 -6
  400. data/vendor/local/share/doc/groonga/ja/html/server/http.html +6 -6
  401. data/vendor/local/share/doc/groonga/ja/html/server/http/comparison.html +6 -6
  402. data/vendor/local/share/doc/groonga/ja/html/server/http/groonga-httpd.html +6 -6
  403. data/vendor/local/share/doc/groonga/ja/html/server/http/groonga.html +6 -6
  404. data/vendor/local/share/doc/groonga/ja/html/server/package.html +6 -6
  405. data/vendor/local/share/doc/groonga/ja/html/spec.html +10 -10
  406. data/vendor/local/share/doc/groonga/ja/html/spec/gqtp.html +6 -6
  407. data/vendor/local/share/doc/groonga/ja/html/spec/search.html +6 -6
  408. data/vendor/local/share/doc/groonga/ja/html/suggest.html +7 -6
  409. data/vendor/local/share/doc/groonga/ja/html/suggest/completion.html +195 -6
  410. data/vendor/local/share/doc/groonga/ja/html/suggest/correction.html +6 -6
  411. data/vendor/local/share/doc/groonga/ja/html/suggest/introduction.html +6 -6
  412. data/vendor/local/share/doc/groonga/ja/html/suggest/suggestion.html +6 -6
  413. data/vendor/local/share/doc/groonga/ja/html/suggest/tutorial.html +6 -6
  414. data/vendor/local/share/doc/groonga/ja/html/troubleshooting.html +11 -6
  415. data/vendor/local/share/doc/groonga/ja/html/troubleshooting/different_results_with_the_same_keyword.html +11 -11
  416. data/vendor/local/share/doc/groonga/ja/html/troubleshooting/mmap_cannot_allocate_memory.html +170 -0
  417. data/vendor/local/share/doc/groonga/ja/html/tutorial.html +6 -6
  418. data/vendor/local/share/doc/groonga/ja/html/tutorial/data.html +6 -6
  419. data/vendor/local/share/doc/groonga/ja/html/tutorial/drilldown.html +6 -6
  420. data/vendor/local/share/doc/groonga/ja/html/tutorial/index.html +6 -6
  421. data/vendor/local/share/doc/groonga/ja/html/tutorial/introduction.html +6 -6
  422. data/vendor/local/share/doc/groonga/ja/html/tutorial/lexicon.html +6 -6
  423. data/vendor/local/share/doc/groonga/ja/html/tutorial/match_columns.html +6 -6
  424. data/vendor/local/share/doc/groonga/ja/html/tutorial/micro_blog.html +6 -6
  425. data/vendor/local/share/doc/groonga/ja/html/tutorial/network.html +6 -6
  426. data/vendor/local/share/doc/groonga/ja/html/tutorial/patricia_trie.html +6 -6
  427. data/vendor/local/share/doc/groonga/ja/html/tutorial/query_expansion.html +6 -6
  428. data/vendor/local/share/doc/groonga/ja/html/tutorial/search.html +6 -6
  429. data/vendor/local/share/man/ja/man1/groonga.1 +1152 -241
  430. data/vendor/local/share/man/man1/groonga.1 +1215 -269
  431. metadata +150 -130
@@ -1,4 +1,4 @@
1
- .TH "GROONGA" "1" "September 27, 2013" "3.0.8" "groonga"
1
+ .TH "GROONGA" "1" "October 28, 2013" "3.0.9" "groonga"
2
2
  .SH NAME
3
3
  groonga \- groonga documentation
4
4
  .
@@ -34,14 +34,6 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
34
34
  .IP \(bu 2
35
35
  \fBnews\fP
36
36
  .UNINDENT
37
- .sp
38
- \fBNOTE:\fP
39
- .INDENT 0.0
40
- .INDENT 3.5
41
- This document is also ditributed in forms of release source archive and updated time to time.
42
- If you want to refer latest documentation in source form, you can view such files via GitHub repository browser (\fI\%https://github.com/groonga/groonga/tree/master/doc/source\fP).
43
- .UNINDENT
44
- .UNINDENT
45
37
  .SH CHARACTERISTICS OF GROONGA
46
38
  .SS Groonga overview
47
39
  .sp
@@ -122,7 +114,7 @@ Start command prompt \fBcmd.exe\fP and download x86 executable binary by default
122
114
  .sp
123
115
  .nf
124
116
  .ft C
125
- > "c:\e\eProgram Files\e\eInternet Explorer\e\eiexplore.exe" http://packages.groonga.org/windows/groonga/groonga\-3.0.8\-x86.exe
117
+ > "c:\e\eProgram Files\e\eInternet Explorer\e\eiexplore.exe" http://packages.groonga.org/windows/groonga/groonga\-3.0.9\-x86.exe
126
118
  .ft P
127
119
  .fi
128
120
  .UNINDENT
@@ -138,7 +130,7 @@ Start command prompt \fBcmd.exe\fP and download x64 executable binary by default
138
130
  .sp
139
131
  .nf
140
132
  .ft C
141
- > "c:\e\eProgram Files\e\eInternet Explorer\e\eiexplore.exe" http://packages.groonga.org/windows/groonga/groonga\-3.0.8\-x64.exe
133
+ > "c:\e\eProgram Files\e\eInternet Explorer\e\eiexplore.exe" http://packages.groonga.org/windows/groonga/groonga\-3.0.9\-x64.exe
142
134
  .ft P
143
135
  .fi
144
136
  .UNINDENT
@@ -159,7 +151,7 @@ Start command prompt \fBcmd.exe\fP and download x86 zip archive by default brows
159
151
  .sp
160
152
  .nf
161
153
  .ft C
162
- > "c:\e\eProgram Files\e\eInternet Explorer\e\eiexplore.exe" http://packages.groonga.org/windows/groonga/groonga\-3.0.8\-x86.zip
154
+ > "c:\e\eProgram Files\e\eInternet Explorer\e\eiexplore.exe" http://packages.groonga.org/windows/groonga/groonga\-3.0.9\-x86.zip
163
155
  .ft P
164
156
  .fi
165
157
  .UNINDENT
@@ -175,7 +167,7 @@ Start command prompt \fBcmd.exe\fP and download x64 zip archive by default brows
175
167
  .sp
176
168
  .nf
177
169
  .ft C
178
- > "c:\e\eProgram Files\e\eInternet Explorer\e\eiexplore.exe" http://packages.groonga.org/windows/groonga/groonga\-3.0.8\-x64.zip
170
+ > "c:\e\eProgram Files\e\eInternet Explorer\e\eiexplore.exe" http://packages.groonga.org/windows/groonga/groonga\-3.0.9\-x64.zip
179
171
  .ft P
180
172
  .fi
181
173
  .UNINDENT
@@ -211,7 +203,7 @@ Visual Studio 2010 Express and download it by default browser:
211
203
  .nf
212
204
  .ft C
213
205
  > cd c:\eUsers\e%USERNAME%\eDownloads
214
- > "c:\e\eProgram Files\e\eInternet Explorer\e\eiexplore.exe" http://packages.groonga.org/source/groonga/groonga\-3.0.8.zip
206
+ > "c:\e\eProgram Files\e\eInternet Explorer\e\eiexplore.exe" http://packages.groonga.org/source/groonga/groonga\-3.0.9.zip
215
207
  .ft P
216
208
  .fi
217
209
  .UNINDENT
@@ -225,7 +217,7 @@ Move to the groonga\(aqs source folder:
225
217
  .sp
226
218
  .nf
227
219
  .ft C
228
- > cd c:\eUsers\e%USERNAME%\eDownloads\egroonga\-3.0.8
220
+ > cd c:\eUsers\e%USERNAME%\eDownloads\egroonga\-3.0.9
229
221
  .ft P
230
222
  .fi
231
223
  .UNINDENT
@@ -239,7 +231,7 @@ parameter instead:
239
231
  .sp
240
232
  .nf
241
233
  .ft C
242
- groonga\-3.0.8> cmake . \-G "Visual Studio 10 Win64" \-DCMAKE_INSTALL_PREFIX=C:\egroonga
234
+ groonga\-3.0.9> cmake . \-G "Visual Studio 10 Win64" \-DCMAKE_INSTALL_PREFIX=C:\egroonga
243
235
  .ft P
244
236
  .fi
245
237
  .UNINDENT
@@ -251,7 +243,7 @@ Build:
251
243
  .sp
252
244
  .nf
253
245
  .ft C
254
- groonga\-3.0.8> cmake \-\-build . \-\-config Release
246
+ groonga\-3.0.9> cmake \-\-build . \-\-config Release
255
247
  .ft P
256
248
  .fi
257
249
  .UNINDENT
@@ -263,7 +255,7 @@ Install:
263
255
  .sp
264
256
  .nf
265
257
  .ft C
266
- groonga\-3.0.8> cmake \-\-build . \-\-config Release \-\-target Install
258
+ groonga\-3.0.9> cmake \-\-build . \-\-config Release \-\-target Install
267
259
  .ft P
268
260
  .fi
269
261
  .UNINDENT
@@ -317,9 +309,9 @@ Download source:
317
309
  .sp
318
310
  .nf
319
311
  .ft C
320
- % curl \-O http://packages.groonga.org/source/groonga/groonga\-3.0.8.tar.gz
321
- % tar xvzf groonga\-3.0.8.tar.gz
322
- % cd groonga\-3.0.8
312
+ % curl \-O http://packages.groonga.org/source/groonga/groonga\-3.0.9.tar.gz
313
+ % tar xvzf groonga\-3.0.9.tar.gz
314
+ % cd groonga\-3.0.9
323
315
  .ft P
324
316
  .fi
325
317
  .UNINDENT
@@ -719,9 +711,9 @@ Download source:
719
711
  .sp
720
712
  .nf
721
713
  .ft C
722
- % wget http://packages.groonga.org/source/groonga/groonga\-3.0.8.tar.gz
723
- % tar xvzf groonga\-3.0.8.tar.gz
724
- % cd groonga\-3.0.8
714
+ % wget http://packages.groonga.org/source/groonga/groonga\-3.0.9.tar.gz
715
+ % tar xvzf groonga\-3.0.9.tar.gz
716
+ % cd groonga\-3.0.9
725
717
  .ft P
726
718
  .fi
727
719
  .UNINDENT
@@ -1173,6 +1165,83 @@ Install groonga\-normalizer\-mysql package:
1173
1165
  .fi
1174
1166
  .UNINDENT
1175
1167
  .UNINDENT
1168
+ .SS 13.10 Saucy Salamander
1169
+ .sp
1170
+ Add the Groonga apt repository.
1171
+ .sp
1172
+ /etc/apt/sources.list.d/groonga.list:
1173
+ .INDENT 0.0
1174
+ .INDENT 3.5
1175
+ .sp
1176
+ .nf
1177
+ .ft C
1178
+ deb http://packages.groonga.org/ubuntu/ saucy universe
1179
+ deb\-src http://packages.groonga.org/ubuntu/ saucy universe
1180
+ .ft P
1181
+ .fi
1182
+ .UNINDENT
1183
+ .UNINDENT
1184
+ .sp
1185
+ Install:
1186
+ .INDENT 0.0
1187
+ .INDENT 3.5
1188
+ .sp
1189
+ .nf
1190
+ .ft C
1191
+ % sudo apt\-get update
1192
+ % sudo apt\-get \-y \-\-allow\-unauthenticated install groonga\-keyring
1193
+ % sudo apt\-get update
1194
+ % sudo apt\-get \-y install groonga
1195
+ .ft P
1196
+ .fi
1197
+ .UNINDENT
1198
+ .UNINDENT
1199
+ .sp
1200
+ If you want to use \fI\%MeCab\fP as a
1201
+ tokenizer, install groonga\-tokenizer\-mecab package.
1202
+ .sp
1203
+ Install groonga\-tokenizer\-mecab package:
1204
+ .INDENT 0.0
1205
+ .INDENT 3.5
1206
+ .sp
1207
+ .nf
1208
+ .ft C
1209
+ % sudo apt\-get \-y install groonga\-tokenizer\-mecab
1210
+ .ft P
1211
+ .fi
1212
+ .UNINDENT
1213
+ .UNINDENT
1214
+ .sp
1215
+ There is a package that provides \fI\%Munin\fP plugins. If you want to monitor
1216
+ Groonga status by Munin, install groonga\-munin\-plugins package.
1217
+ .sp
1218
+ Install groonga\-munin\-plugins package:
1219
+ .INDENT 0.0
1220
+ .INDENT 3.5
1221
+ .sp
1222
+ .nf
1223
+ .ft C
1224
+ % sudo apt\-get \-y install groonga\-munin\-plugins
1225
+ .ft P
1226
+ .fi
1227
+ .UNINDENT
1228
+ .UNINDENT
1229
+ .sp
1230
+ There is a package that provides MySQL compatible normalizer as
1231
+ Groonga plugins.
1232
+ If you want to use that one, install groonga\-normalizer\-mysql package.
1233
+ .sp
1234
+ Install groonga\-normalizer\-mysql package:
1235
+ .INDENT 0.0
1236
+ .INDENT 3.5
1237
+ .sp
1238
+ .nf
1239
+ .ft C
1240
+ % sudo apt\-get \-y install groonga\-normalizer\-mysql
1241
+ .ft P
1242
+ .fi
1243
+ .UNINDENT
1244
+ .UNINDENT
1176
1245
  .SS Build from source
1177
1246
  .sp
1178
1247
  Install required packages to build groonga:
@@ -1193,9 +1262,9 @@ Download source:
1193
1262
  .sp
1194
1263
  .nf
1195
1264
  .ft C
1196
- % wget http://packages.groonga.org/source/groonga/groonga\-3.0.8.tar.gz
1197
- % tar xvzf groonga\-3.0.8.tar.gz
1198
- % cd groonga\-3.0.8
1265
+ % wget http://packages.groonga.org/source/groonga/groonga\-3.0.9.tar.gz
1266
+ % tar xvzf groonga\-3.0.9.tar.gz
1267
+ % cd groonga\-3.0.9
1199
1268
  .ft P
1200
1269
  .fi
1201
1270
  .UNINDENT
@@ -1533,9 +1602,9 @@ Download source:
1533
1602
  .sp
1534
1603
  .nf
1535
1604
  .ft C
1536
- % wget http://packages.groonga.org/source/groonga/groonga\-3.0.8.tar.gz
1537
- % tar xvzf groonga\-3.0.8.tar.gz
1538
- % cd groonga\-3.0.8
1605
+ % wget http://packages.groonga.org/source/groonga/groonga\-3.0.9.tar.gz
1606
+ % tar xvzf groonga\-3.0.9.tar.gz
1607
+ % cd groonga\-3.0.9
1539
1608
  .ft P
1540
1609
  .fi
1541
1610
  .UNINDENT
@@ -1740,9 +1809,9 @@ Download source:
1740
1809
  .sp
1741
1810
  .nf
1742
1811
  .ft C
1743
- % wget http://packages.groonga.org/source/groonga/groonga\-3.0.8.tar.gz
1744
- % tar xvzf groonga\-3.0.8.tar.gz
1745
- % cd groonga\-3.0.8
1812
+ % wget http://packages.groonga.org/source/groonga/groonga\-3.0.9.tar.gz
1813
+ % tar xvzf groonga\-3.0.9.tar.gz
1814
+ % cd groonga\-3.0.9
1746
1815
  .ft P
1747
1816
  .fi
1748
1817
  .UNINDENT
@@ -1807,9 +1876,9 @@ Download source:
1807
1876
  .sp
1808
1877
  .nf
1809
1878
  .ft C
1810
- % wget http://packages.groonga.org/source/groonga/groonga\-3.0.8.tar.gz
1811
- % gtar xvzf groonga\-3.0.8.tar.gz
1812
- % cd groonga\-3.0.8
1879
+ % wget http://packages.groonga.org/source/groonga/groonga\-3.0.9.tar.gz
1880
+ % gtar xvzf groonga\-3.0.9.tar.gz
1881
+ % cd groonga\-3.0.9
1813
1882
  .ft P
1814
1883
  .fi
1815
1884
  .UNINDENT
@@ -1949,9 +2018,9 @@ steps:
1949
2018
  .sp
1950
2019
  .nf
1951
2020
  .ft C
1952
- % wget http://packages.groonga.org/source/groonga/groonga\-3.0.8.tar.gz
1953
- % tar xvzf groonga\-3.0.8.tar.gz
1954
- % cd groonga\-3.0.8
2021
+ % wget http://packages.groonga.org/source/groonga/groonga\-3.0.9.tar.gz
2022
+ % tar xvzf groonga\-3.0.9.tar.gz
2023
+ % cd groonga\-3.0.9
1955
2024
  % ./configure
1956
2025
  % make
1957
2026
  % sudo make install
@@ -2087,6 +2156,15 @@ Here is an example that enables column value compression by zlib:
2087
2156
  .fi
2088
2157
  .UNINDENT
2089
2158
  .UNINDENT
2159
+ .sp
2160
+ \fBNOTE:\fP
2161
+ .INDENT 0.0
2162
+ .INDENT 3.5
2163
+ The disabled reason is that memory leak occurs when it refers column value.
2164
+ This is already known issue as \fI\%GitHub#6\fP.
2165
+ This issue is not nothing to do with updating column value.
2166
+ .UNINDENT
2167
+ .UNINDENT
2090
2168
  .SS \fB\-\-with\-lzo\fP
2091
2169
  .sp
2092
2170
  Enables column value compression by LZO.
@@ -2104,6 +2182,15 @@ Here is an example that enables column value compression by LZO:
2104
2182
  .fi
2105
2183
  .UNINDENT
2106
2184
  .UNINDENT
2185
+ .sp
2186
+ \fBNOTE:\fP
2187
+ .INDENT 0.0
2188
+ .INDENT 3.5
2189
+ The disabled reason is that memory leak occurs when it refers column value.
2190
+ This is already known issue as \fI\%GitHub#6\fP.
2191
+ This issue is not nothing to do with updating column value.
2192
+ .UNINDENT
2193
+ .UNINDENT
2107
2194
  .SS \fB\-\-with\-message\-pack=MESSAGE_PACK_INSTALL_PREFIX\fP
2108
2195
  .sp
2109
2196
  Specifies where MessagePack is installed. If MessagePack isn\(aqt
@@ -8056,6 +8143,8 @@ katakana or hiragana. It\(aqs useful for searching in Japanese.
8056
8143
  For example, there is a registered word "日本". And "ニホン"
8057
8144
  (it must be katakana) is registered as its reading. An user
8058
8145
  can find "日本" by "ni", "二" or "に".
8146
+ .sp
8147
+ If you create dataset which is named as example by \fB/reference/executables/groonga\-suggest\-create\-dataset\fP command, you can update pairs of registered word and its reading by loading data to \(aq_key\(aq and \(aqkana\(aq column of item_example table explicitly for prefix RK search.
8059
8148
  .SS Cooccurrence search
8060
8149
  .sp
8061
8150
  Cooccurrence search can find registered words from user\(aqs
@@ -8367,121 +8456,47 @@ load \-\-table event_query \-\-each \(aqsuggest_preparer(_id, type, item, sequen
8367
8456
  .fi
8368
8457
  .UNINDENT
8369
8458
  .UNINDENT
8370
- .SS Correction
8459
+ .SS How to update RK reading data
8371
8460
  .sp
8372
- This section describes about the following correction
8373
- features:
8374
- .INDENT 0.0
8375
- .IP \(bu 2
8376
- How it works
8377
- .IP \(bu 2
8378
- How to use
8379
- .IP \(bu 2
8380
- How to learn
8381
- .UNINDENT
8382
- .SS How it works
8461
+ Groonga requires registered word and its reading for RK search, so load such data in the advance.
8383
8462
  .sp
8384
- The correction feature uses three searches to compute corrected
8385
- words:
8463
+ Here is the example to register "日本" which means Japanese in english.
8464
+ .sp
8465
+ Execution example:
8386
8466
  .INDENT 0.0
8387
8467
  .INDENT 3.5
8388
- .INDENT 0.0
8389
- .IP 1. 3
8390
- Cooccurrence search against learned data.
8391
- .IP 2. 3
8392
- Similar search against registered words. (optional)
8393
- .UNINDENT
8468
+ .sp
8469
+ .nf
8470
+ .ft C
8471
+ load \-\-table event_query \-\-each \(aqsuggest_preparer(_id, type, item, sequence, time, pair_query)\(aq
8472
+ [
8473
+ {"sequence": "1", "time": 1312950805.86058, "item": "日本", "type": "submit"}
8474
+ ]
8475
+ # [[0, 1337566253.89858, 0.000355720520019531], 1]
8476
+ .ft P
8477
+ .fi
8394
8478
  .UNINDENT
8395
8479
  .UNINDENT
8396
- .SS Cooccurrence search
8397
- .sp
8398
- Cooccurrence search can find registered words from user\(aqs
8399
- wrong input. It uses user submit sequences that will be
8400
- learned from query logs, access logs and so on.
8401
8480
  .sp
8402
- For example, there are the following user submissions:
8403
- .TS
8404
- center;
8405
- |l|l|.
8406
- _
8407
- T{
8408
- query
8409
- T} T{
8410
- time
8411
- T}
8412
- _
8413
- T{
8414
- serach (typo!)
8415
- T} T{
8416
- 2011\-08\-10T22:20:50+09:00
8417
- T}
8418
- _
8419
- T{
8420
- search (fixed!)
8421
- T} T{
8422
- 2011\-08\-10T22:20:52+09:00
8423
- T}
8424
- _
8425
- .TE
8426
- .sp
8427
- Groonga creates the following correction pair from the above
8428
- submissions:
8429
- .TS
8430
- center;
8431
- |l|l|.
8432
- _
8433
- T{
8434
- input
8435
- T} T{
8436
- corrected word
8437
- T}
8438
- _
8439
- T{
8440
- serach
8441
- T} T{
8442
- search
8443
- T}
8444
- _
8445
- .TE
8446
- .sp
8447
- Groonga treats continuous submissions within a minute as
8448
- input correction by user. Not submitted user input sequence
8449
- between two submissions isn\(aqt used as learned data for
8450
- correction.
8451
- .sp
8452
- If an user inputs "serach" and cooccurrence search returns
8453
- "search" because "serach" is in input column and
8454
- corresponding corrected word column value is "search".
8455
- .SS Similar search
8456
- .sp
8457
- Similar search can find registered words that has one or
8458
- more the same tokens as user input. TokenBigram tokenizer is
8459
- used for tokenization because suggest dataset schema
8460
- created by \fB/reference/executables/groonga\-suggest\-create\-dataset\fP
8461
- uses TokenBigram tokenizer as the default tokenizer.
8462
- .sp
8463
- For example, there is a registered query "search engine". An
8464
- user can find "search engine" by "web search service",
8465
- "sound engine" and so on. Because "search engine" and "web
8466
- search engine" have the same token "search" and "search
8467
- engine" and "sound engine" have the same token "engine".
8481
+ Here is the example to update RK data to complete "日本".
8468
8482
  .sp
8469
- "search engine" is tokenized to "search" and "engine"
8470
- tokens. (Groonga\(aqs TokenBigram tokenizer doesn\(aqt tokenize
8471
- two characters for continuous alphabets and continuous
8472
- digits for reducing search
8473
- noise. TokenBigramSplitSymbolAlphaDigit tokenizer should be
8474
- used to ensure tokenizing to two characters.) "web search
8475
- service" is tokenized to "web", "search" and
8476
- "service". "sound engine" is tokenized to "sound" and
8477
- "engine".
8478
- .SS How to use
8483
+ Execution example:
8484
+ .INDENT 0.0
8485
+ .INDENT 3.5
8479
8486
  .sp
8480
- Groonga provides \fB/reference/commands/suggest\fP command to use
8481
- correction. \fI\-\-type correct\fP option requests corrections.
8487
+ .nf
8488
+ .ft C
8489
+ load \-\-table item_query
8490
+ [
8491
+ {"_key":"日本", "kana":["ニホン", "ニッポン"]}
8492
+ ]
8493
+ # [[0, 1337566253.89858, 0.000355720520019531], 1]
8494
+ .ft P
8495
+ .fi
8496
+ .UNINDENT
8497
+ .UNINDENT
8482
8498
  .sp
8483
- For example, here is an command to get correction results by
8484
- "saerch":
8499
+ Then you can complete registered word "日本" by RK input \- "nihon".
8485
8500
  .sp
8486
8501
  Execution example:
8487
8502
  .INDENT 0.0
@@ -8489,7 +8504,7 @@ Execution example:
8489
8504
  .sp
8490
8505
  .nf
8491
8506
  .ft C
8492
- suggest \-\-table item_query \-\-column kana \-\-types correction \-\-frequency_threshold 1 \-\-query saerch
8507
+ suggest \-\-table item_query \-\-column kana \-\-types complete \-\-frequency_threshold 1 \-\-query nihon
8493
8508
  # [
8494
8509
  # [
8495
8510
  # 0,
@@ -8497,7 +8512,7 @@ suggest \-\-table item_query \-\-column kana \-\-types correction \-\-frequency_
8497
8512
  # 0.000355720520019531
8498
8513
  # ],
8499
8514
  # {
8500
- # "correct": [
8515
+ # "complete": [
8501
8516
  # [
8502
8517
  # 1
8503
8518
  # ],
@@ -8512,8 +8527,8 @@ suggest \-\-table item_query \-\-column kana \-\-types correction \-\-frequency_
8512
8527
  # ]
8513
8528
  # ],
8514
8529
  # [
8515
- # "search",
8516
- # 1
8530
+ # "日本",
8531
+ # 2
8517
8532
  # ]
8518
8533
  # ]
8519
8534
  # }
@@ -8522,37 +8537,346 @@ suggest \-\-table item_query \-\-column kana \-\-types correction \-\-frequency_
8522
8537
  .fi
8523
8538
  .UNINDENT
8524
8539
  .UNINDENT
8525
- .SS How it learns
8526
8540
  .sp
8527
- Cooccurrence search uses learned data. They are based on
8528
- query logs, access logs and so on. To create learned data,
8529
- groonga needs user submit inputs with time stamp.
8541
+ Without loading above RK data, you can\(aqt complete registered word "日本" by query \- "nihon".
8530
8542
  .sp
8531
- For example, an user wants to search by "search" but the
8532
- user has typo "saerch" before inputs the correct query. The
8533
- user inputs the query with the following sequence:
8543
+ As the column type of item_query table is VECTOR_COLUMN, you can register multiple readings for registered word.
8544
+ .sp
8545
+ This is the reason that you can also complete the registered word "日本" by query \- "nippon".
8546
+ .sp
8547
+ Execution example:
8534
8548
  .INDENT 0.0
8535
8549
  .INDENT 3.5
8536
- .INDENT 0.0
8537
- .IP 1. 3
8538
- 2011\-08\-10T13:33:23+09:00: s
8539
- .IP 2. 3
8540
- 2011\-08\-10T13:33:23+09:00: sa
8541
- .IP 3. 3
8542
- 2011\-08\-10T13:33:24+09:00: sae
8543
- .IP 4. 3
8544
- 2011\-08\-10T13:33:24+09:00: saer
8545
- .IP 5. 3
8546
- 2011\-08\-10T13:33:24+09:00: saerc
8547
- .IP 6. 3
8548
- 2011\-08\-10T13:33:25+09:00: saerch (submit!)
8549
- .IP 7. 3
8550
- 2011\-08\-10T13:33:29+09:00: serch (correcting...)
8551
- .IP 8. 3
8552
- 2011\-08\-10T13:33:30+09:00: search (submit!)
8553
- .UNINDENT
8554
- .UNINDENT
8555
- .UNINDENT
8550
+ .sp
8551
+ .nf
8552
+ .ft C
8553
+ suggest \-\-table item_query \-\-column kana \-\-types complete \-\-frequency_threshold 1 \-\-query nippon
8554
+ # [
8555
+ # [
8556
+ # 0,
8557
+ # 1337566253.89858,
8558
+ # 0.000355720520019531
8559
+ # ],
8560
+ # {
8561
+ # "complete": [
8562
+ # [
8563
+ # 1
8564
+ # ],
8565
+ # [
8566
+ # [
8567
+ # "_key",
8568
+ # "ShortText"
8569
+ # ],
8570
+ # [
8571
+ # "_score",
8572
+ # "Int32"
8573
+ # ]
8574
+ # ],
8575
+ # [
8576
+ # "日本",
8577
+ # 2
8578
+ # ]
8579
+ # ]
8580
+ # }
8581
+ # ]
8582
+ .ft P
8583
+ .fi
8584
+ .UNINDENT
8585
+ .UNINDENT
8586
+ .sp
8587
+ This feature is very convenient because you can search registered word even though Japanese IM is disabled.
8588
+ .sp
8589
+ If there are multiple candidates as completed result, you can customize priority to set the value of "boost" column in item_query table.
8590
+ .sp
8591
+ Here is the example to customize priority for RK search.
8592
+ .sp
8593
+ Execution example:
8594
+ .INDENT 0.0
8595
+ .INDENT 3.5
8596
+ .sp
8597
+ .nf
8598
+ .ft C
8599
+ load \-\-table event_query \-\-each \(aqsuggest_preparer(_id, type, item, sequence, time, pair_query)\(aq
8600
+ [
8601
+ {"sequence": "1", "time": 1312950805.86059, "item": "日本語", "type": "submit"}
8602
+ {"sequence": "1", "time": 1312950805.86060, "item": "日本人", "type": "submit"}
8603
+ ]
8604
+ # [[0, 1337566253.89858, 0.000355720520019531], 2]
8605
+ load \-\-table item_query
8606
+ [
8607
+ {"_key":"日本語", "kana":"ニホンゴ"}
8608
+ {"_key":"日本人", "kana":"ニホンジン"}
8609
+ ]
8610
+ # [[0, 1337566253.89858, 0.000355720520019531], 2]
8611
+ suggest \-\-table item_query \-\-column kana \-\-types complete \-\-frequency_threshold 1 \-\-query nihon
8612
+ # [
8613
+ # [
8614
+ # 0,
8615
+ # 1337566253.89858,
8616
+ # 0.000355720520019531
8617
+ # ],
8618
+ # {
8619
+ # "complete": [
8620
+ # [
8621
+ # 3
8622
+ # ],
8623
+ # [
8624
+ # [
8625
+ # "_key",
8626
+ # "ShortText"
8627
+ # ],
8628
+ # [
8629
+ # "_score",
8630
+ # "Int32"
8631
+ # ]
8632
+ # ],
8633
+ # [
8634
+ # "日本",
8635
+ # 2
8636
+ # ],
8637
+ # [
8638
+ # "日本人",
8639
+ # 2
8640
+ # ],
8641
+ # [
8642
+ # "日本語",
8643
+ # 2
8644
+ # ]
8645
+ # ]
8646
+ # }
8647
+ # ]
8648
+ load \-\-table item_query
8649
+ [
8650
+ {"_key":"日本人", "boost": 100},
8651
+ ]
8652
+ # [[0, 1337566253.89858, 0.000355720520019531], 1]
8653
+ suggest \-\-table item_query \-\-column kana \-\-types complete \-\-frequency_threshold 1 \-\-query nihon
8654
+ # [
8655
+ # [
8656
+ # 0,
8657
+ # 1337566253.89858,
8658
+ # 0.000355720520019531
8659
+ # ],
8660
+ # {
8661
+ # "complete": [
8662
+ # [
8663
+ # 3
8664
+ # ],
8665
+ # [
8666
+ # [
8667
+ # "_key",
8668
+ # "ShortText"
8669
+ # ],
8670
+ # [
8671
+ # "_score",
8672
+ # "Int32"
8673
+ # ]
8674
+ # ],
8675
+ # [
8676
+ # "日本人",
8677
+ # 102
8678
+ # ],
8679
+ # [
8680
+ # "日本",
8681
+ # 2
8682
+ # ],
8683
+ # [
8684
+ # "日本語",
8685
+ # 2
8686
+ # ]
8687
+ # ]
8688
+ # }
8689
+ # ]
8690
+ .ft P
8691
+ .fi
8692
+ .UNINDENT
8693
+ .UNINDENT
8694
+ .SS Correction
8695
+ .sp
8696
+ This section describes about the following correction
8697
+ features:
8698
+ .INDENT 0.0
8699
+ .IP \(bu 2
8700
+ How it works
8701
+ .IP \(bu 2
8702
+ How to use
8703
+ .IP \(bu 2
8704
+ How to learn
8705
+ .UNINDENT
8706
+ .SS How it works
8707
+ .sp
8708
+ The correction feature uses three searches to compute corrected
8709
+ words:
8710
+ .INDENT 0.0
8711
+ .INDENT 3.5
8712
+ .INDENT 0.0
8713
+ .IP 1. 3
8714
+ Cooccurrence search against learned data.
8715
+ .IP 2. 3
8716
+ Similar search against registered words. (optional)
8717
+ .UNINDENT
8718
+ .UNINDENT
8719
+ .UNINDENT
8720
+ .SS Cooccurrence search
8721
+ .sp
8722
+ Cooccurrence search can find registered words from user\(aqs
8723
+ wrong input. It uses user submit sequences that will be
8724
+ learned from query logs, access logs and so on.
8725
+ .sp
8726
+ For example, there are the following user submissions:
8727
+ .TS
8728
+ center;
8729
+ |l|l|.
8730
+ _
8731
+ T{
8732
+ query
8733
+ T} T{
8734
+ time
8735
+ T}
8736
+ _
8737
+ T{
8738
+ serach (typo!)
8739
+ T} T{
8740
+ 2011\-08\-10T22:20:50+09:00
8741
+ T}
8742
+ _
8743
+ T{
8744
+ search (fixed!)
8745
+ T} T{
8746
+ 2011\-08\-10T22:20:52+09:00
8747
+ T}
8748
+ _
8749
+ .TE
8750
+ .sp
8751
+ Groonga creates the following correction pair from the above
8752
+ submissions:
8753
+ .TS
8754
+ center;
8755
+ |l|l|.
8756
+ _
8757
+ T{
8758
+ input
8759
+ T} T{
8760
+ corrected word
8761
+ T}
8762
+ _
8763
+ T{
8764
+ serach
8765
+ T} T{
8766
+ search
8767
+ T}
8768
+ _
8769
+ .TE
8770
+ .sp
8771
+ Groonga treats continuous submissions within a minute as
8772
+ input correction by user. Not submitted user input sequence
8773
+ between two submissions isn\(aqt used as learned data for
8774
+ correction.
8775
+ .sp
8776
+ If an user inputs "serach" and cooccurrence search returns
8777
+ "search" because "serach" is in input column and
8778
+ corresponding corrected word column value is "search".
8779
+ .SS Similar search
8780
+ .sp
8781
+ Similar search can find registered words that has one or
8782
+ more the same tokens as user input. TokenBigram tokenizer is
8783
+ used for tokenization because suggest dataset schema
8784
+ created by \fB/reference/executables/groonga\-suggest\-create\-dataset\fP
8785
+ uses TokenBigram tokenizer as the default tokenizer.
8786
+ .sp
8787
+ For example, there is a registered query "search engine". An
8788
+ user can find "search engine" by "web search service",
8789
+ "sound engine" and so on. Because "search engine" and "web
8790
+ search engine" have the same token "search" and "search
8791
+ engine" and "sound engine" have the same token "engine".
8792
+ .sp
8793
+ "search engine" is tokenized to "search" and "engine"
8794
+ tokens. (Groonga\(aqs TokenBigram tokenizer doesn\(aqt tokenize
8795
+ two characters for continuous alphabets and continuous
8796
+ digits for reducing search
8797
+ noise. TokenBigramSplitSymbolAlphaDigit tokenizer should be
8798
+ used to ensure tokenizing to two characters.) "web search
8799
+ service" is tokenized to "web", "search" and
8800
+ "service". "sound engine" is tokenized to "sound" and
8801
+ "engine".
8802
+ .SS How to use
8803
+ .sp
8804
+ Groonga provides \fB/reference/commands/suggest\fP command to use
8805
+ correction. \fI\-\-type correct\fP option requests corrections.
8806
+ .sp
8807
+ For example, here is an command to get correction results by
8808
+ "saerch":
8809
+ .sp
8810
+ Execution example:
8811
+ .INDENT 0.0
8812
+ .INDENT 3.5
8813
+ .sp
8814
+ .nf
8815
+ .ft C
8816
+ suggest \-\-table item_query \-\-column kana \-\-types correction \-\-frequency_threshold 1 \-\-query saerch
8817
+ # [
8818
+ # [
8819
+ # 0,
8820
+ # 1337566253.89858,
8821
+ # 0.000355720520019531
8822
+ # ],
8823
+ # {
8824
+ # "correct": [
8825
+ # [
8826
+ # 1
8827
+ # ],
8828
+ # [
8829
+ # [
8830
+ # "_key",
8831
+ # "ShortText"
8832
+ # ],
8833
+ # [
8834
+ # "_score",
8835
+ # "Int32"
8836
+ # ]
8837
+ # ],
8838
+ # [
8839
+ # "search",
8840
+ # 1
8841
+ # ]
8842
+ # ]
8843
+ # }
8844
+ # ]
8845
+ .ft P
8846
+ .fi
8847
+ .UNINDENT
8848
+ .UNINDENT
8849
+ .SS How it learns
8850
+ .sp
8851
+ Cooccurrence search uses learned data. They are based on
8852
+ query logs, access logs and so on. To create learned data,
8853
+ groonga needs user submit inputs with time stamp.
8854
+ .sp
8855
+ For example, an user wants to search by "search" but the
8856
+ user has typo "saerch" before inputs the correct query. The
8857
+ user inputs the query with the following sequence:
8858
+ .INDENT 0.0
8859
+ .INDENT 3.5
8860
+ .INDENT 0.0
8861
+ .IP 1. 3
8862
+ 2011\-08\-10T13:33:23+09:00: s
8863
+ .IP 2. 3
8864
+ 2011\-08\-10T13:33:23+09:00: sa
8865
+ .IP 3. 3
8866
+ 2011\-08\-10T13:33:24+09:00: sae
8867
+ .IP 4. 3
8868
+ 2011\-08\-10T13:33:24+09:00: saer
8869
+ .IP 5. 3
8870
+ 2011\-08\-10T13:33:24+09:00: saerc
8871
+ .IP 6. 3
8872
+ 2011\-08\-10T13:33:25+09:00: saerch (submit!)
8873
+ .IP 7. 3
8874
+ 2011\-08\-10T13:33:29+09:00: serch (correcting...)
8875
+ .IP 8. 3
8876
+ 2011\-08\-10T13:33:30+09:00: search (submit!)
8877
+ .UNINDENT
8878
+ .UNINDENT
8879
+ .UNINDENT
8556
8880
  .sp
8557
8881
  Groonga can be learned from the input sequence by the
8558
8882
  following command:
@@ -10368,9 +10692,6 @@ DBに定義されているテーブルを削除します。
10368
10692
  .B \fBcolumn_remove\fP
10369
10693
  テーブルに定義されているカラムを削除します。
10370
10694
  .TP
10371
- .B \fBview_add\fP
10372
- VIEW型のテーブルに要素となるテーブルを定義します。
10373
- .TP
10374
10695
  .B \fBload\fP
10375
10696
  テーブルにレコードを挿入します。
10376
10697
  .TP
@@ -10641,7 +10962,31 @@ Synopsis:
10641
10962
  .sp
10642
10963
  .nf
10643
10964
  .ft C
10644
- groonga_database /path/to/groonga/database;
10965
+ groonga_database /path/to/groonga/database;
10966
+ .ft P
10967
+ .fi
10968
+ .UNINDENT
10969
+ .UNINDENT
10970
+ .INDENT 0.0
10971
+ .TP
10972
+ .B Default
10973
+ \fBgroonga_database /usr/local/var/lib/groonga/db/db;\fP
10974
+ .TP
10975
+ .B Context
10976
+ \fBhttp\fP, \fBserver\fP, \fBlocation\fP
10977
+ .UNINDENT
10978
+ .sp
10979
+ Specifies the path to a groonga database. This is the required
10980
+ directive.
10981
+ .SS \fBgroonga_database_auto_create\fP
10982
+ .sp
10983
+ Synopsis:
10984
+ .INDENT 0.0
10985
+ .INDENT 3.5
10986
+ .sp
10987
+ .nf
10988
+ .ft C
10989
+ groonga_database_auto_create on | off;
10645
10990
  .ft P
10646
10991
  .fi
10647
10992
  .UNINDENT
@@ -10649,17 +10994,23 @@ groonga_database /path/to/groonga/database;
10649
10994
  .INDENT 0.0
10650
10995
  .TP
10651
10996
  .B Default
10652
- \fBgroonga_database /usr/local/var/lib/groonga/db/db;\fP
10997
+ \fBgroonga_database_auto_create on;\fP
10653
10998
  .TP
10654
10999
  .B Context
10655
11000
  \fBhttp\fP, \fBserver\fP, \fBlocation\fP
10656
11001
  .UNINDENT
10657
11002
  .sp
10658
- Specifies the path to a groonga database. This is the required
10659
- directive.
10660
- .SS \fBgroonga_database_auto_create\fP
11003
+ Specifies whether groonga database is created automatically or not. If
11004
+ the value is \fBon\fP and the groonga database specified by
11005
+ \fIgroonga\-database\fP doesn\(aqt exist, the groonga database is created
11006
+ automatically. If the groonga database exists, groonga\-httpd does
11007
+ nothing.
10661
11008
  .sp
10662
- TODO
11009
+ If parent directory doesn\(aqt exist, parent directory is also created
11010
+ recursively.
11011
+ .sp
11012
+ The default value is \fBon\fP. Normally, the value doesn\(aqt need to be
11013
+ changed.
10663
11014
  .SS \fBgroonga_base_path\fP
10664
11015
  .sp
10665
11016
  Synopsis:
@@ -10879,6 +11230,49 @@ This isn\(aqt a groonga\-httpd specific directive, but an nginx\(aqs one. For de
10879
11230
  see \fI\%http://wiki.nginx.org/CoreModule#worker_processes\fP.
10880
11231
  .sp
10881
11232
  By default, this is set to 1. It is nginx\(aqs default.
11233
+ .SS \fBgroonga_cache_limit\fP
11234
+ .sp
11235
+ This directive is introduced to customize cache limit for each worker process.
11236
+ .sp
11237
+ Synopsis:
11238
+ .INDENT 0.0
11239
+ .INDENT 3.5
11240
+ .sp
11241
+ .nf
11242
+ .ft C
11243
+ groonga_cache_limit CACHE_LIMIT;
11244
+ .ft P
11245
+ .fi
11246
+ .UNINDENT
11247
+ .UNINDENT
11248
+ .INDENT 0.0
11249
+ .TP
11250
+ .B Default
11251
+ 100
11252
+ .TP
11253
+ .B Context
11254
+ \fBhttp\fP, \fBserver\fP, \fBlocation\fP
11255
+ .UNINDENT
11256
+ .sp
11257
+ Specifies groonga\(aqs limit of query cache in the \fBhttp\fP, \fBserver\fP or
11258
+ \fBlocation\fP block. The default value is 100.
11259
+ You can disable query cache to specify 0 to \fBgroonga_cache_limit\fP explicitly.
11260
+ .sp
11261
+ Examples:
11262
+ .INDENT 0.0
11263
+ .INDENT 3.5
11264
+ .sp
11265
+ .nf
11266
+ .ft C
11267
+ location /d/ {
11268
+ groonga on;
11269
+ # You can customize query cache limit for groonga.
11270
+ groonga_cache_limit 100;
11271
+ }
11272
+ .ft P
11273
+ .fi
11274
+ .UNINDENT
11275
+ .UNINDENT
10882
11276
  .SS \fBproxy_cache\fP
10883
11277
  .sp
10884
11278
  In short, you can use nginx\(aqs reverse proxy and cache mechanism
@@ -11130,6 +11524,28 @@ groonga\-suggest\-create\-dataset [options] DATABASE DATASET
11130
11524
  .SS DESCTIPION
11131
11525
  .sp
11132
11526
  groonga\-suggest\-create\-dataset creates a dataset for \fB/suggest\fP. A database has many datasets. This command just defines schema for a suggestion dataset.
11527
+ .sp
11528
+ This command generates some tables and columns for \fB/suggest\fP.
11529
+ .sp
11530
+ Here is the list of such tables. If you specify \(aqquery\(aq as dataset name, following \(aq_DATASET\(aq suffix are replaced. Thus, \(aqitem_query\(aq, \(aqpair_query\(aq, \(aqsequence_query\(aq, \(aqevent_query\(aq tables are generated.
11531
+ .INDENT 0.0
11532
+ .IP \(bu 2
11533
+ event_type
11534
+ .IP \(bu 2
11535
+ bigram
11536
+ .IP \(bu 2
11537
+ kana
11538
+ .IP \(bu 2
11539
+ item_DATASET
11540
+ .IP \(bu 2
11541
+ pair_DATASET
11542
+ .IP \(bu 2
11543
+ sequence_DATASET
11544
+ .IP \(bu 2
11545
+ event_DATASET
11546
+ .IP \(bu 2
11547
+ configuration
11548
+ .UNINDENT
11133
11549
  .SS OPTIONS
11134
11550
  .sp
11135
11551
  None.
@@ -11145,8 +11561,100 @@ TODO
11145
11561
  .SS SEE ALSO
11146
11562
  .sp
11147
11563
  \fB/suggest\fP
11148
- .. : doc:\fIgroonga\-suggest\-httpd\fP
11149
- .. : doc:\fIgroonga\-suggest\-learner\fP
11564
+ \fBgroonga\-suggest\-httpd\fP
11565
+ \fBgroonga\-suggest\-learner\fP
11566
+ .SS groonga\-suggest\-httpd
11567
+ .SS Summary
11568
+ .sp
11569
+ TODO
11570
+ .SS Synopsis
11571
+ .INDENT 0.0
11572
+ .INDENT 3.5
11573
+ .sp
11574
+ .nf
11575
+ .ft C
11576
+ groonga\-suggest\-httpd [options] database_path
11577
+ .ft P
11578
+ .fi
11579
+ .UNINDENT
11580
+ .UNINDENT
11581
+ .SS Usage
11582
+ .sp
11583
+ TODO
11584
+ .SS Options
11585
+ .INDENT 0.0
11586
+ .TP
11587
+ .B \-p, \-\-port
11588
+ Specify http server port number. The default value is 8080.
11589
+ .UNINDENT
11590
+ .INDENT 0.0
11591
+ .TP
11592
+ .B \-t, \-\-n\-threads
11593
+ Specify number of threads. The default value is 8.
11594
+ .UNINDENT
11595
+ .INDENT 0.0
11596
+ .TP
11597
+ .B \-s, \-\-send\-endpoint
11598
+ Specify endpoint for sender.
11599
+ .UNINDENT
11600
+ .INDENT 0.0
11601
+ .TP
11602
+ .B \-r, \-\-receive\-endpoint
11603
+ Specify endpoint for receiver.
11604
+ .UNINDENT
11605
+ .INDENT 0.0
11606
+ .TP
11607
+ .B \-l, \-\-log\-base\-path
11608
+ Specify path prefix of log.
11609
+ .UNINDENT
11610
+ .INDENT 0.0
11611
+ .TP
11612
+ .B \-\-n\-lines\-per\-log\-file
11613
+ Specify the number of lines in a log file. The default value is 1,000,000.
11614
+ .UNINDENT
11615
+ .INDENT 0.0
11616
+ .TP
11617
+ .B \-d, \-\-daemon
11618
+ Specify this option to daemonize.
11619
+ .UNINDENT
11620
+ .INDENT 0.0
11621
+ .TP
11622
+ .B \-\-disable\-max\-fd\-check
11623
+ Specify this option to disable checking max fd on start.
11624
+ .UNINDENT
11625
+ .SS Parameters
11626
+ .sp
11627
+ There is one required parameter \- \fBdatabase_path\fP.
11628
+ .SS \fBdatabase_path\fP
11629
+ .sp
11630
+ Specifies the path to a groonga database.
11631
+ .SS groonga\-suggest\-learner
11632
+ .SS Summary
11633
+ .sp
11634
+ TODO
11635
+ .SS Synopsis
11636
+ .INDENT 0.0
11637
+ .INDENT 3.5
11638
+ .sp
11639
+ .nf
11640
+ .ft C
11641
+ groonga\-suggest\-learner [options] database_path
11642
+ .ft P
11643
+ .fi
11644
+ .UNINDENT
11645
+ .UNINDENT
11646
+ .SS Usage
11647
+ .sp
11648
+ TODO
11649
+ .SS Options
11650
+ .sp
11651
+ TODO
11652
+ .SS Parameters
11653
+ .sp
11654
+ There is one required parameter \- \fBdatabase_path\fP.
11655
+ .SS \fBdatabase_path\fP
11656
+ .sp
11657
+ Specifies the path to a groonga database.
11150
11658
  .SS Output
11151
11659
  .sp
11152
11660
  Groonga supports the following output format types:
@@ -12022,7 +12530,7 @@ max number of query cache entries.
12022
12530
  .sp
12023
12531
  .nf
12024
12532
  .ft C
12025
- [[HEADER, n_entries]]
12533
+ [[HEADER, N_ENTRIES]]
12026
12534
  .ft P
12027
12535
  .fi
12028
12536
  .UNINDENT
@@ -12035,10 +12543,10 @@ See \fB/reference/command/output_format\fP about \fBHEADER\fP.
12035
12543
  .UNINDENT
12036
12544
  .UNINDENT
12037
12545
  .sp
12038
- \fBn_entries\fP
12546
+ \fBN_ENTRIES\fP
12039
12547
  .INDENT 0.0
12040
12548
  .INDENT 3.5
12041
- \fBn_entries\fP is the current max number of query cache entries. It
12549
+ \fBN_ENTRIES\fP is the current max number of query cache entries. It
12042
12550
  is a number.
12043
12551
  .UNINDENT
12044
12552
  .UNINDENT
@@ -12363,11 +12871,15 @@ clearlock Entry.body
12363
12871
  .SS 関連項目
12364
12872
  .sp
12365
12873
  \fBload\fP
12366
- .SS column_create
12367
- .SS 名前
12874
+ .SS \fBcolumn_create\fP
12875
+ .SS Summary
12368
12876
  .sp
12369
12877
  column_create \- カラムの追加
12370
- .SS 書式
12878
+ .sp
12879
+ groonga組込コマンドの一つであるcolumn_createについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
12880
+ .sp
12881
+ column_createは、使用しているデータベースのテーブルに対してカラムを追加します。
12882
+ .SS Syntax
12371
12883
  .INDENT 0.0
12372
12884
  .INDENT 3.5
12373
12885
  .sp
@@ -12378,12 +12890,34 @@ column_create table name flags type [source]
12378
12890
  .fi
12379
12891
  .UNINDENT
12380
12892
  .UNINDENT
12381
- .SS 説明
12893
+ .SS Usage
12382
12894
  .sp
12383
- groonga組込コマンドの一つであるcolumn_createについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
12895
+ テーブルEntryに、ShortText型の値を格納するカラム、bodyを作成します。:
12896
+ .INDENT 0.0
12897
+ .INDENT 3.5
12384
12898
  .sp
12385
- column_createは、使用しているデータベースのテーブルに対してカラムを追加します。
12386
- .SS 引数
12899
+ .nf
12900
+ .ft C
12901
+ column_create Entry body \-\-type ShortText
12902
+ [true]
12903
+ .ft P
12904
+ .fi
12905
+ .UNINDENT
12906
+ .UNINDENT
12907
+ .sp
12908
+ テーブルTermに、Entryテーブルのbodyカラムの値を対象とする完全転置インデックス型カラム、entry_bodyを作成します。:
12909
+ .INDENT 0.0
12910
+ .INDENT 3.5
12911
+ .sp
12912
+ .nf
12913
+ .ft C
12914
+ column_create Term entry_body COLUMN_INDEX|WITH_POSITION Entry body
12915
+ [true]
12916
+ .ft P
12917
+ .fi
12918
+ .UNINDENT
12919
+ .UNINDENT
12920
+ .SS Parameters
12387
12921
  .sp
12388
12922
  \fBtable\fP
12389
12923
  .INDENT 0.0
@@ -12417,6 +12951,16 @@ column_createは、使用しているデータベースのテーブルに対し
12417
12951
  インデックス型のカラムを作成します。
12418
12952
  .UNINDENT
12419
12953
  .sp
12954
+ There are two flags to compress the value of column, but you can\(aqt specify these flags for now because there are memory leaks issue \fI\%GitHub#6\fP when refers the value of column. This issue occurs both of them (zlib and lzo).
12955
+ .INDENT 0.0
12956
+ .TP
12957
+ .B 16, \fBCOMPRESS_ZLIB\fP
12958
+ Reserved. Compress the value of column by using zlib. This flag is disabled feature even if you build groonga with \fB\-\-with\-zlib\fP.
12959
+ .TP
12960
+ .B 32, \fBCOMPRESS_LZO\fP
12961
+ Reserved. Compress the value of column by using lzo. This flag is disabled feature even if you build groonga with \fB\-\-with\-lzo\fP.
12962
+ .UNINDENT
12963
+ .sp
12420
12964
  インデックス型のカラムについては、flagsの値に以下の値を加えることによって、追加の属
12421
12965
  性を指定することができます。
12422
12966
  .INDENT 0.0
@@ -12446,50 +12990,30 @@ column_createは、使用しているデータベースのテーブルに対し
12446
12990
  インデックス型のカラムを作成した場合は、インデックス対象となるカラムをsource引数に指定します。
12447
12991
  .UNINDENT
12448
12992
  .UNINDENT
12449
- .SS 返値
12450
- .SS json形式
12993
+ .SS Return value
12451
12994
  .INDENT 0.0
12452
12995
  .INDENT 3.5
12453
12996
  .sp
12454
12997
  .nf
12455
12998
  .ft C
12456
- [成功かどうかのフラグ]
12999
+ [HEADER, SUCCEEDED]
12457
13000
  .ft P
12458
13001
  .fi
12459
13002
  .UNINDENT
12460
13003
  .UNINDENT
12461
13004
  .sp
12462
- \fB成功かどうかのフラグ\fP
12463
- .INDENT 0.0
12464
- .INDENT 3.5
12465
- エラーが生じなかった場合にはtrue、エラーが生じた場合にはfalseを返す。
12466
- .UNINDENT
12467
- .UNINDENT
12468
- .SS 例
12469
- .sp
12470
- テーブルEntryに、ShortText型の値を格納するカラム、bodyを作成します。:
13005
+ \fBHEADER\fP
12471
13006
  .INDENT 0.0
12472
13007
  .INDENT 3.5
12473
- .sp
12474
- .nf
12475
- .ft C
12476
- column_create Entry body \-\-type ShortText
12477
- [true]
12478
- .ft P
12479
- .fi
13008
+ The format of HEADER is [0, UNIX_TIME_WHEN_COMMAND_IS_STARTED, ELAPSED_TIME].
13009
+ See \fB/reference/command/output_format\fP about HEADER.
12480
13010
  .UNINDENT
12481
13011
  .UNINDENT
12482
13012
  .sp
12483
- テーブルTermに、Entryテーブルのbodyカラムの値を対象とする完全転置インデックス型カラム、entry_bodyを作成します。:
13013
+ \fBSUCCEEDED\fP
12484
13014
  .INDENT 0.0
12485
13015
  .INDENT 3.5
12486
- .sp
12487
- .nf
12488
- .ft C
12489
- column_create Term entry_body COLUMN_INDEX|WITH_POSITION Entry body
12490
- [true]
12491
- .ft P
12492
- .fi
13016
+ If command is succeeded, it returns true on success, false otherwise.
12493
13017
  .UNINDENT
12494
13018
  .UNINDENT
12495
13019
  .SS column_list
@@ -13872,14 +14396,16 @@ There is no need to create table to use \fBnormalize\fP command.
13872
14396
  It is usefull for you to check the results of normalizer.
13873
14397
  .SS Syntax
13874
14398
  .sp
13875
- \fBnormalize\fP commands takes two parameters \- \fBnormalizer\fP and \fBstring\fP.
13876
- Both of them are required.
14399
+ \fBnormalize\fP commands has two required parameters. They are
14400
+ \fBnormalizer\fP and \fBstring\fP.
13877
14401
  .INDENT 0.0
13878
14402
  .INDENT 3.5
13879
14403
  .sp
13880
14404
  .nf
13881
14405
  .ft C
13882
- normalize normalizer string
14406
+ normalize normalizer
14407
+ string
14408
+ [flags=NONE]
13883
14409
  .ft P
13884
14410
  .fi
13885
14411
  .UNINDENT
@@ -13918,19 +14444,98 @@ This section describes parameters of \fBnormalizer\fP.
13918
14444
  There are required parameters, \fBnormalizer\fP and \fBstring\fP.
13919
14445
  .SS \fBnormalizer\fP
13920
14446
  .sp
13921
- It specifies the name of normalizer.
13922
- Currently, \fBnormalize\fP command accepts \fBNormalizerAuto\fP or \fBNormalizerNFKC51\fP as built\-in normalizer.
13923
- If you want to try another normalizer, you need to register additional normalizer plugin by \fBregister\fP command.
14447
+ It specifies the normalizer name. \fBnormalize\fP command uses the
14448
+ normalizer that is named \fBnormalizer\fP.
14449
+ .sp
14450
+ See \fB/reference/normalizers\fP about built\-in normalizers.
14451
+ .sp
14452
+ Here is an example to use built\-in \fBNormalizerAuto\fP normalizer.
14453
+ .sp
14454
+ TODO
14455
+ .sp
14456
+ If you want to use other normalizers, you need to register additional
14457
+ normalizer plugin by \fBregister\fP command. For example, you can use
14458
+ MySQL compatible normalizer by registering \fI\%groonga\-normalizer\-mysql\fP.
13924
14459
  .SS \fBstring\fP
13925
14460
  .sp
13926
14461
  It specifies any string which you want to normalize.
14462
+ .sp
14463
+ If you want to include spaces in \fBstring\fP, you need to quote
14464
+ \fBstring\fP by single quotation (\fB\(aq\fP) or double quotation (\fB"\fP).
14465
+ .sp
14466
+ Here is an example to use spaces in \fBstring\fP.
14467
+ .sp
14468
+ TODO
14469
+ .SS Optional parameters
14470
+ .sp
14471
+ There are optional parameters.
14472
+ .SS \fBflags\fP
14473
+ .sp
14474
+ It specifies a normalization customize options. You can specify
14475
+ multiple options separated by "\fB|\fP". For example,
14476
+ \fBREMOVE_BLANK|WITH_TYPES\fP.
14477
+ .sp
14478
+ Here are available flags.
14479
+ .TS
14480
+ center;
14481
+ |l|l|.
14482
+ _
14483
+ T{
14484
+ Flag
14485
+ T} T{
14486
+ Description
14487
+ T}
14488
+ _
14489
+ T{
14490
+ \fBNONE\fP
14491
+ T} T{
14492
+ Just ignored.
14493
+ T}
14494
+ _
14495
+ T{
14496
+ \fBREMOVE_BLANK\fP
14497
+ T} T{
14498
+ TODO
14499
+ T}
14500
+ _
14501
+ T{
14502
+ \fBWITH_TYPES\fP
14503
+ T} T{
14504
+ TODO
14505
+ T}
14506
+ _
14507
+ T{
14508
+ \fBWITH_CHECKS\fP
14509
+ T} T{
14510
+ TODO
14511
+ T}
14512
+ _
14513
+ T{
14514
+ \fBREMOVE_TOKENIZED_DELIMITER\fP
14515
+ T} T{
14516
+ TODO
14517
+ T}
14518
+ _
14519
+ .TE
14520
+ .sp
14521
+ Here is an example that uses \fBREMOVE_BLANK\fP.
14522
+ .sp
14523
+ TODO
14524
+ .sp
14525
+ Here is an example that uses \fBWITH_TYPES\fP.
14526
+ .sp
14527
+ TODO
14528
+ .sp
14529
+ Here is an example that uses \fBREMOVE_TOKENIZED_DELIMITER\fP.
14530
+ .sp
14531
+ TODO
13927
14532
  .SS Return value
13928
14533
  .INDENT 0.0
13929
14534
  .INDENT 3.5
13930
14535
  .sp
13931
14536
  .nf
13932
14537
  .ft C
13933
- [HEADER, normalized]
14538
+ [HEADER, normalized_text]
13934
14539
  .ft P
13935
14540
  .fi
13936
14541
  .UNINDENT
@@ -13944,10 +14549,34 @@ See \fB/reference/command/output_format\fP about HEADER.
13944
14549
  .UNINDENT
13945
14550
  .UNINDENT
13946
14551
  .sp
13947
- \fBnormalized\fP
14552
+ \fBnormalized_text\fP
13948
14553
  .INDENT 0.0
13949
14554
  .INDENT 3.5
13950
- normalized is the normalized text by the specified normalizer.
14555
+ \fBnormalized_text\fP is an object that has the following attributes.
14556
+ .TS
14557
+ center;
14558
+ |l|l|.
14559
+ _
14560
+ T{
14561
+ Name
14562
+ T} T{
14563
+ Description
14564
+ T}
14565
+ _
14566
+ T{
14567
+ \fBnormalized\fP
14568
+ T} T{
14569
+ The normalized text.
14570
+ T}
14571
+ _
14572
+ T{
14573
+ \fBtypes\fP
14574
+ T} T{
14575
+ An array of types of the normalized text. The N\-th \fBtypes\fP shows
14576
+ the type of the N\-th character in \fBnormalized\fP.
14577
+ T}
14578
+ _
14579
+ .TE
13951
14580
  .UNINDENT
13952
14581
  .UNINDENT
13953
14582
  .SS See also
@@ -14066,7 +14695,7 @@ See \fB/reference/command/output_format\fP for \fBHEADER\fP.
14066
14695
  .SS \fBruby_eval\fP
14067
14696
  .SS Summary
14068
14697
  .sp
14069
- \fBruby_eval\fP command evaluates ruby script and returns the result.
14698
+ \fBruby_eval\fP command evaluates Ruby script and returns the result.
14070
14699
  .SS Syntax
14071
14700
  .sp
14072
14701
  \fBruby_eval\fP has one required parameter:
@@ -14075,7 +14704,7 @@ See \fB/reference/command/output_format\fP for \fBHEADER\fP.
14075
14704
  .sp
14076
14705
  .nf
14077
14706
  .ft C
14078
- ruby_eval ruby_script
14707
+ ruby_eval script
14079
14708
  .ft P
14080
14709
  .fi
14081
14710
  .UNINDENT
@@ -14084,7 +14713,7 @@ ruby_eval ruby_script
14084
14713
  .sp
14085
14714
  You can execute any scripts which mruby supports by calling \fBruby_eval\fP.
14086
14715
  .sp
14087
- Here is an example that just calculate \fB1 + 2\fP by mruby plugin.
14716
+ Here is an example that just calculate \fB1 + 2\fP as Ruby script.
14088
14717
  .sp
14089
14718
  Execution example:
14090
14719
  .INDENT 0.0
@@ -14108,18 +14737,19 @@ and the specification may be changed in the future.
14108
14737
  .SS Parameters
14109
14738
  .sp
14110
14739
  This section describes all parameters.
14111
- .SS \fBruby_script\fP
14740
+ .SS \fBscript\fP
14112
14741
  .sp
14113
- It specifies the ruby script which you want to evaluate.
14742
+ It specifies the Ruby script which you want to evaluate.
14114
14743
  .SS Return value
14115
14744
  .sp
14116
- \fBruby_eval\fP returns the evaluated result which key is "value" as json format:
14745
+ \fBruby_eval\fP returns the evaluated result with metadata such as
14746
+ exception information (Including metadata isn\(aqt implemented yet):
14117
14747
  .INDENT 0.0
14118
14748
  .INDENT 3.5
14119
14749
  .sp
14120
14750
  .nf
14121
14751
  .ft C
14122
- [[HEADER, EVALUATED]]
14752
+ [HEADER, {"value": EVALUATED_VALUE}]
14123
14753
  .ft P
14124
14754
  .fi
14125
14755
  .UNINDENT
@@ -14132,36 +14762,82 @@ See \fB/reference/command/output_format\fP about \fBHEADER\fP.
14132
14762
  .UNINDENT
14133
14763
  .UNINDENT
14134
14764
  .sp
14135
- \fBEVALUATED\fP
14765
+ \fBEVALUATED_VALUE\fP
14136
14766
  .INDENT 0.0
14137
14767
  .INDENT 3.5
14138
- \fBEVALUATED\fP consists of pair of key and value in forms of {key:value}.
14139
- .TS
14140
- center;
14141
- |l|l|.
14142
- _
14143
- T{
14144
- Name
14145
- T} T{
14146
- Description
14147
- T}
14148
- _
14149
- T{
14150
- \fBkey\fP
14151
- T} T{
14152
- reserved word \(aqvalue\(aq.
14153
- T}
14154
- _
14155
- T{
14156
- \fBvalue\fP
14157
- T} T{
14158
- the value of evaluated script. It must be a number.
14159
- T}
14160
- _
14161
- .TE
14768
+ \fBEVALUATED_VALUE\fP is the evaludated value of \fBruby_script\fP.
14769
+ .sp
14770
+ \fBruby_eval\fP supports only a number for evaluated value for now.
14771
+ Supported types will be increased in the future.
14772
+ .UNINDENT
14773
+ .UNINDENT
14774
+ .SS See also
14775
+ .SS \fBruby_load\fP
14776
+ .SS Summary
14777
+ .sp
14778
+ \fBruby_load\fP command loads specified Ruby script.
14779
+ .SS Syntax
14780
+ .sp
14781
+ \fBruby_load\fP has one required parameter:
14782
+ .INDENT 0.0
14783
+ .INDENT 3.5
14784
+ .sp
14785
+ .nf
14786
+ .ft C
14787
+ ruby_load path
14788
+ .ft P
14789
+ .fi
14790
+ .UNINDENT
14791
+ .UNINDENT
14792
+ .SS Usage
14793
+ .sp
14794
+ You can load any script file which mruby supports by calling \fBruby_load\fP.
14795
+ .sp
14796
+ Here is an example that just load \fBexpression.rb\fP as Ruby script.
14797
+ .sp
14798
+ Register \fBruby/load\fP plugin to use \fBruby_load\fP command in advance.
14799
+ .sp
14800
+ Note that \fBruby_load\fP is implemented as an experimental plugin,
14801
+ and the specification may be changed in the future.
14802
+ .SS Parameters
14803
+ .sp
14804
+ This section describes all parameters.
14805
+ .SS \fBpath\fP
14806
+ .sp
14807
+ It specifies the Ruby script path which you want to load.
14808
+ .SS Return value
14809
+ .sp
14810
+ \fBruby_load\fP returns the loaded result with metadata such as
14811
+ exception information (Including metadata isn\(aqt implemented yet):
14812
+ .INDENT 0.0
14813
+ .INDENT 3.5
14814
+ .sp
14815
+ .nf
14816
+ .ft C
14817
+ [HEADER, {"value": LOADED_VALUE}]
14818
+ .ft P
14819
+ .fi
14820
+ .UNINDENT
14821
+ .UNINDENT
14822
+ .sp
14823
+ \fBHEADER\fP
14824
+ .INDENT 0.0
14825
+ .INDENT 3.5
14826
+ See \fB/reference/command/output_format\fP about \fBHEADER\fP.
14827
+ .UNINDENT
14828
+ .UNINDENT
14829
+ .sp
14830
+ \fBLOADED_VALUE\fP
14831
+ .INDENT 0.0
14832
+ .INDENT 3.5
14833
+ \fBLOADED_VALUE\fP is the loaded value of ruby script.
14834
+ .sp
14835
+ \fBruby_load\fP just return \fBnull\fP as \fBLOADED_VALUE\fP for now, it will be supported in the future.
14162
14836
  .UNINDENT
14163
14837
  .UNINDENT
14164
14838
  .SS See also
14839
+ .sp
14840
+ \fB/reference/commands/ruby_eval\fP
14165
14841
  .SS \fBselect\fP
14166
14842
  .SS Summary
14167
14843
  .sp
@@ -18168,7 +18844,7 @@ tokenizer that is named \fBtokenizer\fP.
18168
18844
  .sp
18169
18845
  See \fB/reference/tokenizers\fP about built\-in tokenizers.
18170
18846
  .sp
18171
- Here is an example to use \fBTokenTrigram\fP tokenizer.
18847
+ Here is an example to use built\-in \fBTokenTrigram\fP tokenizer.
18172
18848
  .sp
18173
18849
  Execution example:
18174
18850
  .INDENT 0.0
@@ -18253,12 +18929,14 @@ tokenize TokenTrigram "Fulltext Search"
18253
18929
  .sp
18254
18930
  If you want to use other tokenizers, you need to register additional
18255
18931
  tokenizer plugin by \fBregister\fP command. For example, you can use
18256
- MySQL compatible normalizer by registering \fI\%groonga\-normalizer\-mysql\fP.
18932
+ \fI\%KyTea\fP based tokenizer by
18933
+ registering \fBtokenizers/kytea\fP.
18257
18934
  .SS \fBstring\fP
18258
18935
  .sp
18259
- It specifies any string which you want to tokenize. If you want to
18260
- include spaces in \fBstring\fP, you need to quote \fBstring\fP by
18261
- single quotation (\fB\(aq\fP) or double quotation (\fB"\fP).
18936
+ It specifies any string which you want to tokenize.
18937
+ .sp
18938
+ If you want to include spaces in \fBstring\fP, you need to quote
18939
+ \fBstring\fP by single quotation (\fB\(aq\fP) or double quotation (\fB"\fP).
18262
18940
  .sp
18263
18941
  Here is an example to use spaces in \fBstring\fP.
18264
18942
  .sp
@@ -26561,6 +27239,221 @@ Example:
26561
27239
  .fi
26562
27240
  .UNINDENT
26563
27241
  .UNINDENT
27242
+ .SS Tuning
27243
+ .SS Summary
27244
+ .sp
27245
+ There are some tuning parameters for improving groonga performance or
27246
+ handling a large database.
27247
+ .SS Parameters
27248
+ .sp
27249
+ This section describes parameters.
27250
+ .SS The max number of open files per process
27251
+ .sp
27252
+ This parameter is for handling a large database.
27253
+ .sp
27254
+ Groonga creates one or more files per table and colum. If your
27255
+ database has many tables and columns, groonga process needs to open
27256
+ many files.
27257
+ .sp
27258
+ System limits the max number of open files per process. So you need to
27259
+ relax the limitation.
27260
+ .sp
27261
+ Here is an expression that compute how many files are opened by
27262
+ groonga:
27263
+ .INDENT 0.0
27264
+ .INDENT 3.5
27265
+ .sp
27266
+ .nf
27267
+ .ft C
27268
+ 3 (for DB) +
27269
+ N tables +
27270
+ N columns (except index clumns) +
27271
+ (N index columns * 2) +
27272
+ X (the number of plugins etc.)
27273
+ .ft P
27274
+ .fi
27275
+ .UNINDENT
27276
+ .UNINDENT
27277
+ .sp
27278
+ Here is an example schema:
27279
+ .INDENT 0.0
27280
+ .INDENT 3.5
27281
+ .sp
27282
+ .nf
27283
+ .ft C
27284
+ table_create Entries TABLE_HASH_KEY ShortText
27285
+ column_create Entries content COLUMN_SCALAR Text
27286
+ column_create Entries n_likes COLUMN_SCALAR UInt32
27287
+ table_create Terms TABLE_PAT_KEY|KEY_NORMALIZE ShortText \-\-default_tokenizer TokenBigram
27288
+ column_create Terms entries_key_index COLUMN_INDEX|WITH_POSITION Entries _key
27289
+ column_create Terms entries_content_index COLUMN_INDEX|WITH_POSITION Entries content
27290
+ .ft P
27291
+ .fi
27292
+ .UNINDENT
27293
+ .UNINDENT
27294
+ .sp
27295
+ This example opens at least 11 files:
27296
+ .INDENT 0.0
27297
+ .INDENT 3.5
27298
+ .sp
27299
+ .nf
27300
+ .ft C
27301
+ 3 +
27302
+ 2 (Entries and Terms) +
27303
+ 2 (Entries.content and Entries.n_likes) +
27304
+ 4 (Terms.entries_key_index and Terms.entries_content_index) +
27305
+ X = 11 + X
27306
+ .ft P
27307
+ .fi
27308
+ .UNINDENT
27309
+ .UNINDENT
27310
+ .SS Memory usage
27311
+ .sp
27312
+ This parameter is for handling a large database.
27313
+ .sp
27314
+ Groonga maps database files onto memory and accesses to them. Groonga
27315
+ doesn\(aqt maps unnecessary files onto memory until they are nneded.
27316
+ .sp
27317
+ If you access to all data in database, all database files are mapped
27318
+ onto memory. If total size of your database files is 6GiB, your
27319
+ groonga process uses 6GiB memory.
27320
+ .sp
27321
+ Normally, your all database files aren\(aqt mapped onto memry. But is may
27322
+ be occurred. It is an example case that you dump your database.
27323
+ .sp
27324
+ You must have memory and swap that is larger than database.
27325
+ .SS Linux
27326
+ .sp
27327
+ This section describes how to configure parameters on Linux.
27328
+ .SS nofile
27329
+ .sp
27330
+ You can relax the \fItuning\-max\-n\-open\-files\fP parameter by creating
27331
+ a configuration file \fB/etc/security/limits.d/groonga.conf\fP that has
27332
+ the following content:
27333
+ .INDENT 0.0
27334
+ .INDENT 3.5
27335
+ .sp
27336
+ .nf
27337
+ .ft C
27338
+ ${USER} soft nofile ${MAX_VALUE}
27339
+ ${USER} hard nofile ${MAX_VALUE}
27340
+ .ft P
27341
+ .fi
27342
+ .UNINDENT
27343
+ .UNINDENT
27344
+ .sp
27345
+ If you run \fBgroonga\fP process by \fBgroonga\fP user and your groonga
27346
+ process needs to open less than 10000 files, use the following
27347
+ configuration:
27348
+ .INDENT 0.0
27349
+ .INDENT 3.5
27350
+ .sp
27351
+ .nf
27352
+ .ft C
27353
+ groonga soft nofile 10000
27354
+ groonga hard nofile 10000
27355
+ .ft P
27356
+ .fi
27357
+ .UNINDENT
27358
+ .UNINDENT
27359
+ .sp
27360
+ The configuration is applied after your groonga service is restarted
27361
+ or re\-login as your groonga user.
27362
+ .SS vm.overcommit_memory
27363
+ .sp
27364
+ This is \fItuning\-memory\-usage\fP related parameter. You can handle a
27365
+ database that is larger than your memory and swap by setting
27366
+ \fBvm.overcommit_memory\fP kernel parameter to 1. 1 means that groonga
27367
+ can always map database files onto memory. It is no problem until
27368
+ groonga touch mapped database files that their size is larger than
27369
+ memory and swap. Groonga recommends the configuration.
27370
+ .sp
27371
+ See \fI\%Linux kernel documentaion about overcommit\fP
27372
+ about \fBvm.overcommit_memory\fP parameter details.
27373
+ .sp
27374
+ You can set the configuration by putting a configuration file
27375
+ \fB/etc/sysctl.d/groonga.conf\fP that has the following content:
27376
+ .INDENT 0.0
27377
+ .INDENT 3.5
27378
+ .sp
27379
+ .nf
27380
+ .ft C
27381
+ vm.overcommit_memory = 1
27382
+ .ft P
27383
+ .fi
27384
+ .UNINDENT
27385
+ .UNINDENT
27386
+ .sp
27387
+ The configuration can be applied by restarting your system or run the
27388
+ following command:
27389
+ .INDENT 0.0
27390
+ .INDENT 3.5
27391
+ .sp
27392
+ .nf
27393
+ .ft C
27394
+ % sudo sysctl \-p
27395
+ .ft P
27396
+ .fi
27397
+ .UNINDENT
27398
+ .UNINDENT
27399
+ .SS vm.max_map_count
27400
+ .sp
27401
+ This is \fItuning\-memory\-usage\fP related parameter. You can handle a
27402
+ 16GiB or more larger size database by increasing \fBvm.max_map_count\fP
27403
+ kernel parameter. The parameter limits the max number of memory maps.
27404
+ .sp
27405
+ The default value of the kernel parameter may be 65530 or 65536.
27406
+ Groonga maps 256KiB memory chunk at one time. If a database is larger
27407
+ than 16GiB, groonga reaches the limitation. (\fB256KiB * 65536 = 16GiB\fP)
27408
+ .sp
27409
+ You needs to increase the value of the kernel parameter to handle
27410
+ 16GiB or more larger size database. For example, you can handle almost
27411
+ 32GiB size database by \fB65536 * 2 = 131072\fP. You can set the
27412
+ configuration by putting a configuration file
27413
+ \fB/etc/sysctl.d/groonga.conf\fP that has the following content:
27414
+ .INDENT 0.0
27415
+ .INDENT 3.5
27416
+ .sp
27417
+ .nf
27418
+ .ft C
27419
+ vm.max_map_count = 131072
27420
+ .ft P
27421
+ .fi
27422
+ .UNINDENT
27423
+ .UNINDENT
27424
+ .sp
27425
+ Note that your real confiugration file will be the following because
27426
+ you already have \fBvm.overcommit_memory\fP configuration:
27427
+ .INDENT 0.0
27428
+ .INDENT 3.5
27429
+ .sp
27430
+ .nf
27431
+ .ft C
27432
+ vm.overcommit_memory = 1
27433
+ vm.max_map_count = 131072
27434
+ .ft P
27435
+ .fi
27436
+ .UNINDENT
27437
+ .UNINDENT
27438
+ .sp
27439
+ The configuration can be applied by restarting your system or run the
27440
+ following command:
27441
+ .INDENT 0.0
27442
+ .INDENT 3.5
27443
+ .sp
27444
+ .nf
27445
+ .ft C
27446
+ % sudo sysctl \-p
27447
+ .ft P
27448
+ .fi
27449
+ .UNINDENT
27450
+ .UNINDENT
27451
+ .SS FreeBSD
27452
+ .sp
27453
+ This section describes how to configure parameters on FreeBSD.
27454
+ .SS kern.maxfileperproc
27455
+ .sp
27456
+ TODO
26564
27457
  .SS API
26565
27458
  .sp
26566
27459
  Groonga can be used as a fulltext search library. This section
@@ -29788,6 +30681,56 @@ TokenBigramIgnoreBlankSplitSymbolAlphaDigit: 記号・アルファベット・
29788
30681
  .UNINDENT
29789
30682
  .sp
29790
30683
  この場合も対策方法1同様、検索ノイズが上位に現れる可能性が高くなることに注意してください。検索ノイズが多くなった場合は指定する値を低くする必要があります。
30684
+ .SS How to avoid mmap Cannot allocate memory error
30685
+ .SS Example
30686
+ .sp
30687
+ There is a case following mmap error in log file:
30688
+ .INDENT 0.0
30689
+ .INDENT 3.5
30690
+ 2013\-06\-04 08:19:34.835218|A|4e86e700|mmap(4194304,551,432017408)=Cannot allocate memory <13036498944>
30691
+ .UNINDENT
30692
+ .UNINDENT
30693
+ .sp
30694
+ Note that <13036498944> means total size of mmap (almost 12GB) in this case.
30695
+ .SS Solution
30696
+ .sp
30697
+ So you need to confirm following point of views.
30698
+ .INDENT 0.0
30699
+ .IP \(bu 2
30700
+ Are there enough free memory?
30701
+ .IP \(bu 2
30702
+ Are maximum number of mappings exceeded?
30703
+ .UNINDENT
30704
+ .sp
30705
+ To check there are enough free memory, you can use vmstat command.
30706
+ .sp
30707
+ To check whether maximum number of mappings are exceeded, you can investigate the value of vm.max_map_count.
30708
+ .sp
30709
+ If this issue is fixed by modifying the value of vm.max_map_count, it\(aqs exactly the reason.
30710
+ .sp
30711
+ As groonga allocates memory chunks each 256KB, you can estimate the size of database you can handle by following formula:
30712
+ .INDENT 0.0
30713
+ .INDENT 3.5
30714
+ (database size) = vm.max_map_count * (memory chunks)
30715
+ .UNINDENT
30716
+ .UNINDENT
30717
+ .sp
30718
+ If you want to handle over 16GB groonga database, you must specify at least 65536 as the value of vm.max_map_count:
30719
+ .INDENT 0.0
30720
+ .INDENT 3.5
30721
+ database size (16GB) = vm.max_map_count (65536) * memory chunks (256KB)
30722
+ .UNINDENT
30723
+ .UNINDENT
30724
+ .sp
30725
+ You can modify vm.max_map_count temporary by sudo sysctl \-w vm.max_map_count=65536.
30726
+ .sp
30727
+ Then save the configuration value to /etc/sysctl.conf or /etc/sysctl.d/
30728
+ .nf
30729
+ *
30730
+ .fi
30731
+ .conf.
30732
+ .sp
30733
+ See \fB/reference/tuning\fP documentation about tuning related parameters.
29791
30734
  .SH DEVELOPMENT
29792
30735
  .sp
29793
30736
  This section describes about developing with groonga. You may develop
@@ -30052,6 +30995,9 @@ groongaのドキュメントは、Sphinxというツールを用いて作成さ
30052
30995
  .fi
30053
30996
  .UNINDENT
30054
30997
  .UNINDENT
30998
+ .sp
30999
+ This document is also ditributed in forms of release source archive and updated time to time.
31000
+ If you want to refer latest documentation in source form, you can view such files via GitHub repository browser (\fI\%https://github.com/groonga/groonga/tree/master/doc/source\fP).
30055
31001
  .SS pdfの作成
30056
31002
  .sp
30057
31003
  groongaのドキュメントは、pdf出力することもできます。rst2pdfと、IPAフォント(IPA Gothic/IPAexGothic)が必要となります。