Kouhei Sutou
null+****@clear*****
Thu Mar 17 12:56:59 JST 2016
Kouhei Sutou 2016-03-17 12:56:59 +0900 (Thu, 17 Mar 2016) New Revision: 9d5c1f2314e856ecc8f735356244fee9ab3cb9e2 https://github.com/groonga/groonga.org/commit/9d5c1f2314e856ecc8f735356244fee9ab3cb9e2 Message: Update Groonga documents Modified files: docs/contribution/development/build/unix_autotools.html docs/contribution/development/build/unix_cmake.html docs/contribution/development/build/windows_cmake.html docs/contribution/development/cooperation.html docs/contribution/development/query.html docs/contribution/development/release.html docs/contribution/development/repository.html docs/contribution/development/test.html docs/contribution/documentation/i18n.html docs/contribution/documentation/introduction.html docs/development/travis-ci.html docs/install/centos.html docs/install/debian.html docs/install/fedora.html docs/install/mac_os_x.html docs/install/others.html docs/install/solaris.html docs/install/ubuntu.html docs/install/windows.html docs/limitations.html docs/news.html docs/news/1.2.x.html docs/news/2.x.html docs/news/4.x.html docs/reference/alias.html docs/reference/api/grn_cache.html docs/reference/api/grn_column.html docs/reference/api/grn_ctx.html docs/reference/api/grn_expr.html docs/reference/api/grn_thread.html docs/reference/api/overview.html docs/reference/columns/vector.html docs/reference/command/command_version.html docs/reference/command/output_format.html docs/reference/command/pretty_print.html docs/reference/command/request_id.html docs/reference/commands/cache_limit.html docs/reference/commands/check.html docs/reference/commands/clearlock.html docs/reference/commands/column_copy.html docs/reference/commands/column_create.html docs/reference/commands/column_list.html docs/reference/commands/column_remove.html docs/reference/commands/column_rename.html docs/reference/commands/config_delete.html docs/reference/commands/config_get.html docs/reference/commands/config_set.html docs/reference/commands/database_unmap.html docs/reference/commands/define_selector.html docs/reference/commands/defrag.html docs/reference/commands/delete.html docs/reference/commands/dump.html docs/reference/commands/io_flush.html docs/reference/commands/load.html docs/reference/commands/lock_acquire.html docs/reference/commands/lock_clear.html docs/reference/commands/lock_release.html docs/reference/commands/log_level.html docs/reference/commands/log_put.html docs/reference/commands/log_reopen.html docs/reference/commands/logical_count.html docs/reference/commands/logical_parameters.html docs/reference/commands/logical_range_filter.html docs/reference/commands/logical_select.html docs/reference/commands/logical_shard_list.html docs/reference/commands/logical_table_remove.html docs/reference/commands/normalize.html docs/reference/commands/normalizer_list.html docs/reference/commands/object_exist.html docs/reference/commands/object_inspect.html docs/reference/commands/object_remove.html docs/reference/commands/plugin_register.html docs/reference/commands/plugin_unregister.html docs/reference/commands/quit.html docs/reference/commands/register.html docs/reference/commands/reindex.html docs/reference/commands/request_cancel.html docs/reference/commands/ruby_eval.html docs/reference/commands/ruby_load.html docs/reference/commands/schema.html docs/reference/commands/select.html docs/reference/commands/shutdown.html docs/reference/commands/status.html docs/reference/commands/suggest.html docs/reference/commands/table_create.html docs/reference/commands/table_list.html docs/reference/commands/table_remove.html docs/reference/commands/table_rename.html docs/reference/commands/table_tokenize.html docs/reference/commands/thread_limit.html docs/reference/commands/tokenize.html docs/reference/commands/tokenizer_list.html docs/reference/commands/truncate.html docs/reference/configuration.html docs/reference/executables/grndb.html docs/reference/executables/grnslap.html docs/reference/executables/groonga-benchmark.html docs/reference/executables/groonga-httpd.html docs/reference/executables/groonga-server-http.html docs/reference/executables/groonga-suggest-create-dataset.html docs/reference/executables/groonga-suggest-httpd.html docs/reference/executables/groonga-suggest-learner.html docs/reference/executables/groonga.html docs/reference/functions/between.html docs/reference/functions/edit_distance.html docs/reference/functions/geo_distance.html docs/reference/functions/geo_in_circle.html docs/reference/functions/geo_in_rectangle.html docs/reference/functions/highlight_full.html docs/reference/functions/highlight_html.html docs/reference/functions/html_untag.html docs/reference/functions/in_values.html docs/reference/functions/now.html docs/reference/functions/prefix_rk_search.html docs/reference/functions/query.html docs/reference/functions/rand.html docs/reference/functions/snippet_html.html docs/reference/functions/sub_filter.html docs/reference/functions/vector_size.html docs/reference/grn_expr/query_syntax.html docs/reference/grn_expr/script_syntax.html docs/reference/indexing.html docs/reference/log.html docs/reference/normalizers.html docs/reference/operations/prefix_rk_search.html docs/reference/output.html docs/reference/query_expanders/tsv.html docs/reference/regular_expression.html docs/reference/scorer.html docs/reference/scorers/scorer_tf_at_most.html docs/reference/scorers/scorer_tf_idf.html docs/reference/sharding.html docs/reference/suggest/completion.html docs/reference/suggest/correction.html docs/reference/suggest/suggestion.html docs/reference/token_filters.html docs/reference/tokenizers.html docs/reference/tuning.html docs/reference/types.html docs/searchindex.js docs/server/gqtp.html docs/server/http/comparison.html docs/server/memcached.html docs/server/package.html docs/sources/install/mac_os_x.txt docs/sources/limitations.txt docs/sources/news.txt docs/sources/reference/columns/vector.txt docs/sources/reference/commands/column_copy.txt docs/sources/reference/commands/config_delete.txt docs/sources/reference/commands/config_get.txt docs/sources/reference/commands/config_set.txt docs/sources/reference/commands/database_unmap.txt docs/sources/reference/commands/io_flush.txt docs/sources/reference/commands/load.txt docs/sources/reference/commands/logical_count.txt docs/sources/reference/commands/logical_parameters.txt docs/sources/reference/commands/logical_range_filter.txt docs/sources/reference/commands/logical_select.txt docs/sources/reference/commands/logical_shard_list.txt docs/sources/reference/commands/logical_table_remove.txt docs/sources/reference/commands/normalize.txt docs/sources/reference/commands/object_exist.txt docs/sources/reference/commands/object_inspect.txt docs/sources/reference/commands/request_cancel.txt docs/sources/reference/commands/schema.txt docs/sources/reference/commands/select.txt docs/sources/reference/commands/shutdown.txt docs/sources/reference/commands/status.txt docs/sources/reference/commands/table_create.txt docs/sources/reference/commands/thread_limit.txt docs/sources/reference/commands/truncate.txt docs/sources/reference/functions/geo_distance.txt docs/sources/reference/functions/highlight_html.txt docs/sources/reference/functions/query.txt docs/sources/reference/grn_expr/script_syntax.txt docs/sources/reference/scorers/scorer_tf_at_most.txt docs/sources/reference/scorers/scorer_tf_idf.txt docs/sources/reference/types.txt docs/spec/gqtp.html docs/spec/search.html docs/static/basic.css docs/static/doctools.js docs/static/pygments.css docs/static/searchtools.js docs/static/websupport.js docs/troubleshooting/different_results_with_the_same_keyword.html docs/tutorial/data.html docs/tutorial/drilldown.html docs/tutorial/index.html docs/tutorial/introduction.html docs/tutorial/match_columns.html docs/tutorial/micro_blog.html docs/tutorial/network.html docs/tutorial/patricia_trie.html docs/tutorial/query_expansion.html docs/tutorial/search.html ja/docs/contribution/development/build/unix_autotools.html ja/docs/contribution/development/build/unix_cmake.html ja/docs/contribution/development/build/windows_cmake.html ja/docs/contribution/development/cooperation.html ja/docs/contribution/development/query.html ja/docs/contribution/development/release.html ja/docs/contribution/development/repository.html ja/docs/contribution/development/test.html ja/docs/contribution/documentation/i18n.html ja/docs/contribution/documentation/introduction.html ja/docs/development/travis-ci.html ja/docs/install/centos.html ja/docs/install/debian.html ja/docs/install/fedora.html ja/docs/install/mac_os_x.html ja/docs/install/others.html ja/docs/install/solaris.html ja/docs/install/ubuntu.html ja/docs/install/windows.html ja/docs/limitations.html ja/docs/news.html ja/docs/news/1.2.x.html ja/docs/news/2.x.html ja/docs/news/4.x.html ja/docs/reference/alias.html ja/docs/reference/api/grn_cache.html ja/docs/reference/api/grn_column.html ja/docs/reference/api/grn_ctx.html ja/docs/reference/api/grn_expr.html ja/docs/reference/api/grn_thread.html ja/docs/reference/api/overview.html ja/docs/reference/columns/vector.html ja/docs/reference/command/command_version.html ja/docs/reference/command/output_format.html ja/docs/reference/command/pretty_print.html ja/docs/reference/command/request_id.html ja/docs/reference/commands/cache_limit.html ja/docs/reference/commands/check.html ja/docs/reference/commands/clearlock.html ja/docs/reference/commands/column_copy.html ja/docs/reference/commands/column_create.html ja/docs/reference/commands/column_list.html ja/docs/reference/commands/column_remove.html ja/docs/reference/commands/column_rename.html ja/docs/reference/commands/config_delete.html ja/docs/reference/commands/config_get.html ja/docs/reference/commands/config_set.html ja/docs/reference/commands/database_unmap.html ja/docs/reference/commands/define_selector.html ja/docs/reference/commands/defrag.html ja/docs/reference/commands/delete.html ja/docs/reference/commands/dump.html ja/docs/reference/commands/io_flush.html ja/docs/reference/commands/load.html ja/docs/reference/commands/lock_acquire.html ja/docs/reference/commands/lock_clear.html ja/docs/reference/commands/lock_release.html ja/docs/reference/commands/log_level.html ja/docs/reference/commands/log_put.html ja/docs/reference/commands/log_reopen.html ja/docs/reference/commands/logical_count.html ja/docs/reference/commands/logical_parameters.html ja/docs/reference/commands/logical_range_filter.html ja/docs/reference/commands/logical_select.html ja/docs/reference/commands/logical_shard_list.html ja/docs/reference/commands/logical_table_remove.html ja/docs/reference/commands/normalize.html ja/docs/reference/commands/normalizer_list.html ja/docs/reference/commands/object_exist.html ja/docs/reference/commands/object_inspect.html ja/docs/reference/commands/object_remove.html ja/docs/reference/commands/plugin_register.html ja/docs/reference/commands/plugin_unregister.html ja/docs/reference/commands/quit.html ja/docs/reference/commands/register.html ja/docs/reference/commands/reindex.html ja/docs/reference/commands/request_cancel.html ja/docs/reference/commands/ruby_eval.html ja/docs/reference/commands/ruby_load.html ja/docs/reference/commands/schema.html ja/docs/reference/commands/select.html ja/docs/reference/commands/shutdown.html ja/docs/reference/commands/status.html ja/docs/reference/commands/suggest.html ja/docs/reference/commands/table_create.html ja/docs/reference/commands/table_list.html ja/docs/reference/commands/table_remove.html ja/docs/reference/commands/table_rename.html ja/docs/reference/commands/table_tokenize.html ja/docs/reference/commands/thread_limit.html ja/docs/reference/commands/tokenize.html ja/docs/reference/commands/tokenizer_list.html ja/docs/reference/commands/truncate.html ja/docs/reference/configuration.html ja/docs/reference/executables/grndb.html ja/docs/reference/executables/grnslap.html ja/docs/reference/executables/groonga-benchmark.html ja/docs/reference/executables/groonga-httpd.html ja/docs/reference/executables/groonga-server-http.html ja/docs/reference/executables/groonga-suggest-create-dataset.html ja/docs/reference/executables/groonga-suggest-httpd.html ja/docs/reference/executables/groonga-suggest-learner.html ja/docs/reference/executables/groonga.html ja/docs/reference/functions/between.html ja/docs/reference/functions/edit_distance.html ja/docs/reference/functions/geo_distance.html ja/docs/reference/functions/geo_in_circle.html ja/docs/reference/functions/geo_in_rectangle.html ja/docs/reference/functions/highlight_full.html ja/docs/reference/functions/highlight_html.html ja/docs/reference/functions/html_untag.html ja/docs/reference/functions/in_values.html ja/docs/reference/functions/now.html ja/docs/reference/functions/prefix_rk_search.html ja/docs/reference/functions/query.html ja/docs/reference/functions/rand.html ja/docs/reference/functions/snippet_html.html ja/docs/reference/functions/sub_filter.html ja/docs/reference/functions/vector_size.html ja/docs/reference/grn_expr/query_syntax.html ja/docs/reference/grn_expr/script_syntax.html ja/docs/reference/indexing.html ja/docs/reference/log.html ja/docs/reference/normalizers.html ja/docs/reference/operations/prefix_rk_search.html ja/docs/reference/output.html ja/docs/reference/query_expanders/tsv.html ja/docs/reference/regular_expression.html ja/docs/reference/scorer.html ja/docs/reference/scorers/scorer_tf_at_most.html ja/docs/reference/scorers/scorer_tf_idf.html ja/docs/reference/sharding.html ja/docs/reference/suggest/completion.html ja/docs/reference/suggest/correction.html ja/docs/reference/suggest/suggestion.html ja/docs/reference/token_filters.html ja/docs/reference/tokenizers.html ja/docs/reference/tuning.html ja/docs/searchindex.js ja/docs/server/gqtp.html ja/docs/server/http/comparison.html ja/docs/server/memcached.html ja/docs/server/package.html ja/docs/sources/install/mac_os_x.txt ja/docs/sources/limitations.txt ja/docs/sources/news.txt ja/docs/sources/reference/columns/vector.txt ja/docs/sources/reference/commands/column_copy.txt ja/docs/sources/reference/commands/config_delete.txt ja/docs/sources/reference/commands/config_get.txt ja/docs/sources/reference/commands/config_set.txt ja/docs/sources/reference/commands/database_unmap.txt ja/docs/sources/reference/commands/io_flush.txt ja/docs/sources/reference/commands/load.txt ja/docs/sources/reference/commands/logical_count.txt ja/docs/sources/reference/commands/logical_parameters.txt ja/docs/sources/reference/commands/logical_range_filter.txt ja/docs/sources/reference/commands/logical_select.txt ja/docs/sources/reference/commands/logical_shard_list.txt ja/docs/sources/reference/commands/logical_table_remove.txt ja/docs/sources/reference/commands/normalize.txt ja/docs/sources/reference/commands/object_exist.txt ja/docs/sources/reference/commands/object_inspect.txt ja/docs/sources/reference/commands/request_cancel.txt ja/docs/sources/reference/commands/schema.txt ja/docs/sources/reference/commands/select.txt ja/docs/sources/reference/commands/shutdown.txt ja/docs/sources/reference/commands/status.txt ja/docs/sources/reference/commands/table_create.txt ja/docs/sources/reference/commands/thread_limit.txt ja/docs/sources/reference/commands/truncate.txt ja/docs/sources/reference/functions/geo_distance.txt ja/docs/sources/reference/functions/highlight_html.txt ja/docs/sources/reference/functions/query.txt ja/docs/sources/reference/grn_expr/script_syntax.txt ja/docs/sources/reference/scorers/scorer_tf_at_most.txt ja/docs/sources/reference/scorers/scorer_tf_idf.txt ja/docs/sources/reference/types.txt ja/docs/spec/gqtp.html ja/docs/spec/search.html ja/docs/static/basic.css ja/docs/static/doctools.js ja/docs/static/pygments.css ja/docs/static/searchtools.js ja/docs/static/websupport.js ja/docs/troubleshooting/different_results_with_the_same_keyword.html ja/docs/tutorial/data.html ja/docs/tutorial/drilldown.html ja/docs/tutorial/index.html ja/docs/tutorial/introduction.html ja/docs/tutorial/match_columns.html ja/docs/tutorial/micro_blog.html ja/docs/tutorial/network.html ja/docs/tutorial/patricia_trie.html ja/docs/tutorial/query_expansion.html ja/docs/tutorial/search.html Modified: docs/contribution/development/build/unix_autotools.html (+4 -4) =================================================================== --- docs/contribution/development/build/unix_autotools.html 2016-03-05 15:09:34 +0900 (42cc0e7) +++ docs/contribution/development/build/unix_autotools.html 2016-03-17 12:56:59 +0900 (598a07f) @@ -113,7 +113,7 @@ at the repository. Because source code in the repository is the latest.</p> <p>The Groonga repository is hosted on <a class="reference external" href="https://github.com/groonga/groonga">GitHub</a>. Checkout the latest source code from the repository:</p> -<div class="highlight-none"><div class="highlight"><pre>% git clone --recursive git �� github.com:groonga/groonga.git +<div class="highlight-none"><div class="highlight"><pre><span></span>% git clone --recursive git �� github.com:groonga/groonga.git </pre></div> </div> </div> @@ -124,7 +124,7 @@ archive but not included in the repository.</p> <p><code class="docutils literal"><span class="pre">configure</span></code> is a build tool that detects your system and generates build configurations for your environment.</p> <p>Run <code class="docutils literal"><span class="pre">autogen.sh</span></code> to create <code class="docutils literal"><span class="pre">configure</span></code>:</p> -<div class="highlight-none"><div class="highlight"><pre>% ./autogen.sh +<div class="highlight-none"><div class="highlight"><pre><span></span>% ./autogen.sh </pre></div> </div> </div> @@ -133,7 +133,7 @@ build configurations for your environment.</p> <p>You can custom your build configuration by passing options to <code class="docutils literal"><span class="pre">configure</span></code>.</p> <p>Here are recommended <code class="docutils literal"><span class="pre">configure</span></code> options for developers:</p> -<div class="highlight-none"><div class="highlight"><pre>% ./configure --prefix=/tmp/local --enable-debug --enable-mruby --with-ruby +<div class="highlight-none"><div class="highlight"><pre><span></span>% ./configure --prefix=/tmp/local --enable-debug --enable-mruby --with-ruby </pre></div> </div> <p>Here are descriptions of these options:</p> @@ -156,7 +156,7 @@ but developers should enable the feature.</dd> <h2>12.3.2.1.5. Run <code class="docutils literal"><span class="pre">make</span></code><a class="headerlink" href="#run-make" title="Permalink to this headline">¶</a></h2> <p>Now, you can build Groonga.</p> <p>Here is a recommended <code class="docutils literal"><span class="pre">make</span></code> command line for developers:</p> -<div class="highlight-none"><div class="highlight"><pre>% make -j8 > /dev/null +<div class="highlight-none"><div class="highlight"><pre><span></span>% make -j8 > /dev/null </pre></div> </div> <p><code class="docutils literal"><span class="pre">-j8</span></code> decreases build time. It enables parallel build. If you have 8 Modified: docs/contribution/development/build/unix_cmake.html (+3 -3) =================================================================== --- docs/contribution/development/build/unix_cmake.html 2016-03-05 15:09:34 +0900 (95c49fc) +++ docs/contribution/development/build/unix_cmake.html 2016-03-17 12:56:59 +0900 (da32d61) @@ -115,7 +115,7 @@ at the repository. Because source code in the repository is the latest.</p> <p>The Groonga repository is hosted on <a class="reference external" href="https://github.com/groonga/groonga">GitHub</a>. Checkout the latest source code from the repository:</p> -<div class="highlight-none"><div class="highlight"><pre>% git clone --recursive git �� github.com:groonga/groonga.git +<div class="highlight-none"><div class="highlight"><pre><span></span>% git clone --recursive git �� github.com:groonga/groonga.git </pre></div> </div> </div> @@ -125,7 +125,7 @@ code from the repository:</p> <p>You can custom your build configuration by passing options to <code class="docutils literal"><span class="pre">cmake</span></code>.</p> <p>Here are recommended <code class="docutils literal"><span class="pre">cmake</span></code> options for developers:</p> -<div class="highlight-none"><div class="highlight"><pre>% cmake . -DCMAKE_INSTALL_PREFIX=/tmp/local -DGRN_WITH_DEBUG=on -DGRN_WITH_MRUBY=on +<div class="highlight-none"><div class="highlight"><pre><span></span>% cmake . -DCMAKE_INSTALL_PREFIX=/tmp/local -DGRN_WITH_DEBUG=on -DGRN_WITH_MRUBY=on </pre></div> </div> <p>Here are descriptions of these options:</p> @@ -147,7 +147,7 @@ but developers should enable the feature.</div></blockquote> <h2>12.3.2.2.4. Run <code class="docutils literal"><span class="pre">make</span></code><a class="headerlink" href="#run-make" title="Permalink to this headline">¶</a></h2> <p>Now, you can build Groonga.</p> <p>Here is a recommended <code class="docutils literal"><span class="pre">make</span></code> command line for developers:</p> -<div class="highlight-none"><div class="highlight"><pre>% make -j8 > /dev/null +<div class="highlight-none"><div class="highlight"><pre><span></span>% make -j8 > /dev/null </pre></div> </div> <p><code class="docutils literal"><span class="pre">-j8</span></code> decreases build time. It enables parallel build. If you have 8 Modified: docs/contribution/development/build/windows_cmake.html (+3 -3) =================================================================== --- docs/contribution/development/build/windows_cmake.html 2016-03-05 15:09:34 +0900 (d3185d0) +++ docs/contribution/development/build/windows_cmake.html 2016-03-17 12:56:59 +0900 (3e505db) @@ -121,7 +121,7 @@ at the repository. Because source code in the repository is the latest.</p> <p>The Groonga repository is hosted on <a class="reference external" href="https://github.com/groonga/groonga">GitHub</a>. Checkout the latest source code from the repository:</p> -<div class="highlight-none"><div class="highlight"><pre>> git clone --recursive git �� github.com:groonga/groonga.git +<div class="highlight-none"><div class="highlight"><pre><span></span>> git clone --recursive git �� github.com:groonga/groonga.git </pre></div> </div> </div> @@ -138,7 +138,7 @@ code from the repository:</p> </ul> </div></blockquote> <p>Here are recommended <code class="docutils literal"><span class="pre">cmake</span></code> options for developers:</p> -<div class="highlight-none"><div class="highlight"><pre>> cmake . -G "Visual Studio 12 2013 Win64" -DCMAKE_INSTALL_PREFIX=C:\Groonga -DGRN_WITH_MRUBY=on +<div class="highlight-none"><div class="highlight"><pre><span></span>> cmake . -G "Visual Studio 12 2013 Win64" -DCMAKE_INSTALL_PREFIX=C:\Groonga -DGRN_WITH_MRUBY=on </pre></div> </div> <p>Here are descriptions of these options:</p> @@ -157,7 +157,7 @@ but developers should enable the feature.</div></blockquote> <p>Now, you can build Groonga.</p> <p>You can use Visual Studio or <code class="docutils literal"><span class="pre">cmake</span> <span class="pre">--build</span></code>.</p> <p>Here is a command line to build Groonga by <code class="docutils literal"><span class="pre">cmake</span> <span class="pre">--build</span></code>:</p> -<div class="highlight-none"><div class="highlight"><pre>> cmake --build . --config Debug +<div class="highlight-none"><div class="highlight"><pre><span></span>> cmake --build . --config Debug </pre></div> </div> </div> Modified: docs/contribution/development/cooperation.html (+3 -3) =================================================================== --- docs/contribution/development/cooperation.html 2016-03-05 15:09:34 +0900 (81158af) +++ docs/contribution/development/cooperation.html 2016-03-17 12:56:59 +0900 (d2b9a36) @@ -108,7 +108,7 @@ <div class="section" id="id4"> <h4>12.3.4.1.1.2. 対応<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h4> <p>過去のツイートをおさらいし、こうすれば良いという提案をできるのが望ましいです。:</p> -<div class="highlight-none"><div class="highlight"><pre>良い例: ○○だと原因は□□ですね。××すると大丈夫です。 +<div class="highlight-none"><div class="highlight"><pre><span></span>良い例: ○○だと原因は□□ですね。××すると大丈夫です。 </pre></div> </div> </div> @@ -124,7 +124,7 @@ <div class="section" id="id7"> <h4>12.3.4.1.2.2. 対応<a class="headerlink" href="#id7" title="Permalink to this headline">¶</a></h4> <p>最初に声をかけるときに解決策を1つか2つ提案できると望ましいです。ユーザーにあまり負担を感じさせないようにすると良いです。:</p> -<div class="highlight-none"><div class="highlight"><pre>良い例: ○○の場合は□□の可能性があるので、××を試してもらえますか？ +<div class="highlight-none"><div class="highlight"><pre><span></span>良い例: ○○の場合は□□の可能性があるので、××を試してもらえますか？ </pre></div> </div> </div> @@ -135,7 +135,7 @@ <h4>12.3.4.1.3.1. 理由<a class="headerlink" href="#id8" title="Permalink to this headline">¶</a></h4> <p>twitterは気軽につぶやけることが重要なので、気軽にできないことを相手に要求すると萎縮されてしまう可能性があります。</p> <p>いきなりredmineでバグ報告をお願いすると、しりごみしてしまうかもしれません。:</p> -<div class="highlight-none"><div class="highlight"><pre>駄目な例: 再現手順をMLかredmineに報告してもらえますか? +<div class="highlight-none"><div class="highlight"><pre><span></span>駄目な例: 再現手順をMLかredmineに報告してもらえますか? </pre></div> </div> <p>Groonga関連で気軽につぶやけないとなると開発者は困っている人を見つけられないし、利用者は困ったままとなるので、双方にとって嬉しくない状態になってしまいます。</p> Modified: docs/contribution/development/query.html (+8 -8) =================================================================== --- docs/contribution/development/query.html 2016-03-05 15:09:34 +0900 (253a867) +++ docs/contribution/development/query.html 2016-03-17 12:56:59 +0900 (4b1a8d9) @@ -108,13 +108,13 @@ <h2>12.3.5.2. grn_exprで表現できるクエリ<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h2> <p>grn_exprは代入や関数呼び出しのような様々な操作を表現できますが、この中で検索クエリを表現するgrn_exprのことを特に条件式とよびます。条件式を構成する個々の要素を関係式と呼びます。条件式は一個以上の関係式か、あるいは条件式を論理演算子で結合したものです。</p> <p>論理演算子は、以下の3種類があります。</p> -<div class="highlight-none"><div class="highlight"><pre>&& (論理積) +<div class="highlight-none"><div class="highlight"><pre><span></span>&& (論理積) || (論理和) ! (否定) </pre></div> </div> <p>関係式は、下記の11種類が用意されています。また、ユーザが定義した関数を新たな関係式として使うこともできます。</p> -<div class="highlight-none"><div class="highlight"><pre>equal(==) +<div class="highlight-none"><div class="highlight"><pre><span></span>equal(==) not_equal(!=) less(<) greater(>) @@ -131,7 +131,7 @@ suffix() <div class="section" id="grn-table-select"> <h2>12.3.5.3. grn_table_select()<a class="headerlink" href="#grn-table-select" title="Permalink to this headline">¶</a></h2> <p>grn_table_select()関数は、grn_exprで表現された検索クエリを実行するときに使います。引数として、検索対象となるテーブル、クエリを表すgrn_expr、検索結果を格納するテーブル、それに検索にマッチしたレコードを検索結果にどのように反映するかを指定する演算子を渡します。演算子と指定できるのは下記の4種類です。</p> -<div class="highlight-none"><div class="highlight"><pre>GRN_OP_OR +<div class="highlight-none"><div class="highlight"><pre><span></span>GRN_OP_OR GRN_OP_AND GRN_OP_BUT GRN_OP_ADJUST @@ -170,7 +170,7 @@ GRN_OP_ADJUST <div class="section" id="contain-v1-v2-mode-arg-callback"> <h3>12.3.5.4.7. contain(v1, v2, mode, arg, callback)<a class="headerlink" href="#contain-v1-v2-mode-arg-callback" title="Permalink to this headline">¶</a></h3> <p>v1の値がv2の値を含んでいることを表します。また、v1の値が要素に分解されるとき、それぞれの要素に対して二つ目の要素が一致するためのmodeとして下記のいずれかを指定することができます。</p> -<div class="highlight-none"><div class="highlight"><pre>EXACT: v2の値もv1の値と同様に要素に分解したとき、それぞれの要素が完全に一致する(デフォルト) +<div class="highlight-none"><div class="highlight"><pre><span></span>EXACT: v2の値もv1の値と同様に要素に分解したとき、それぞれの要素が完全に一致する(デフォルト) UNSPLIT: v2の値は要素に分解しない PREFIX: v1の値の要素がv2の値に前方一致する SUFFIX: v1の値の要素がv2の値に後方一致する @@ -201,7 +201,7 @@ PARTIAL: v1の値の要素がv2の値に中間一致する <p>grn_exprを使って様々な検索クエリを表現することができます。</p> <div class="section" id="id6"> <h2>12.3.6.1. 検索例1<a class="headerlink" href="#id6" title="Permalink to this headline">¶</a></h2> -<div class="highlight-none"><div class="highlight"><pre>GRN_EXPR_CREATE_FOR_QUERY(ctx, table, query, var); +<div class="highlight-none"><div class="highlight"><pre><span></span>GRN_EXPR_CREATE_FOR_QUERY(ctx, table, query, var); grn_expr_append_obj(ctx, query, contain, GRN_OP_PUSH, 1); grn_expr_append_obj(ctx, query, column, GRN_OP_PUSH, 1); grn_expr_append_const(ctx, query, string, GRN_OP_PUSH, 1); @@ -213,7 +213,7 @@ result = grn_table_select(ctx, table, query, NULL, GRN_OP_OR); </div> <div class="section" id="id7"> <h2>12.3.6.2. 検索例2<a class="headerlink" href="#id7" title="Permalink to this headline">¶</a></h2> -<div class="highlight-none"><div class="highlight"><pre>GRN_EXPR_CREATE_FOR_QUERY(ctx, table, query, var); +<div class="highlight-none"><div class="highlight"><pre><span></span>GRN_EXPR_CREATE_FOR_QUERY(ctx, table, query, var); grn_expr_append_obj(ctx, query, contain, GRN_OP_PUSH, 1); grn_expr_append_obj(ctx, query, column1, GRN_OP_PUSH, 1); grn_expr_append_const(ctx, query, string, GRN_OP_PUSH, 1); @@ -237,7 +237,7 @@ grn_obj_close(ctx, query); </div> <div class="section" id="id8"> <h2>12.3.6.3. 検索例3<a class="headerlink" href="#id8" title="Permalink to this headline">¶</a></h2> -<div class="highlight-none"><div class="highlight"><pre>GRN_EXPR_CREATE_FOR_QUERY(ctx, table, query, var); +<div class="highlight-none"><div class="highlight"><pre><span></span>GRN_EXPR_CREATE_FOR_QUERY(ctx, table, query, var); grn_expr_append_obj(ctx, query, contain, GRN_OP_PUSH, 1); grn_expr_append_obj(ctx, query, column1, GRN_OP_PUSH, 1); grn_expr_append_const(ctx, query, string, GRN_OP_PUSH, 1); @@ -263,7 +263,7 @@ if (grn_table_size(ctx, result) < t1) { </div> <div class="section" id="id9"> <h2>12.3.6.4. 検索例4<a class="headerlink" href="#id9" title="Permalink to this headline">¶</a></h2> -<div class="highlight-none"><div class="highlight"><pre>GRN_EXPR_CREATE_FOR_QUERY(ctx, table, query, var); +<div class="highlight-none"><div class="highlight"><pre><span></span>GRN_EXPR_CREATE_FOR_QUERY(ctx, table, query, var); grn_expr_append_obj(ctx, query, contain, GRN_OP_PUSH, 1); grn_expr_append_const(ctx, query, string, GRN_OP_PUSH, 1); grn_expr_append_obj(ctx, query, column, GRN_OP_PUSH, 1); Modified: docs/contribution/development/release.html (+50 -50) =================================================================== --- docs/contribution/development/release.html 2016-03-05 15:09:34 +0900 (a5cec2a) +++ docs/contribution/development/release.html 2016-03-17 12:56:59 +0900 (2a2602f) @@ -107,12 +107,12 @@ <p>以下にGroongaのリリース作業を行うために事前にインストール しておくべきパッケージを示します。</p> <p>なお、ビルド環境としては Debian GNU/Linux (sid)を前提として説明しているため、その他の環境では適宜読み替えて下さい。:</p> -<div class="highlight-none"><div class="highlight"><pre>% sudo apt-get install -V debootstrap createrepo rpm mercurial python-docutils python-jinja2 ruby-full mingw-w64 g++-mingw-w64 mecab libmecab-dev nsis gnupg2 dh-autoreconf python-sphinx bison +<div class="highlight-none"><div class="highlight"><pre><span></span>% sudo apt-get install -V debootstrap createrepo rpm mercurial python-docutils python-jinja2 ruby-full mingw-w64 g++-mingw-w64 mecab libmecab-dev nsis gnupg2 dh-autoreconf python-sphinx bison </pre></div> </div> <p>Debian系（.deb）やRed Hat系（.rpm）パッケージのビルドには <a class="reference external" href="https://www.vagrantup.com/">Vagrant</a> を使用します。apt-getでインストールできるのは古いバージョンなので、Webサイトから最新版をダウンロードしてインストールすることをおすすめします。</p> <p>Vagrantで使用する仮想化ソフトウェア（VirtualBox、VMwareなど）がない場合、合わせてインストールしてください。なお、VirtualBoxはsources.listにcontribセクションを追加すればapt-getでインストールできます。:</p> -<div class="highlight-none"><div class="highlight"><pre>% cat /etc/apt/sources.list +<div class="highlight-none"><div class="highlight"><pre><span></span>% cat /etc/apt/sources.list deb http://ftp.jp.debian.org/debian/ sid main contrib deb-src http://ftp.jp.debian.org/debian/ sid main contrib % sudo apt-get update @@ -120,7 +120,7 @@ deb-src http://ftp.jp.debian.org/debian/ sid main contrib </pre></div> </div> <p>また、rubyのrakeパッケージを以下のコマンドによりインストールします。:</p> -<div class="highlight-none"><div class="highlight"><pre>% sudo gem install rake +<div class="highlight-none"><div class="highlight"><pre><span></span>% sudo gem install rake </pre></div> </div> </div> @@ -130,14 +130,14 @@ deb-src http://ftp.jp.debian.org/debian/ sid main contrib その際、パッケージ署名用の鍵が必要です。</p> <p>Groongaプロジェクトでは署名用の鍵をリリース担当者の公開鍵で暗号化してリポジトリのpackages/ディレクトリ以下へと登録しています。</p> <p>リリース担当者はリポジトリに登録された秘密鍵を復号した後に鍵のインポートを以下のコマンドにて行います。:</p> -<div class="highlight-none"><div class="highlight"><pre>% cd packages +<div class="highlight-none"><div class="highlight"><pre><span></span>% cd packages % gpg --decrypt release-key-secret.asc.gpg.(担当者) > (復号した鍵 ファイル) % gpg --import (復号した鍵ファイル) </pre></div> </div> <p>鍵のインポートが正常終了すると gpg --list-keys でGroongaの署名用の鍵を確認することができます。:</p> -<div class="highlight-none"><div class="highlight"><pre>pub 1024R/F10399C0 2012-04-24 +<div class="highlight-none"><div class="highlight"><pre><span></span>pub 1024R/F10399C0 2012-04-24 uid groonga Key (groonga Official Signing Key) <packages �� groonga.org> sub 1024R/BC009774 2012-04-24 @@ -145,7 +145,7 @@ sub 1024R/BC009774 2012-04-24 </div> <p>鍵をインポートしただけでは使用することができないため、インポートした鍵に対してtrust,signを行う必要があります。</p> <p>以下のコマンドを実行して署名を行います。(途中の選択肢は省略):</p> -<div class="highlight-none"><div class="highlight"><pre>% gpg --edit-key packages �� groonga.org +<div class="highlight-none"><div class="highlight"><pre><span></span>% gpg --edit-key packages �� groonga.org gpg> trust gpg> sign gpg> save @@ -160,7 +160,7 @@ gpg> quit <p>リリース時と開発時でディレクトリを分けずに作業することもできますが、誤ったコンパイルフラグでリリースしてしまう危険があります。</p> <p>そのため、以降の説明では$GROONGA_DIR以下のディレクトリにリリース用の作業ディレクトリ(groonga.clean)としてソースコードをcloneしたものとして説明します。</p> <p>リリース用のクリーンな状態でソースコードを取得するために$GROONGA_DIRにて以下のコマンドを実行します。:</p> -<div class="highlight-none"><div class="highlight"><pre>% git clone --recursive git �� github.com:groonga/groonga.git groonga.clean +<div class="highlight-none"><div class="highlight"><pre><span></span>% git clone --recursive git �� github.com:groonga/groonga.git groonga.clean </pre></div> </div> <p>この作業はリリース作業ごとに行います。</p> @@ -170,7 +170,7 @@ gpg> quit <p>前回リリース時からの変更点を$GROONGA_CLONE_DIR/doc/source/news.txtにまとめます。 ここでまとめた内容についてはリリースアナウンスにも使用します。</p> <p>前回リリースからの変更履歴を参照するには以下のコマンドを実行します。:</p> -<div class="highlight-none"><div class="highlight"><pre>% git log -p --reverse $(git tag | tail -1).. +<div class="highlight-none"><div class="highlight"><pre><span></span>% git log -p --reverse $(git tag | tail -1).. </pre></div> </div> <p>ログを^commitで検索しながら、以下の基準を目安として変更点を追記していきます。</p> @@ -189,7 +189,7 @@ gpg> quit <p>GroongaのウェブサイトのソースはGroonga同様にgithubにリポジトリを置いています。</p> <p>リリース作業では後述するコマンド(make update-latest-release)にてトップページのバージョンを置き換えることができるようになっています。</p> <p>Groongaのウェブサイトのソースコードを$GROONGA_ORG_PATHとして取得するためには、$GROONGA_DIRにて以下のコマンドを実行します。:</p> -<div class="highlight-none"><div class="highlight"><pre>% git clone git �� github.com:groonga/groonga.org.git +<div class="highlight-none"><div class="highlight"><pre><span></span>% git clone git �� github.com:groonga/groonga.org.git </pre></div> </div> <p>これで、$GROONGA_ORG_PATHにgroonga.orgのソースを取得できます。</p> @@ -198,7 +198,7 @@ gpg> quit <h2>12.3.7.7. cutterのソースコード取得<a class="headerlink" href="#cutter" title="Permalink to this headline">¶</a></h2> <p>Groongaのリリース作業では、cutterに含まれるスクリプトを使用しています。</p> <p>そこであらかじめ用意しておいた$HOME/work/cutterディレクトリにてcutterのソースコードを以下のコマンドにて取得します。:</p> -<div class="highlight-none"><div class="highlight"><pre>% git clone git �� github.com:clear-code/cutter.git +<div class="highlight-none"><div class="highlight"><pre><span></span>% git clone git �� github.com:clear-code/cutter.git </pre></div> </div> <p>これで、$CUTTER_SOURCE_PATHディレクトリにcutterのソースを取得できます。</p> @@ -207,7 +207,7 @@ gpg> quit <h2>12.3.7.8. configureスクリプトの生成<a class="headerlink" href="#configure" title="Permalink to this headline">¶</a></h2> <p>Groongaのソースコードをcloneした時点ではconfigureスクリプトが含まれておらず、そのままmakeコマンドにてビルドすることができません。</p> <p>$GROONGA_CLONE_DIRにてautogen.shを以下のように実行します。:</p> -<div class="highlight-none"><div class="highlight"><pre>% sh autogen.sh +<div class="highlight-none"><div class="highlight"><pre><span></span>% sh autogen.sh </pre></div> </div> <p>このコマンドの実行により、configureスクリプトが生成されます。</p> @@ -216,7 +216,7 @@ gpg> quit <h2>12.3.7.9. configureスクリプトの実行<a class="headerlink" href="#id7" title="Permalink to this headline">¶</a></h2> <p>Makefileを生成するためにconfigureスクリプトを実行します。</p> <p>リリース用にビルドするためには以下のオプションを指定してconfigureを実行します。:</p> -<div class="highlight-none"><div class="highlight"><pre>% ./configure \ +<div class="highlight-none"><div class="highlight"><pre><span></span>% ./configure \ --prefix=/tmp/local \ --with-launchpad-uploader-pgp-key=(Launchpadに登録したkeyID) \ --with-groonga-org-path=$HOME/work/groonga/groonga.org \ @@ -229,7 +229,7 @@ gpg> quit <p>configureオプションである--with-groonga-org-pathにはGroongaのウェブサイトのリポジトリをcloneした場所を指定します。</p> <p>configureオプションである--with-cutter-source-pathにはcutterのソースをcloneした場所を指定します。</p> <p>以下のようにGroongaのソースコードをcloneした先からの相対パスを指定することもできます。:</p> -<div class="highlight-none"><div class="highlight"><pre>% ./configure \ +<div class="highlight-none"><div class="highlight"><pre><span></span>% ./configure \ --prefix=/tmp/local \ --with-launchpad-uploader-pgp-key=(Launchpadに登録したkeyID) \ --with-groonga-org-path=../groonga.org \ @@ -241,7 +241,7 @@ gpg> quit </div> <p>あらかじめpackagesユーザでpackages.groonga.orgにsshログインできることを確認しておいてください。</p> <p>ログイン可能であるかの確認は以下のようにコマンドを実行して行います。:</p> -<div class="highlight-none"><div class="highlight"><pre>% ssh packages �� packages.groonga.org +<div class="highlight-none"><div class="highlight"><pre><span></span>% ssh packages �� packages.groonga.org </pre></div> </div> </div> @@ -249,7 +249,7 @@ gpg> quit <h2>12.3.7.10. make update-latest-releaseの実行<a class="headerlink" href="#make-update-latest-release" title="Permalink to this headline">¶</a></h2> <p>make update-latest-releaseコマンドでは、OLD_RELEASE_DATEに前回のリリースの日付を、NEW_RELEASE_DATEに次回リリースの日付を指定します。</p> <p>2.0.2のリリースを行った際は以下のコマンドを実行しました。::</p> -<div class="highlight-none"><div class="highlight"><pre>% make update-latest-release OLD_RELEASE=2.0.1 OLD_RELEASE_DATE=2012-03-29 NEW_RELEASE_DATE=2012-04-29 +<div class="highlight-none"><div class="highlight"><pre><span></span>% make update-latest-release OLD_RELEASE=2.0.1 OLD_RELEASE_DATE=2012-03-29 NEW_RELEASE_DATE=2012-04-29 </pre></div> </div> <p>これにより、clone済みのGroongaのWebサイトのトップページのソース(index.html,ja/index.html)やRPMパッケージのspecファイルのバージョン表記などが更新されます。</p> @@ -257,7 +257,7 @@ gpg> quit <div class="section" id="make-update-files"> <h2>12.3.7.11. make update-filesの実行<a class="headerlink" href="#make-update-files" title="Permalink to this headline">¶</a></h2> <p>ロケールメッセージの更新や変更されたファイルのリスト等を更新するために以下のコマンドを実行します。:</p> -<div class="highlight-none"><div class="highlight"><pre>% make update-files +<div class="highlight-none"><div class="highlight"><pre><span></span>% make update-files </pre></div> </div> <p>make update-filesを実行すると新規に追加されたファイルなどが各種.amファイルへとリストアップされます。</p> @@ -266,7 +266,7 @@ gpg> quit <div class="section" id="make-update-po"> <h2>12.3.7.12. make update-poの実行<a class="headerlink" href="#make-update-po" title="Permalink to this headline">¶</a></h2> <p>ドキュメントの最新版と各国語版の内容を同期するために、poファイルの更新を以下のコマンドにて実行します。:</p> -<div class="highlight-none"><div class="highlight"><pre>% make update-po +<div class="highlight-none"><div class="highlight"><pre><span></span>% make update-po </pre></div> </div> <p>make update-poを実行すると、doc/locale/ja/LC_MESSAGES以下の各種.poファイルが更新されます。</p> @@ -275,7 +275,7 @@ gpg> quit <h2>12.3.7.13. poファイルの翻訳<a class="headerlink" href="#po" title="Permalink to this headline">¶</a></h2> <p>make update-poコマンドの実行により更新した各種.poファイルを翻訳します。</p> <p>翻訳結果をHTMLで確認するために、以下のコマンドを実行します。:</p> -<div class="highlight-none"><div class="highlight"><pre>% make -C doc/locale/ja html +<div class="highlight-none"><div class="highlight"><pre><span></span>% make -C doc/locale/ja html % make -C doc/locale/en html </pre></div> </div> @@ -284,7 +284,7 @@ gpg> quit <div class="section" id="id8"> <h2>12.3.7.14. リリースタグの設定<a class="headerlink" href="#id8" title="Permalink to this headline">¶</a></h2> <p>リリース用のタグを打つには以下のコマンドを実行します。:</p> -<div class="highlight-none"><div class="highlight"><pre>% make tag +<div class="highlight-none"><div class="highlight"><pre><span></span>% make tag </pre></div> </div> <div class="admonition note"> @@ -295,7 +295,7 @@ gpg> quit <div class="section" id="id9"> <h2>12.3.7.15. リリース用アーカイブファイルの作成<a class="headerlink" href="#id9" title="Permalink to this headline">¶</a></h2> <p>リリース用のソースアーカイブファイルを作成するために以下のコマンドを$GROONGA_CLONE_DIRにて実行します。:</p> -<div class="highlight-none"><div class="highlight"><pre>% make dist +<div class="highlight-none"><div class="highlight"><pre><span></span>% make dist </pre></div> </div> <p>これにより$GROONGA_CLONE_DIR/groonga-(バージョン).tar.gzが作成されます。</p> @@ -319,25 +319,25 @@ make distで生成したtar.gzのversionおよびversion.shがタグと一致す <div class="section" id="id11"> <h3>12.3.7.16.1. ビルド用パッケージのダウンロード<a class="headerlink" href="#id11" title="Permalink to this headline">¶</a></h3> <p>debパッケージのビルドに必要なパッケージをダウンロードするには以下のコマンドを実行します。:</p> -<div class="highlight-none"><div class="highlight"><pre>% cd packages/apt +<div class="highlight-none"><div class="highlight"><pre><span></span>% cd packages/apt % make download </pre></div> </div> <p>これにより、lucid以降の関連する.debパッケージやソースアーカイブなどがカレントディレクトリ以下へとダウンロードされます。</p> <p>rpmパッケージのビルドに必要なパッケージをダウンロードするには以下のコマンドを実行します。:</p> -<div class="highlight-none"><div class="highlight"><pre>% cd packages/yum +<div class="highlight-none"><div class="highlight"><pre><span></span>% cd packages/yum % make download </pre></div> </div> <p>これにより、GroongaやMySQLのRPM/SRPMパッケージなどがカレントディレクトリ以下へとダウンロードされます。</p> <p>Windowsパッケージのビルドに必要なパッケージをダウンロードするには以下のコマンドを実行します。:</p> -<div class="highlight-none"><div class="highlight"><pre>% cd packages/windows +<div class="highlight-none"><div class="highlight"><pre><span></span>% cd packages/windows % make download </pre></div> </div> <p>これにより、Groongaのインストーラやzipアーカイブがカレントディレクトリ以下へとダウンロードされます。</p> <p>sourceパッケージに必要なものをダウンロードするには以下のコマンドを実行します。:</p> -<div class="highlight-none"><div class="highlight"><pre>% cd packages/source +<div class="highlight-none"><div class="highlight"><pre><span></span>% cd packages/source % make download </pre></div> </div> @@ -348,7 +348,7 @@ packages/source/filesディレクトリ以下へとダウンロードされま <div class="section" id="debian"> <h2>12.3.7.17. Debian系パッケージのビルド<a class="headerlink" href="#debian" title="Permalink to this headline">¶</a></h2> <p>Groongaのpackages/aptサブディレクトリに移動して、以下のコマンドを実行します。:</p> -<div class="highlight-none"><div class="highlight"><pre>% cd packages/apt +<div class="highlight-none"><div class="highlight"><pre><span></span>% cd packages/apt % make build PALALLEL=yes </pre></div> </div> @@ -365,22 +365,22 @@ packages/source/filesディレクトリ以下へとダウンロードされま <p>make build ではまとめてビルドできないこともあります。 その場合にはディストリビューションごとやアーキテクチャごとなど、個別にビルドすることで問題が発生している箇所を切り分ける必要があります。</p> <p>生成したパッケージへの署名を行うには以下のコマンドを実行します。:</p> -<div class="highlight-none"><div class="highlight"><pre>% make sign-packages +<div class="highlight-none"><div class="highlight"><pre><span></span>% make sign-packages </pre></div> </div> <p>リリース対象のファイルをリポジトリに反映するには以下のコマンドを実行します。:</p> -<div class="highlight-none"><div class="highlight"><pre>% make update-repository +<div class="highlight-none"><div class="highlight"><pre><span></span>% make update-repository </pre></div> </div> <p>リポジトリにGnuPGで署名を行うために以下のコマンドを実行します。:</p> -<div class="highlight-none"><div class="highlight"><pre>% make sign-repository +<div class="highlight-none"><div class="highlight"><pre><span></span>% make sign-repository </pre></div> </div> </div> <div class="section" id="red-hat"> <h2>12.3.7.18. Red Hat系パッケージのビルド<a class="headerlink" href="#red-hat" title="Permalink to this headline">¶</a></h2> <p>Groongaのpackages/yumサブディレクトリに移動して、以下のコマンドを実行します。:</p> -<div class="highlight-none"><div class="highlight"><pre>% cd packages/yum +<div class="highlight-none"><div class="highlight"><pre><span></span>% cd packages/yum % make build PALALLEL=yes </pre></div> </div> @@ -401,18 +401,18 @@ packages/source/filesディレクトリ以下へとダウンロードされま <li>repositories/yum/centos/7/x86_64/Packages</li> </ul> <p>リリース対象のRPMに署名を行うには以下のコマンドを実行します。:</p> -<div class="highlight-none"><div class="highlight"><pre>% make sign-packages +<div class="highlight-none"><div class="highlight"><pre><span></span>% make sign-packages </pre></div> </div> <p>リリース対象のファイルをリポジトリに反映するには以下のコマンドを実行します。:</p> -<div class="highlight-none"><div class="highlight"><pre>% make update-repository +<div class="highlight-none"><div class="highlight"><pre><span></span>% make update-repository </pre></div> </div> </div> <div class="section" id="windows"> <h2>12.3.7.19. Windows用パッケージのビルド<a class="headerlink" href="#windows" title="Permalink to this headline">¶</a></h2> <p>packages/windowsサブディレクトリに移動して、以下のコマンドを実行します。:</p> -<div class="highlight-none"><div class="highlight"><pre>% cd packages/windows +<div class="highlight-none"><div class="highlight"><pre><span></span>% cd packages/windows % make build % make package % make installer @@ -429,7 +429,7 @@ packages/source/filesディレクトリ以下へとダウンロードされま <p>ビルドしたパッケージに対しリリース前の動作確認を行います。</p> <p>Debian系もしくはRed Hat系の場合には本番環境へとアップロードする前にローカルのaptないしyumのリポジトリを参照して正常に更新できることを確認します。</p> <p>ここでは以下のようにrubyを利用してリポジトリをwebサーバ経由で参照できるようにします。:</p> -<div class="highlight-none"><div class="highlight"><pre>% ruby -run -e httpd -- packages/yum/repositories (yumの場合) +<div class="highlight-none"><div class="highlight"><pre><span></span>% ruby -run -e httpd -- packages/yum/repositories (yumの場合) % ruby -run -e httpd -- packages/apt/repositories (aptの場合) </pre></div> </div> @@ -437,12 +437,12 @@ packages/source/filesディレクトリ以下へとダウンロードされま <h3>12.3.7.20.1. grntestの準備<a class="headerlink" href="#grntest" title="Permalink to this headline">¶</a></h3> <p>grntestを実行するためにはGroongaのテストデータとgrntestのソースが必要です。</p> <p>まずGroongaのソースを任意のディレクトリへと展開します。:</p> -<div class="highlight-none"><div class="highlight"><pre>% tar zxvf groonga-(バージョン).tar.gz +<div class="highlight-none"><div class="highlight"><pre><span></span>% tar zxvf groonga-(バージョン).tar.gz </pre></div> </div> <p>次にGroongaのtest/functionディレクトリ以下にgrntestのソースを展開します。 つまりtest/function/grntestという名前でgrntestのソースを配置します。:</p> -<div class="highlight-none"><div class="highlight"><pre>% ls test/function/grntest/ +<div class="highlight-none"><div class="highlight"><pre><span></span>% ls test/function/grntest/ README.md binlib license test </pre></div> </div> @@ -451,11 +451,11 @@ README.md binlib license test <h3>12.3.7.20.2. grntestの実行方法<a class="headerlink" href="#id13" title="Permalink to this headline">¶</a></h3> <p>grntestではGroongaコマンドを明示的にしていすることができます。 後述のパッケージごとのgrntestによる動作確認では以下のようにして実行します。:</p> -<div class="highlight-none"><div class="highlight"><pre>% GROONGA=(groongaのパス指定) test/function/run-test.sh +<div class="highlight-none"><div class="highlight"><pre><span></span>% GROONGA=(groongaのパス指定) test/function/run-test.sh </pre></div> </div> <p>最後にgrntestによる実行結果が以下のようにまとめて表示されます。:</p> -<div class="highlight-none"><div class="highlight"><pre>55 tests, 52 passes, 0 failures, 3 not checked tests. +<div class="highlight-none"><div class="highlight"><pre><span></span>55 tests, 52 passes, 0 failures, 3 not checked tests. 94.55% passed. </pre></div> </div> @@ -533,22 +533,22 @@ README.md binlib license test <h2>12.3.7.22. パッケージのアップロード<a class="headerlink" href="#id18" title="Permalink to this headline">¶</a></h2> <p>動作確認が完了し、Debian系、Red Hat系、Windows向け、ソースコードそれぞれにおいてパッケージやアーカイブのアップロードを行います。</p> <p>Debian系のパッケージのアップロードには以下のコマンドを実行します。:</p> -<div class="highlight-none"><div class="highlight"><pre>% cd packages/apt +<div class="highlight-none"><div class="highlight"><pre><span></span>% cd packages/apt % make upload </pre></div> </div> <p>Red Hat系のパッケージのアップロードには以下のコマンドを実行します。:</p> -<div class="highlight-none"><div class="highlight"><pre>% cd packages/yum +<div class="highlight-none"><div class="highlight"><pre><span></span>% cd packages/yum % make upload </pre></div> </div> <p>Windows向けのパッケージのアップロードには以下のコマンドを実行します。:</p> -<div class="highlight-none"><div class="highlight"><pre>% cd packages/windows +<div class="highlight-none"><div class="highlight"><pre><span></span>% cd packages/windows % make upload </pre></div> </div> <p>ソースアーカイブのアップロードには以下のコマンドを実行します。:</p> -<div class="highlight-none"><div class="highlight"><pre>% cd packages/source +<div class="highlight-none"><div class="highlight"><pre><span></span>% cd packages/source % make upload </pre></div> </div> @@ -557,7 +557,7 @@ README.md binlib license test <div class="section" id="ubuntu"> <h2>12.3.7.23. Ubuntu用パッケージのアップロード<a class="headerlink" href="#ubuntu" title="Permalink to this headline">¶</a></h2> <p>Ubuntu向けのパッケージのアップロードには以下のコマンドを実行します。:</p> -<div class="highlight-none"><div class="highlight"><pre>% cd packages/ubuntu +<div class="highlight-none"><div class="highlight"><pre><span></span>% cd packages/ubuntu % make upload </pre></div> </div> @@ -582,18 +582,18 @@ README.md binlib license test </ul> <p>編集した内容をpushする前に確認したい場合にはJekyllおよびRedCloth（Textileパーサー）、RDiscount（Markdownパーサー）、JavaScript interpreter（therubyracer、Node.jsなど）が必要です。 インストールするには以下のコマンドを実行します。:</p> -<div class="highlight-none"><div class="highlight"><pre>% sudo gem install jekyll RedCloth rdiscount therubyracer +<div class="highlight-none"><div class="highlight"><pre><span></span>% sudo gem install jekyll RedCloth rdiscount therubyracer </pre></div> </div> <p>jekyllのインストールを行ったら、以下のコマンドでローカルにwebサーバを起動します。:</p> -<div class="highlight-none"><div class="highlight"><pre>% jekyll serve --watch +<div class="highlight-none"><div class="highlight"><pre><span></span>% jekyll serve --watch </pre></div> </div> <p>あとはブラウザにてhttp://localhost:4000にアクセスして内容に問題がないかを確認します。</p> <div class="admonition note"> <p class="first admonition-title">Note</p> <p>記事を非公開の状態でアップロードするには.mdファイルのpublished:をfalseに設定します。:</p> -<div class="last highlight-none"><div class="highlight"><pre>--- +<div class="last highlight-none"><div class="highlight"><pre><span></span>--- layout: post.en title: Groonga 2.0.5 has been released published: false @@ -606,7 +606,7 @@ published: false <h2>12.3.7.25. ドキュメントのアップロード<a class="headerlink" href="#id19" title="Permalink to this headline">¶</a></h2> <p>doc/source以下のドキュメントを更新、翻訳まで完了している状態で、ドキュメントのアップロード作業を行います。</p> <p>そのためにはまず以下のコマンドを実行します。:</p> -<div class="highlight-none"><div class="highlight"><pre>% make update-document +<div class="highlight-none"><div class="highlight"><pre><span></span>% make update-document </pre></div> </div> <p>これによりcloneしておいたgroonga.orgのdoc/locale以下に更新したドキュメントがコピーされます。</p> @@ -654,7 +654,7 @@ published: false <div class="section" id="id25"> <h3>12.3.7.29.2. Groonga バージョン更新<a class="headerlink" href="#id25" title="Permalink to this headline">¶</a></h3> <p>$GROONGA_CLONE_DIRにて以下のコマンドを実行します。:</p> -<div class="highlight-none"><div class="highlight"><pre>% make update-version NEW_VERSION=2.0.6 +<div class="highlight-none"><div class="highlight"><pre><span></span>% make update-version NEW_VERSION=2.0.6 </pre></div> </div> <p>これにより$GROONGA_CLONE_DIR/base_versionが更新されるのでコミットしておきます。</p> @@ -675,13 +675,13 @@ published: false <h3>12.3.7.30.2. 特定の環境向けのみビルドしたい<a class="headerlink" href="#id27" title="Permalink to this headline">¶</a></h3> <p>Debian系の場合、CODES,ARCHITECTURESオプションを明示的に指定することで、特定のリリース、アーキテクチャのみビルドすることができます。</p> <p>squeezeのi386のみビルドしたい場合には以下のコマンドを実行します。:</p> -<div class="highlight-none"><div class="highlight"><pre>% make build ARCHITECTURES=i386 CODES=squeeze +<div class="highlight-none"><div class="highlight"><pre><span></span>% make build ARCHITECTURES=i386 CODES=squeeze </pre></div> </div> <p>buildコマンド以外でも build-package-deb build-repository-debなどのサブタスクでもARCHITECTURES,CODES指定は有効です。</p> <p>Red Hat系の場合、ARCHITECTURES,DISTRIBUTIONSオプションを明示的に指定することで、特定のリリース、アーキテクチャのみビルドすることができます。</p> <p>fedoraのi386のみビルドしたい場合には以下のコマンドを実行します。:</p> -<div class="highlight-none"><div class="highlight"><pre>% make build ARCHITECTURES=i386 DISTRIBUTIONS=fedora +<div class="highlight-none"><div class="highlight"><pre><span></span>% make build ARCHITECTURES=i386 DISTRIBUTIONS=fedora </pre></div> </div> <p>buildコマンド以外でも build-in-chroot build-repository-rpmなどのサブタスクでもARCHITECTURES,DISTRIBUTIONSの指定は有効です。</p> @@ -696,7 +696,7 @@ published: false <h3>12.3.7.30.4. バージョンを明示的に指定してドキュメントを生成したい<a class="headerlink" href="#id29" title="Permalink to this headline">¶</a></h3> <p>リリース後にドキュメントの一部を差し替えたい場合、特に何も指定しないと生成したHTMLに埋め込まれるバージョンが「v3.0.1-xxxxxドキュメント」となってしまうことがあります。gitでのコミット時ハッシュの一部が使われるためです。</p> <p>これを回避するには、以下のようにDOCUMENT_VERSIONやDOCUMENT_VERSION_FULLを明示的に指定します。:</p> -<div class="highlight-none"><div class="highlight"><pre>% make update-document DOCUMENT_VERSION=3.0.1 DOCUMENT_VERSION_FULL=3.0.1 +<div class="highlight-none"><div class="highlight"><pre><span></span>% make update-document DOCUMENT_VERSION=3.0.1 DOCUMENT_VERSION_FULL=3.0.1 </pre></div> </div> </div> Modified: docs/contribution/development/repository.html (+1 -1) =================================================================== --- docs/contribution/development/repository.html 2016-03-05 15:09:34 +0900 (c7be12d) +++ docs/contribution/development/repository.html 2016-03-17 12:56:59 +0900 (6d96128) @@ -88,7 +88,7 @@ <h1>12.3.1. Repository<a class="headerlink" href="#repository" title="Permalink to this headline">¶</a></h1> <p>There is <a class="reference external" href="https://github.com/groonga/groonga">the repository of Groonga on GitHub</a>. If you want to check-out Groonga, type the below command:</p> -<div class="highlight-none"><div class="highlight"><pre>% git clone --recursive https://github.com/groonga/groonga.git +<div class="highlight-none"><div class="highlight"><pre><span></span>% git clone --recursive https://github.com/groonga/groonga.git </pre></div> </div> <p>There is <a class="reference external" href="https://github.com/groonga">the list of related projects of Groonga</a> (grntest, fluent-plugin-groonga and so Modified: docs/contribution/development/test.html (+10 -10) =================================================================== --- docs/contribution/development/test.html 2016-03-05 15:09:34 +0900 (c309227) +++ docs/contribution/development/test.html 2016-03-17 12:56:59 +0900 (0d874a5) @@ -94,21 +94,21 @@ <div class="section" id="lcov"> <h3>12.3.8.1.2. lcovのインストール<a class="headerlink" href="#lcov" title="Permalink to this headline">¶</a></h3> <p>カバレッジ情報を計測するためには、lcov 1.6以上が必要です。DebianやUbuntuでは以下のようにしてインストールできます。:</p> -<div class="highlight-none"><div class="highlight"><pre>% sudo aptitude install -y lcov +<div class="highlight-none"><div class="highlight"><pre><span></span>% sudo aptitude install -y lcov </pre></div> </div> </div> <div class="section" id="clang"> <h3>12.3.8.1.3. clangのインストール<a class="headerlink" href="#clang" title="Permalink to this headline">¶</a></h3> <p>ソースコードの静的解析を行うためには、clang(scan-build)をインストールする必要があります。DebianやUbuntuでは以下のようにしてインストールできます。:</p> -<div class="highlight-none"><div class="highlight"><pre>% sudo aptitude install -y clang +<div class="highlight-none"><div class="highlight"><pre><span></span>% sudo aptitude install -y clang </pre></div> </div> </div> <div class="section" id="libmemcached"> <h3>12.3.8.1.4. libmemcachedのインストール<a class="headerlink" href="#libmemcached" title="Permalink to this headline">¶</a></h3> <p>memcachedのバイナリプロトコルのテストを動作させるためには、libmemcachedの導入が必要です。squeeze以降のDebianやKarmic以降のUubntuでは以下の用にしてインストールできます。:</p> -<div class="highlight-none"><div class="highlight"><pre>% sudo aptitude install -y libmemcached-dev +<div class="highlight-none"><div class="highlight"><pre><span></span>% sudo aptitude install -y libmemcached-dev </pre></div> </div> </div> @@ -116,14 +116,14 @@ <div class="section" id="id5"> <h2>12.3.8.2. テストの動作<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h2> <p>Groongaのトップディレクトリで、以下のコマンドを実行します。:</p> -<div class="highlight-none"><div class="highlight"><pre>make check +<div class="highlight-none"><div class="highlight"><pre><span></span>make check </pre></div> </div> </div> <div class="section" id="id6"> <h2>12.3.8.3. カバレッジ情報<a class="headerlink" href="#id6" title="Permalink to this headline">¶</a></h2> <p>Groongaのトップディレクトリで、以下のコマンドを実行します。:</p> -<div class="highlight-none"><div class="highlight"><pre>make coverage +<div class="highlight-none"><div class="highlight"><pre><span></span>make coverage </pre></div> </div> <p>すると、coverageディレクトリ以下に、カバレッジ情報が入ったhtmlが出力されます。</p> @@ -137,7 +137,7 @@ <h3>12.3.8.4.1. 特定のテスト関数のみテストする<a class="headerlink" href="#id8" title="Permalink to this headline">¶</a></h3> <p>特定のテスト関数(Cutterではテストと呼ぶ)のみをテストすることができます。</p> <p>実行例:</p> -<div class="highlight-none"><div class="highlight"><pre>% ./run-test.sh -n test_text_otoj +<div class="highlight-none"><div class="highlight"><pre><span></span>% ./run-test.sh -n test_text_otoj </pre></div> </div> </div> @@ -145,7 +145,7 @@ <h3>12.3.8.4.2. 特定のテストファイルのみテストする<a class="headerlink" href="#id9" title="Permalink to this headline">¶</a></h3> <p>特定のテストファイル(Cutterではテストケースと呼ぶ)のみテストすることができます。</p> <p>実行例:</p> -<div class="highlight-none"><div class="highlight"><pre>% ./run-test.sh -t test_string +<div class="highlight-none"><div class="highlight"><pre><span></span>% ./run-test.sh -t test_string </pre></div> </div> </div> @@ -154,7 +154,7 @@ <p>環境変数CUTTER_CHECK_LEAKをyesと設定すると、valgrindを用いて不正メモリアクセスやメモリリークを検出しつつ、テストを動作させることができます。</p> <p>run-test.shのみならず、make checkでも利用可能です。</p> <p>実行例:</p> -<div class="highlight-none"><div class="highlight"><pre>% CUTTER_CHECK_LEAK=yes make check +<div class="highlight-none"><div class="highlight"><pre><span></span>% CUTTER_CHECK_LEAK=yes make check </pre></div> </div> </div> @@ -163,7 +163,7 @@ <p>環境変数CUTTER_DEBUGをyesと設定すると、テストが実行できる環境が整ったgdbが実行されます。gdb上でrunを行うと、テストの実行が開始されます。</p> <p>run-test.shのみならず、make checkでも利用可能です。</p> <p>実行例:</p> -<div class="highlight-none"><div class="highlight"><pre>% CUTTER_DEBUG=yes make check +<div class="highlight-none"><div class="highlight"><pre><span></span>% CUTTER_DEBUG=yes make check </pre></div> </div> </div> @@ -171,7 +171,7 @@ <div class="section" id="id12"> <h2>12.3.8.5. 静的解析<a class="headerlink" href="#id12" title="Permalink to this headline">¶</a></h2> <p>scan-buildを用いて、ソースコードの静的解析を行うことができます。scan_buildというディレクトリに解析結果のhtmlが出力されます。:</p> -<div class="highlight-none"><div class="highlight"><pre>% scan-build ./configure --prefix=/usr +<div class="highlight-none"><div class="highlight"><pre><span></span>% scan-build ./configure --prefix=/usr % make clean % scan-build -o ./scan_build make -j4 </pre></div> Modified: docs/contribution/documentation/i18n.html (+10 -10) =================================================================== --- docs/contribution/documentation/i18n.html 2016-03-05 15:09:34 +0900 (ae0fe53) +++ docs/contribution/documentation/i18n.html 2016-03-17 12:56:59 +0900 (07e1b82) @@ -111,7 +111,7 @@ documentation.</p> </ol> <p>Here are command lines to do the above flow. Following sections describes details.</p> -<div class="highlight-none"><div class="highlight"><pre># Please fork https://github.com/groonga/groonga on GitHub +<div class="highlight-none"><div class="highlight"><pre><span></span># Please fork https://github.com/groonga/groonga on GitHub % git clone https://github.com/${YOUR_GITHUB_ACCOUNT}/groonga.git % ./autogen.sh % ./configure @@ -132,11 +132,11 @@ sections describes details.</p> <p>First, please fork groonga repository on GitHub. You just access <a class="reference external" href="https://github.com/groonga/groonga">https://github.com/groonga/groonga</a> and press <cite>Fork</cite> button. Now you can clone your groonga repository:</p> -<div class="highlight-none"><div class="highlight"><pre>% git clone https://github.com/${YOUR_GITHUB_ACCOUNT}/groonga.git +<div class="highlight-none"><div class="highlight"><pre><span></span>% git clone https://github.com/${YOUR_GITHUB_ACCOUNT}/groonga.git </pre></div> </div> <p>Then you need to configure your cloned repository:</p> -<div class="highlight-none"><div class="highlight"><pre>% cd groonga +<div class="highlight-none"><div class="highlight"><pre><span></span>% cd groonga % ./autogen.sh % ./configure </pre></div> @@ -150,7 +150,7 @@ files available on <a class="reference external" href="http://packages.groonga.o <p>You can update .po files by running <cite>make update</cite> on doc/locale/${LANGUAGE}/LC_MESSAGES. (Please substitute <cite>${LANGUAGE}</cite> with your language code such as 'ja'.):</p> -<div class="highlight-none"><div class="highlight"><pre>% cd doc/locale/ja/LC_MESSAGES +<div class="highlight-none"><div class="highlight"><pre><span></span>% cd doc/locale/ja/LC_MESSAGES % make update </pre></div> </div> @@ -175,13 +175,13 @@ specialized editor for .po file edit list.</p> running <cite>make html</cite> on doc/locale/${LANGUAGE}. (Please substitute <cite>${LANGUAGE}</cite> with your language code such as 'ja'.):</p> -<div class="highlight-none"><div class="highlight"><pre>% cd doc/locale/ja/ +<div class="highlight-none"><div class="highlight"><pre><span></span>% cd doc/locale/ja/ % make html </pre></div> </div> <p>You can also generate HTML files for all languages by running <cite>make html</cite> on doc/locale:</p> -<div class="highlight-none"><div class="highlight"><pre>% cd doc/locale +<div class="highlight-none"><div class="highlight"><pre><span></span>% cd doc/locale % make html </pre></div> </div> @@ -197,7 +197,7 @@ you don't care about .mo files.</p> doc/locale/${LANGUAGE}/html/. (Please substitute <cite>${LANGUAGE}</cite> with your language code such as 'ja'.) You can confirm HTML output by your favorite browser:</p> -<div class="highlight-none"><div class="highlight"><pre>% firefox doc/locale/ja/html/index.html +<div class="highlight-none"><div class="highlight"><pre><span></span>% firefox doc/locale/ja/html/index.html </pre></div> </div> </div> @@ -208,7 +208,7 @@ E-mail attachment patch or .po files themselves.</p> <div class="section" id="how-to-send-pull-request"> <h3>12.2.2.7.1. How to send pull request<a class="headerlink" href="#how-to-send-pull-request" title="Permalink to this headline">¶</a></h3> <p>Here are command lines to send pull request:</p> -<div class="highlight-none"><div class="highlight"><pre>% git add doc/locale/ja/LC_MESSAGES/*.po +<div class="highlight-none"><div class="highlight"><pre><span></span>% git add doc/locale/ja/LC_MESSAGES/*.po % git commit % git push </pre></div> @@ -224,7 +224,7 @@ button.</p> <div class="section" id="how-to-send-patch"> <h3>12.2.2.7.2. How to send patch<a class="headerlink" href="#how-to-send-patch" title="Permalink to this headline">¶</a></h3> <p>Here are command lines to create patch:</p> -<div class="highlight-none"><div class="highlight"><pre>% git add doc/locale/ja/LC_MESSAGES/*.po +<div class="highlight-none"><div class="highlight"><pre><span></span>% git add doc/locale/ja/LC_MESSAGES/*.po % git commit % git format-patch origin/master </pre></div> @@ -251,7 +251,7 @@ groonga repository.</p> <div class="section" id="how-to-add-new-language"> <h2>12.2.2.8. How to add new language<a class="headerlink" href="#how-to-add-new-language" title="Permalink to this headline">¶</a></h2> <p>Here are command lines to add new translation language:</p> -<div class="highlight-none"><div class="highlight"><pre>% cd doc/locale +<div class="highlight-none"><div class="highlight"><pre><span></span>% cd doc/locale % make add LOCALE=${LANGUAGE} # specify your language code such as 'de'. </pre></div> </div> Modified: docs/contribution/documentation/introduction.html (+6 -6) =================================================================== --- docs/contribution/documentation/introduction.html 2016-03-05 15:09:34 +0900 (ab5c58b) +++ docs/contribution/documentation/introduction.html 2016-03-17 12:56:59 +0900 (1c6f6cc) @@ -93,16 +93,16 @@ Groonga documentation.</p> <p>Groonga uses <a class="reference external" href="http://sphinx.pocoo.org/">Sphinx</a> as documentation tool.</p> <p>Here are command lines to install Sphinx.</p> <p>Debian GNU/Linux, Ubuntu:</p> -<div class="highlight-none"><div class="highlight"><pre>% sudo apt-get install -V -y python-sphinx +<div class="highlight-none"><div class="highlight"><pre><span></span>% sudo apt-get install -V -y python-sphinx </pre></div> </div> <p>CentOS, Fedora:</p> -<div class="highlight-none"><div class="highlight"><pre>% sudo yum install -y python-pip +<div class="highlight-none"><div class="highlight"><pre><span></span>% sudo yum install -y python-pip % sudo pip install sphinx </pre></div> </div> <p>OS X:</p> -<div class="highlight-none"><div class="highlight"><pre>% brew install python +<div class="highlight-none"><div class="highlight"><pre><span></span>% brew install python % brew install gettext % export PATH=`brew --prefix gettext`/bin:$PATH % pip install sphinx @@ -114,7 +114,7 @@ Groonga documentation.</p> <p>Groonga disables documentation generation by default. You need to enable it explicitly by adding <code class="docutils literal"><span class="pre">--enable-document</span></code> option to <code class="docutils literal"><span class="pre">configure</span></code>:</p> -<div class="highlight-none"><div class="highlight"><pre>% ./configure --enable-document +<div class="highlight-none"><div class="highlight"><pre><span></span>% ./configure --enable-document </pre></div> </div> <p>Now, your Groonga build is documentation ready.</p> @@ -122,7 +122,7 @@ enable it explicitly by adding <code class="docutils literal"><span class="pre"> <div class="section" id="generate-html"> <h2>12.2.1.3. Generate HTML<a class="headerlink" href="#generate-html" title="Permalink to this headline">¶</a></h2> <p>You can generate HTML by the following command:</p> -<div class="highlight-none"><div class="highlight"><pre>% make -C doc html +<div class="highlight-none"><div class="highlight"><pre><span></span>% make -C doc html </pre></div> </div> <p>You can find generated HTML documentation at <code class="docutils literal"><span class="pre">doc/locale/en/html/</span></code>.</p> @@ -137,7 +137,7 @@ documentation file.</p> <p>You need to update file list after you add a new file, change file path and delete existing file. You can update file list by the following command:</p> -<div class="highlight-none"><div class="highlight"><pre>% make -C doc update-files +<div class="highlight-none"><div class="highlight"><pre><span></span>% make -C doc update-files </pre></div> </div> <p>The command updates <code class="docutils literal"><span class="pre">doc/files.am</span></code>.</p> Modified: docs/development/travis-ci.html (+1 -1) =================================================================== --- docs/development/travis-ci.html 2016-03-05 15:09:34 +0900 (1a47669) +++ docs/development/travis-ci.html 2016-03-17 12:56:59 +0900 (e3cda69) @@ -104,7 +104,7 @@ can use <code class="docutils literal"><span class="pre">before_install</span></ by Travis CI such as Ruby. You should use <code class="docutils literal"><span class="pre">install</span></code> otherwise.</p> <p>Add the following <code class="docutils literal"><span class="pre">sudo</span></code> and <code class="docutils literal"><span class="pre">before_install</span></code> configuration to <code class="docutils literal"><span class="pre">.travis.yml</span></code>:</p> -<div class="highlight-none"><div class="highlight"><pre>sudo: required +<div class="highlight-none"><div class="highlight"><pre><span></span>sudo: required before_install: - curl --silent --location https://github.com/groonga/groonga/raw/master/data/travis/setup.sh | sh </pre></div> Modified: docs/install/centos.html (+22 -22) =================================================================== --- docs/install/centos.html 2016-03-05 15:09:34 +0900 (695239a) +++ docs/install/centos.html 2016-03-17 12:56:59 +0900 (78005a1) @@ -95,7 +95,7 @@ size data.</p> <div class="section" id="centos-5"> <h2>2.5.1. CentOS 5<a class="headerlink" href="#centos-5" title="Permalink to this headline">¶</a></h2> <p>Install:</p> -<div class="highlight-none"><div class="highlight"><pre>% sudo rpm -ivh http://packages.groonga.org/centos/groonga-release-1.1.0-1.noarch.rpm +<div class="highlight-none"><div class="highlight"><pre><span></span>% sudo rpm -ivh http://packages.groonga.org/centos/groonga-release-1.1.0-1.noarch.rpm % sudo yum makecache % sudo yum install -y groonga </pre></div> @@ -115,7 +115,7 @@ additional preconfigured packages.</p> <p>If you want to use <a class="reference external" href="http://mecab.sourceforge.net/">MeCab</a> as a tokenizer, install groonga-tokenizer-mecab package.</p> <p>Install groonga-tokenizer-mecab package:</p> -<div class="highlight-none"><div class="highlight"><pre>% sudo yum install -y groonga-tokenizer-mecab +<div class="highlight-none"><div class="highlight"><pre><span></span>% sudo yum install -y groonga-tokenizer-mecab </pre></div> </div> <p>There is a package that provides <a class="reference external" href="http://munin-monitoring.org/">Munin</a> plugins. If you want to monitor @@ -128,37 +128,37 @@ enable <a class="reference external" href="http://repoforge.org/">Repoforge (RPM or <a class="reference external" href="http://fedoraproject.org/wiki/EPEL">EPEL</a> repository to install it by <code class="docutils literal"><span class="pre">yum</span></code>.</p> <p>Enable Repoforge (RPMforge) repository on i386 environment:</p> -<div class="highlight-none"><div class="highlight"><pre>% wget http://pkgs.repoforge.org/rpmforge-release/rpmforge-release-0.5.3-1.el5.rf.i386.rpm +<div class="highlight-none"><div class="highlight"><pre><span></span>% wget http://pkgs.repoforge.org/rpmforge-release/rpmforge-release-0.5.3-1.el5.rf.i386.rpm % sudo rpm -ivh rpmforge-release-0.5.2-2.el5.rf.i386.rpm </pre></div> </div> <p>Enable Repoforge (RPMforge) repository on x86_64 environment:</p> -<div class="highlight-none"><div class="highlight"><pre>% wget http://pkgs.repoforge.org/rpmforge-release/rpmforge-release-0.5.3-1.el5.rf.x86_64.rpm +<div class="highlight-none"><div class="highlight"><pre><span></span>% wget http://pkgs.repoforge.org/rpmforge-release/rpmforge-release-0.5.3-1.el5.rf.x86_64.rpm % sudo rpm -ivh rpmforge-release-0.5.2-2.el5.rf.x86_64.rpm </pre></div> </div> <p>Enable EPEL repository on any environment:</p> -<div class="last highlight-none"><div class="highlight"><pre>% wget http://download.fedoraproject.org/pub/epel/5/i386/epel-release-5-4.noarch.rpm +<div class="last highlight-none"><div class="highlight"><pre><span></span>% wget http://download.fedoraproject.org/pub/epel/5/i386/epel-release-5-4.noarch.rpm % sudo rpm -ivh epel-release-5-4.noarch.rpm </pre></div> </div> </div> <p>Install groonga-munin-plugins package:</p> -<div class="highlight-none"><div class="highlight"><pre>% sudo yum install -y groonga-munin-plugins +<div class="highlight-none"><div class="highlight"><pre><span></span>% sudo yum install -y groonga-munin-plugins </pre></div> </div> <p>There is a package that provides MySQL compatible normalizer as a Groonga plugin. If you want to use that one, install groonga-normalizer-mysql package.</p> <p>Install groonga-normalizer-mysql package:</p> -<div class="highlight-none"><div class="highlight"><pre>% sudo yum install -y groonga-normalizer-mysql +<div class="highlight-none"><div class="highlight"><pre><span></span>% sudo yum install -y groonga-normalizer-mysql </pre></div> </div> </div> <div class="section" id="centos-6"> <h2>2.5.2. CentOS 6<a class="headerlink" href="#centos-6" title="Permalink to this headline">¶</a></h2> <p>Install:</p> -<div class="highlight-none"><div class="highlight"><pre>% sudo rpm -ivh http://packages.groonga.org/centos/groonga-release-1.1.0-1.noarch.rpm +<div class="highlight-none"><div class="highlight"><pre><span></span>% sudo rpm -ivh http://packages.groonga.org/centos/groonga-release-1.1.0-1.noarch.rpm % sudo yum makecache % sudo yum install -y groonga </pre></div> @@ -178,7 +178,7 @@ additional preconfigured packages.</p> <p>If you want to use <a class="reference external" href="http://mecab.sourceforge.net/">MeCab</a> as a tokenizer, install groonga-tokenizer-mecab package.</p> <p>Install groonga-tokenizer-mecab package:</p> -<div class="highlight-none"><div class="highlight"><pre>% sudo yum install -y groonga-tokenizer-mecab +<div class="highlight-none"><div class="highlight"><pre><span></span>% sudo yum install -y groonga-tokenizer-mecab </pre></div> </div> <p>There is a package that provides <a class="reference external" href="http://munin-monitoring.org/">Munin</a> plugins. If you want to monitor @@ -190,26 +190,26 @@ isn't included in the official CentOS repository. You need to enable <a class="reference external" href="http://fedoraproject.org/wiki/EPEL">EPEL</a> repository to install it by <code class="docutils literal"><span class="pre">yum</span></code>.</p> <p>Enable EPEL repository on any environment:</p> -<div class="last highlight-none"><div class="highlight"><pre>% sudo rpm -ivh http://download.fedoraproject.org/pub/epel/6/i386/epel-release-6-8.noarch.rpm +<div class="last highlight-none"><div class="highlight"><pre><span></span>% sudo rpm -ivh http://download.fedoraproject.org/pub/epel/6/i386/epel-release-6-8.noarch.rpm </pre></div> </div> </div> <p>Install groonga-munin-plugins package:</p> -<div class="highlight-none"><div class="highlight"><pre>% sudo yum install -y groonga-munin-plugins +<div class="highlight-none"><div class="highlight"><pre><span></span>% sudo yum install -y groonga-munin-plugins </pre></div> </div> <p>There is a package that provides MySQL compatible normalizer as a Groonga plugin. If you want to use that one, install groonga-normalizer-mysql package.</p> <p>Install groonga-normalizer-mysql package:</p> -<div class="highlight-none"><div class="highlight"><pre>% sudo yum install -y groonga-normalizer-mysql +<div class="highlight-none"><div class="highlight"><pre><span></span>% sudo yum install -y groonga-normalizer-mysql </pre></div> </div> </div> <div class="section" id="centos-7"> <h2>2.5.3. CentOS 7<a class="headerlink" href="#centos-7" title="Permalink to this headline">¶</a></h2> <p>Install:</p> -<div class="highlight-none"><div class="highlight"><pre>% sudo rpm -ivh http://packages.groonga.org/centos/groonga-release-1.1.0-1.noarch.rpm +<div class="highlight-none"><div class="highlight"><pre><span></span>% sudo rpm -ivh http://packages.groonga.org/centos/groonga-release-1.1.0-1.noarch.rpm % sudo yum makecache % sudo yum install -y groonga </pre></div> @@ -229,7 +229,7 @@ additional preconfigured packages.</p> <p>If you want to use <a class="reference external" href="http://mecab.sourceforge.net/">MeCab</a> as a tokenizer, install groonga-tokenizer-mecab package.</p> <p>Install groonga-tokenizer-mecab package:</p> -<div class="highlight-none"><div class="highlight"><pre>% sudo yum install -y groonga-tokenizer-mecab +<div class="highlight-none"><div class="highlight"><pre><span></span>% sudo yum install -y groonga-tokenizer-mecab </pre></div> </div> <p>There is a package that provides <a class="reference external" href="http://munin-monitoring.org/">Munin</a> plugins. If you want to monitor @@ -241,44 +241,44 @@ isn't included in the official CentOS repository. You need to enable <a class="reference external" href="http://fedoraproject.org/wiki/EPEL">EPEL</a> repository to install it by <code class="docutils literal"><span class="pre">yum</span></code>.</p> <p>Enable EPEL repository:</p> -<div class="last highlight-none"><div class="highlight"><pre>% sudo yum install -y epel-release +<div class="last highlight-none"><div class="highlight"><pre><span></span>% sudo yum install -y epel-release </pre></div> </div> </div> <p>Install groonga-munin-plugins package:</p> -<div class="highlight-none"><div class="highlight"><pre>% sudo yum install -y groonga-munin-plugins +<div class="highlight-none"><div class="highlight"><pre><span></span>% sudo yum install -y groonga-munin-plugins </pre></div> </div> <p>There is a package that provides MySQL compatible normalizer as a Groonga plugin. If you want to use that one, install groonga-normalizer-mysql package.</p> <p>Install groonga-normalizer-mysql package:</p> -<div class="highlight-none"><div class="highlight"><pre>% sudo yum install -y groonga-normalizer-mysql +<div class="highlight-none"><div class="highlight"><pre><span></span>% sudo yum install -y groonga-normalizer-mysql </pre></div> </div> </div> <div class="section" id="build-from-source"> <h2>2.5.4. Build from source<a class="headerlink" href="#build-from-source" title="Permalink to this headline">¶</a></h2> <p>Install required packages to build Groonga:</p> -<div class="highlight-none"><div class="highlight"><pre>% sudo yum install -y wget tar gcc-c++ make mecab-devel +<div class="highlight-none"><div class="highlight"><pre><span></span>% sudo yum install -y wget tar gcc-c++ make mecab-devel </pre></div> </div> <p>Download source:</p> -<div class="highlight-none"><div class="highlight"><pre>% wget http://packages.groonga.org/source/groonga/groonga-6.0.0.tar.gz +<div class="highlight-none"><div class="highlight"><pre><span></span>% wget http://packages.groonga.org/source/groonga/groonga-6.0.0.tar.gz % tar xvzf groonga-6.0.0.tar.gz % cd groonga-6.0.0 </pre></div> </div> <p>Configure (see <a class="reference internal" href="others.html#source-configure"><span>configure</span></a> about <code class="docutils literal"><span class="pre">configure</span></code> options):</p> -<div class="highlight-none"><div class="highlight"><pre>% ./configure +<div class="highlight-none"><div class="highlight"><pre><span></span>% ./configure </pre></div> </div> <p>Build:</p> -<div class="highlight-none"><div class="highlight"><pre>% make -j$(grep '^processor' /proc/cpuinfo | wc -l) +<div class="highlight-none"><div class="highlight"><pre><span></span>% make -j$(grep '^processor' /proc/cpuinfo | wc -l) </pre></div> </div> <p>Install:</p> -<div class="highlight-none"><div class="highlight"><pre>% sudo make install +<div class="highlight-none"><div class="highlight"><pre><span></span>% sudo make install </pre></div> </div> </div> Modified: docs/install/debian.html (+17 -17) =================================================================== --- docs/install/debian.html 2016-03-05 15:09:34 +0900 (5b939c7) +++ docs/install/debian.html 2016-03-17 12:56:59 +0900 (091d5b1) @@ -96,12 +96,12 @@ size data.</p> <h2>2.3.1. wheezy<a class="headerlink" href="#wheezy" title="Permalink to this headline">¶</a></h2> <p>Add the Groonga apt repository.</p> <p>/etc/apt/sources.list.d/groonga.list:</p> -<div class="highlight-none"><div class="highlight"><pre>deb http://packages.groonga.org/debian/ wheezy main +<div class="highlight-none"><div class="highlight"><pre><span></span>deb http://packages.groonga.org/debian/ wheezy main deb-src http://packages.groonga.org/debian/ wheezy main </pre></div> </div> <p>Install:</p> -<div class="highlight-none"><div class="highlight"><pre>% sudo apt-get update +<div class="highlight-none"><div class="highlight"><pre><span></span>% sudo apt-get update % sudo apt-get install -y --allow-unauthenticated groonga-keyring % sudo apt-get update % sudo apt-get install -y -V groonga @@ -122,26 +122,26 @@ additional preconfigured packages.</p> <p>If you want to use <a class="reference external" href="http://mecab.sourceforge.net/">MeCab</a> as a tokenizer, install groonga-tokenizer-mecab package.</p> <p>Install groonga-tokenizer-mecab package:</p> -<div class="highlight-none"><div class="highlight"><pre>% sudo apt-get install -y -V groonga-tokenizer-mecab +<div class="highlight-none"><div class="highlight"><pre><span></span>% sudo apt-get install -y -V groonga-tokenizer-mecab </pre></div> </div> <p>If you want to use <code class="docutils literal"><span class="pre">TokenFilterStem</span></code> as a token filter, install groonga-token-filter-stem package.</p> <p>Install groonga-token-filter-stem package:</p> -<div class="highlight-none"><div class="highlight"><pre>% sudo apt-get install -y -V groonga-token-filter-stem +<div class="highlight-none"><div class="highlight"><pre><span></span>% sudo apt-get install -y -V groonga-token-filter-stem </pre></div> </div> <p>There is a package that provides <a class="reference external" href="http://munin-monitoring.org/">Munin</a> plugins. If you want to monitor Groonga status by Munin, install groonga-munin-plugins package.</p> <p>Install groonga-munin-plugins package:</p> -<div class="highlight-none"><div class="highlight"><pre>% sudo apt-get install -y -V groonga-munin-plugins +<div class="highlight-none"><div class="highlight"><pre><span></span>% sudo apt-get install -y -V groonga-munin-plugins </pre></div> </div> <p>There is a package that provides MySQL compatible normalizer as a Groonga plugin. If you want to use that one, install groonga-normalizer-mysql package.</p> <p>Install groonga-normalizer-mysql package:</p> -<div class="highlight-none"><div class="highlight"><pre>% sudo apt-get install -y -V groonga-normalizer-mysql +<div class="highlight-none"><div class="highlight"><pre><span></span>% sudo apt-get install -y -V groonga-normalizer-mysql </pre></div> </div> </div> @@ -152,12 +152,12 @@ If you want to use that one, install groonga-normalizer-mysql package.</p> </div> <p>Add the Groonga apt repository.</p> <p>/etc/apt/sources.list.d/groonga.list:</p> -<div class="highlight-none"><div class="highlight"><pre>deb http://packages.groonga.org/debian/ jessie main +<div class="highlight-none"><div class="highlight"><pre><span></span>deb http://packages.groonga.org/debian/ jessie main deb-src http://packages.groonga.org/debian/ jessie main </pre></div> </div> <p>Install:</p> -<div class="highlight-none"><div class="highlight"><pre>% sudo apt-get update +<div class="highlight-none"><div class="highlight"><pre><span></span>% sudo apt-get update % sudo apt-get install -y --allow-unauthenticated groonga-keyring % sudo apt-get update % sudo apt-get install -y -V groonga @@ -178,51 +178,51 @@ additional preconfigured packages.</p> <p>If you want to use <a class="reference external" href="http://mecab.sourceforge.net/">MeCab</a> as a tokenizer, install groonga-tokenizer-mecab package.</p> <p>Install groonga-tokenizer-mecab package:</p> -<div class="highlight-none"><div class="highlight"><pre>% sudo apt-get install -y -V groonga-tokenizer-mecab +<div class="highlight-none"><div class="highlight"><pre><span></span>% sudo apt-get install -y -V groonga-tokenizer-mecab </pre></div> </div> <p>If you want to use <code class="docutils literal"><span class="pre">TokenFilterStem</span></code> as a token filter, install groonga-token-filter-stem package.</p> <p>Install groonga-token-filter-stem package:</p> -<div class="highlight-none"><div class="highlight"><pre>% sudo apt-get install -y -V groonga-token-filter-stem +<div class="highlight-none"><div class="highlight"><pre><span></span>% sudo apt-get install -y -V groonga-token-filter-stem </pre></div> </div> <p>There is a package that provides <a class="reference external" href="http://munin-monitoring.org/">Munin</a> plugins. If you want to monitor Groonga status by Munin, install groonga-munin-plugins package.</p> <p>Install groonga-munin-plugins package:</p> -<div class="highlight-none"><div class="highlight"><pre>% sudo apt-get install -y -V groonga-munin-plugins +<div class="highlight-none"><div class="highlight"><pre><span></span>% sudo apt-get install -y -V groonga-munin-plugins </pre></div> </div> <p>There is a package that provides MySQL compatible normalizer as a Groonga plugin. If you want to use that one, install groonga-normalizer-mysql package.</p> <p>Install groonga-normalizer-mysql package:</p> -<div class="highlight-none"><div class="highlight"><pre>% sudo apt-get install -y -V groonga-normalizer-mysql +<div class="highlight-none"><div class="highlight"><pre><span></span>% sudo apt-get install -y -V groonga-normalizer-mysql </pre></div> </div> </div> <div class="section" id="build-from-source"> <h2>2.3.3. Build from source<a class="headerlink" href="#build-from-source" title="Permalink to this headline">¶</a></h2> <p>Install required packages to build Groonga:</p> -<div class="highlight-none"><div class="highlight"><pre>% sudo apt-get install -y -V wget tar build-essential zlib1g-dev liblzo2-dev libmsgpack-dev libzmq-dev libevent-dev libmecab-dev +<div class="highlight-none"><div class="highlight"><pre><span></span>% sudo apt-get install -y -V wget tar build-essential zlib1g-dev liblzo2-dev libmsgpack-dev libzmq-dev libevent-dev libmecab-dev </pre></div> </div> <p>Download source:</p> -<div class="highlight-none"><div class="highlight"><pre>% wget http://packages.groonga.org/source/groonga/groonga-6.0.0.tar.gz +<div class="highlight-none"><div class="highlight"><pre><span></span>% wget http://packages.groonga.org/source/groonga/groonga-6.0.0.tar.gz % tar xvzf groonga-6.0.0.tar.gz % cd groonga-6.0.0 </pre></div> </div> <p>Configure (see <a class="reference internal" href="others.html#source-configure"><span>configure</span></a> about <code class="docutils literal"><span class="pre">configure</span></code> options):</p> -<div class="highlight-none"><div class="highlight"><pre>% ./configure +<div class="highlight-none"><div class="highlight"><pre><span></span>% ./configure </pre></div> </div> <p>Build:</p> -<div class="highlight-none"><div class="highlight"><pre>% make -j$(grep '^processor' /proc/cpuinfo | wc -l) +<div class="highlight-none"><div class="highlight"><pre><span></span>% make -j$(grep '^processor' /proc/cpuinfo | wc -l) </pre></div> </div> <p>Install:</p> -<div class="highlight-none"><div class="highlight"><pre>% sudo make install +<div class="highlight-none"><div class="highlight"><pre><span></span>% sudo make install </pre></div> </div> </div> Modified: docs/install/fedora.html (+12 -12) =================================================================== --- docs/install/fedora.html 2016-03-05 15:09:34 +0900 (ccebb2c) +++ docs/install/fedora.html 2016-03-17 12:56:59 +0900 (276dc2d) @@ -104,12 +104,12 @@ size data.</p> <div class="section" id="fedora-21"> <h2>2.6.1. Fedora 21<a class="headerlink" href="#fedora-21" title="Permalink to this headline">¶</a></h2> <p>Install:</p> -<div class="highlight-none"><div class="highlight"><pre>% sudo yum install -y groonga +<div class="highlight-none"><div class="highlight"><pre><span></span>% sudo yum install -y groonga </pre></div> </div> <p>Note that additional packages such as <code class="docutils literal"><span class="pre">mecab-dic</span></code> and <code class="docutils literal"><span class="pre">mecab-jumandic</span></code> packages require to install <code class="docutils literal"><span class="pre">groonga-release</span></code> package which provides the Groonga yum repository beforehand:</p> -<div class="highlight-none"><div class="highlight"><pre>% sudo rpm -ivh http://packages.groonga.org/fedora/groonga-release-1.1.0-1.noarch.rpm +<div class="highlight-none"><div class="highlight"><pre><span></span>% sudo rpm -ivh http://packages.groonga.org/fedora/groonga-release-1.1.0-1.noarch.rpm % sudo yum update </pre></div> </div> @@ -128,54 +128,54 @@ additional preconfigured packages.</p> <p>If you want to use <a class="reference external" href="http://mecab.sourceforge.net/">MeCab</a> as a tokenizer, install groonga-tokenizer-mecab package.</p> <p>Install groonga-tokenizer-mecab package:</p> -<div class="highlight-none"><div class="highlight"><pre>% sudo yum install -y groonga-tokenizer-mecab +<div class="highlight-none"><div class="highlight"><pre><span></span>% sudo yum install -y groonga-tokenizer-mecab </pre></div> </div> <p>Then install MeCab dictionary. (mecab-ipadic or mecab-jumandic)</p> <p>Install IPA dictionary:</p> -<div class="highlight-none"><div class="highlight"><pre>% sudo yum install -y mecab-ipadic +<div class="highlight-none"><div class="highlight"><pre><span></span>% sudo yum install -y mecab-ipadic </pre></div> </div> <p>Or install Juman dictionary:</p> -<div class="highlight-none"><div class="highlight"><pre>% sudo yum install -y mecab-jumandic +<div class="highlight-none"><div class="highlight"><pre><span></span>% sudo yum install -y mecab-jumandic </pre></div> </div> <p>There is a package that provides <a class="reference external" href="http://munin-monitoring.org/">Munin</a> plugins. If you want to monitor Groonga status by Munin, install groonga-munin-plugins package.</p> <p>Install groonga-munin-plugins package:</p> -<div class="highlight-none"><div class="highlight"><pre>% sudo yum install -y groonga-munin-plugins +<div class="highlight-none"><div class="highlight"><pre><span></span>% sudo yum install -y groonga-munin-plugins </pre></div> </div> <p>There is a package that provides MySQL compatible normalizer as a Groonga plugin. If you want to use that one, install groonga-normalizer-mysql package.</p> <p>Install groonga-normalizer-mysql package:</p> -<div class="highlight-none"><div class="highlight"><pre>% sudo yum install -y install groonga-normalizer-mysql +<div class="highlight-none"><div class="highlight"><pre><span></span>% sudo yum install -y install groonga-normalizer-mysql </pre></div> </div> </div> <div class="section" id="build-from-source"> <h2>2.6.2. Build from source<a class="headerlink" href="#build-from-source" title="Permalink to this headline">¶</a></h2> <p>Install required packages to build Groonga:</p> -<div class="highlight-none"><div class="highlight"><pre>% sudo yum install -y wget tar gcc-c++ make mecab-devel libedit-devel +<div class="highlight-none"><div class="highlight"><pre><span></span>% sudo yum install -y wget tar gcc-c++ make mecab-devel libedit-devel </pre></div> </div> <p>Download source:</p> -<div class="highlight-none"><div class="highlight"><pre>% wget http://packages.groonga.org/source/groonga/groonga-6.0.0.tar.gz +<div class="highlight-none"><div class="highlight"><pre><span></span>% wget http://packages.groonga.org/source/groonga/groonga-6.0.0.tar.gz % tar xvzf groonga-6.0.0.tar.gz % cd groonga-6.0.0 </pre></div> </div> <p>Configure (see <a class="reference internal" href="others.html#source-configure"><span>configure</span></a> about <code class="docutils literal"><span class="pre">configure</span></code> options):</p> -<div class="highlight-none"><div class="highlight"><pre>% ./configure +<div class="highlight-none"><div class="highlight"><pre><span></span>% ./configure </pre></div> </div> <p>Build:</p> -<div class="highlight-none"><div class="highlight"><pre>% make -j$(grep '^processor' /proc/cpuinfo | wc -l) +<div class="highlight-none"><div class="highlight"><pre><span></span>% make -j$(grep '^processor' /proc/cpuinfo | wc -l) </pre></div> </div> <p>Install:</p> -<div class="highlight-none"><div class="highlight"><pre>% sudo make install +<div class="highlight-none"><div class="highlight"><pre><span></span>% sudo make install </pre></div> </div> </div> Modified: docs/install/mac_os_x.html (+16 -7) =================================================================== --- docs/install/mac_os_x.html 2016-03-05 15:09:34 +0900 (3853ffe) +++ docs/install/mac_os_x.html 2016-03-17 12:56:59 +0900 (57e3499) @@ -91,19 +91,28 @@ install Groonga by <a class="reference external" href="http://www.macports.org/" <div class="section" id="macports"> <span id="id1"></span><h2>2.2.1. MacPorts<a class="headerlink" href="#macports" title="Permalink to this headline">¶</a></h2> <p>Install:</p> -<div class="highlight-none"><div class="highlight"><pre>% sudo port install groonga +<div class="highlight-none"><div class="highlight"><pre><span></span>% sudo port install groonga </pre></div> </div> </div> <div class="section" id="homebrew"> <span id="id2"></span><h2>2.2.2. Homebrew<a class="headerlink" href="#homebrew" title="Permalink to this headline">¶</a></h2> <p>Install:</p> -<div class="highlight-none"><div class="highlight"><pre>% brew install groonga +<div class="highlight-none"><div class="highlight"><pre><span></span>% brew install groonga </pre></div> </div> <p>If you want to use <a class="reference external" href="http://mecab.sourceforge.net/">MeCab</a> as a tokenizer, specify <code class="docutils literal"><span class="pre">--with-mecab</span></code> option:</p> -<div class="highlight-none"><div class="highlight"><pre>% brew install groonga --with-mecab +<div class="highlight-none"><div class="highlight"><pre><span></span>% brew install groonga --with-mecab +</pre></div> +</div> +<p>Then install and configure MeCab dictionary.</p> +<p>Install:</p> +<div class="highlight-none"><div class="highlight"><pre><span></span>% brew install mecab-ipadic +</pre></div> +</div> +<p>Configure:</p> +<div class="highlight-none"><div class="highlight"><pre><span></span>% sed -i '' -e 's,dicrc.*=.*,dicrc = /usr/local/lib/mecab/dic/ipadic,g' /usr/local/etc/mecabrc </pre></div> </div> </div> @@ -111,21 +120,21 @@ tokenizer, specify <code class="docutils literal"><span class="pre">--with-mecab <h2>2.2.3. Build from source<a class="headerlink" href="#build-from-source" title="Permalink to this headline">¶</a></h2> <p>Install <a class="reference external" href="https://developer.apple.com/xcode/">Xcode</a>.</p> <p>Download source:</p> -<div class="highlight-none"><div class="highlight"><pre>% curl -O http://packages.groonga.org/source/groonga/groonga-6.0.0.tar.gz +<div class="highlight-none"><div class="highlight"><pre><span></span>% curl -O http://packages.groonga.org/source/groonga/groonga-6.0.0.tar.gz % tar xvzf groonga-6.0.0.tar.gz % cd groonga-6.0.0 </pre></div> </div> <p>Configure (see <a class="reference internal" href="others.html#source-configure"><span>configure</span></a> about <code class="docutils literal"><span class="pre">configure</span></code> options):</p> -<div class="highlight-none"><div class="highlight"><pre>% ./configure +<div class="highlight-none"><div class="highlight"><pre><span></span>% ./configure </pre></div> </div> <p>Build:</p> -<div class="highlight-none"><div class="highlight"><pre>% make -j$(/usr/sbin/sysctl -n hw.ncpu) +<div class="highlight-none"><div class="highlight"><pre><span></span>% make -j$(/usr/sbin/sysctl -n hw.ncpu) </pre></div> </div> <p>Install:</p> -<div class="highlight-none"><div class="highlight"><pre>% sudo make install +<div class="highlight-none"><div class="highlight"><pre><span></span>% sudo make install </pre></div> </div> </div> Modified: docs/install/others.html (+15 -15) =================================================================== --- docs/install/others.html 2016-03-05 15:09:34 +0900 (8c1f36a) +++ docs/install/others.html 2016-03-17 12:56:59 +0900 (415f387) @@ -150,7 +150,7 @@ them before installing Groonga.</p> <h2>2.8.2. Build from source<a class="headerlink" href="#build-from-source" title="Permalink to this headline">¶</a></h2> <p>Groonga uses GNU build system. So the following is the simplest build steps:</p> -<div class="highlight-none"><div class="highlight"><pre>% wget http://packages.groonga.org/source/groonga/groonga-6.0.0.tar.gz +<div class="highlight-none"><div class="highlight"><pre><span></span>% wget http://packages.groonga.org/source/groonga/groonga-6.0.0.tar.gz % tar xvzf groonga-6.0.0.tar.gz % cd groonga-6.0.0 % ./configure @@ -175,7 +175,7 @@ installed under <code class="docutils literal"><span class="pre">${PATH}/</span> installed into <code class="docutils literal"><span class="pre">/usr/local/bin/groonga</span></code>.</p> <p>Here is an example that installs Groonga into <code class="docutils literal"><span class="pre">~/local</span></code> for an user use instead of system wide use:</p> -<div class="highlight-none"><div class="highlight"><pre>% ./configure --prefix=$HOME/local +<div class="highlight-none"><div class="highlight"><pre><span></span>% ./configure --prefix=$HOME/local </pre></div> </div> </div> @@ -187,7 +187,7 @@ file, PID file and database files. For example, log file is placed at <p>The default is <code class="docutils literal"><span class="pre">/usr/local/var</span></code>.</p> <p>Here is an example that system wide <code class="docutils literal"><span class="pre">/var</span></code> is used for modifiable files:</p> -<div class="highlight-none"><div class="highlight"><pre>% ./configure --localstatedir=/var +<div class="highlight-none"><div class="highlight"><pre><span></span>% ./configure --localstatedir=/var </pre></div> </div> </div> @@ -201,7 +201,7 @@ just for convenient.</p> <code class="docutils literal"><span class="pre">/usr/local/var</span></code> part is changed by <code class="docutils literal"><span class="pre">--localstatedir</span></code> option.</p> <p>Here is an example that log file is placed into shared NFS directory <code class="docutils literal"><span class="pre">/nfs/log/groonga.log</span></code>:</p> -<div class="highlight-none"><div class="highlight"><pre>% ./configure --with-log-path=/nfs/log/groonga.log +<div class="highlight-none"><div class="highlight"><pre><span></span>% ./configure --with-log-path=/nfs/log/groonga.log </pre></div> </div> </div> @@ -211,7 +211,7 @@ just for convenient.</p> <code class="docutils literal"><span class="pre">sjis</span></code>, <code class="docutils literal"><span class="pre">utf8</span></code>, <code class="docutils literal"><span class="pre">latin1</span></code>, <code class="docutils literal"><span class="pre">koi8r</span></code> and <code class="docutils literal"><span class="pre">none</span></code>.</p> <p>The default is <code class="docutils literal"><span class="pre">utf-8</span></code>.</p> <p>Here is an example that Shift_JIS is used as the default encoding:</p> -<div class="highlight-none"><div class="highlight"><pre>% ./configure --with-default-encoding=sjis +<div class="highlight-none"><div class="highlight"><pre><span></span>% ./configure --with-default-encoding=sjis </pre></div> </div> </div> @@ -222,7 +222,7 @@ just for convenient.</p> escalation threshold. -1 means that match operation never escalate.</p> <p>The default is 0.</p> <p>Here is an example that match escalation isn't used by default:</p> -<div class="highlight-none"><div class="highlight"><pre>% ./configure --with-match-escalation-threshold=-1 +<div class="highlight-none"><div class="highlight"><pre><span></span>% ./configure --with-match-escalation-threshold=-1 </pre></div> </div> </div> @@ -231,7 +231,7 @@ escalation threshold. -1 means that match operation never escalate.</p> <p>Enables column value compression by zlib.</p> <p>The default is disabled.</p> <p>Here is an example that enables column value compression by zlib:</p> -<div class="highlight-none"><div class="highlight"><pre>% ./configure --with-zlib +<div class="highlight-none"><div class="highlight"><pre><span></span>% ./configure --with-zlib </pre></div> </div> </div> @@ -240,7 +240,7 @@ escalation threshold. -1 means that match operation never escalate.</p> <p>Enables column value compression by LZ4.</p> <p>The default is disabled.</p> <p>Here is an example that enables column value compression by LZ4:</p> -<div class="highlight-none"><div class="highlight"><pre>% ./configure --with-lz4 +<div class="highlight-none"><div class="highlight"><pre><span></span>% ./configure --with-lz4 </pre></div> </div> </div> @@ -255,7 +255,7 @@ should specify <code class="docutils literal"><span class="pre">--with-message-p <p>The default is <code class="docutils literal"><span class="pre">/usr</span></code>.</p> <p>Here is an example that uses MessagePack built with <code class="docutils literal"><span class="pre">--prefix=$HOME/local</span></code> option:</p> -<div class="highlight-none"><div class="highlight"><pre>% ./configure --with-message-pack=$HOME/local +<div class="highlight-none"><div class="highlight"><pre><span></span>% ./configure --with-message-pack=$HOME/local </pre></div> </div> </div> @@ -265,7 +265,7 @@ should specify <code class="docutils literal"><span class="pre">--with-message-p <code class="docutils literal"><span class="pre">${PREFIX}/share/groonga/munin/plugins/</span></code>.</p> <p>Those plugins are not installed by default.</p> <p>Here is an example that installs Munin plugins for Groonga:</p> -<div class="highlight-none"><div class="highlight"><pre>% ./configure --with-munin-plugins +<div class="highlight-none"><div class="highlight"><pre><span></span>% ./configure --with-munin-plugins </pre></div> </div> </div> @@ -278,7 +278,7 @@ CentOS. <code class="docutils literal"><span class="pre">fedora</span></code> is <p>Those system management files are not installed by default.</p> <p>Here is an example that installs CentOS specific system management files:</p> -<div class="highlight-none"><div class="highlight"><pre>% ./configure --with-package-platform=redhat +<div class="highlight-none"><div class="highlight"><pre><span></span>% ./configure --with-package-platform=redhat </pre></div> </div> </div> @@ -290,12 +290,12 @@ files:</p> <div class="section" id="make"> <h3>2.8.2.2. <code class="docutils literal"><span class="pre">make</span></code><a class="headerlink" href="#make" title="Permalink to this headline">¶</a></h3> <p><code class="docutils literal"><span class="pre">configure</span></code> is succeeded, you can build Groonga by <code class="docutils literal"><span class="pre">make</span></code>:</p> -<div class="highlight-none"><div class="highlight"><pre>% make +<div class="highlight-none"><div class="highlight"><pre><span></span>% make </pre></div> </div> <p>If you have multi cores CPU, you can make faster by using <code class="docutils literal"><span class="pre">-j</span></code> option. If you have 4 cores CPU, it's good for using <code class="docutils literal"><span class="pre">-j4</span></code> option:</p> -<div class="highlight-none"><div class="highlight"><pre>% make -j4 +<div class="highlight-none"><div class="highlight"><pre><span></span>% make -j4 </pre></div> </div> <p>If you get some errors by <code class="docutils literal"><span class="pre">make</span></code>, please report them to us: @@ -304,13 +304,13 @@ option. If you have 4 cores CPU, it's good for using <code class="docutils liter <div class="section" id="make-install"> <h3>2.8.2.3. <code class="docutils literal"><span class="pre">make</span> <span class="pre">install</span></code><a class="headerlink" href="#make-install" title="Permalink to this headline">¶</a></h3> <p>Now, you can install built Groonga!:</p> -<div class="highlight-none"><div class="highlight"><pre>% sudo make install +<div class="highlight-none"><div class="highlight"><pre><span></span>% sudo make install </pre></div> </div> <p>If you have write permission for <code class="docutils literal"><span class="pre">${PREFIX}</span></code>, you don't need to use <code class="docutils literal"><span class="pre">sudo</span></code>. e.g. <code class="docutils literal"><span class="pre">--prefix=$HOME/local</span></code> case. In this case, use <code class="docutils literal"><span class="pre">make</span> <span class="pre">install</span></code>:</p> -<div class="highlight-none"><div class="highlight"><pre>% make install +<div class="highlight-none"><div class="highlight"><pre><span></span>% make install </pre></div> </div> </div> Modified: docs/install/solaris.html (+5 -5) =================================================================== --- docs/install/solaris.html 2016-03-05 15:09:34 +0900 (99e2726) +++ docs/install/solaris.html 2016-03-17 12:56:59 +0900 (796f894) @@ -90,11 +90,11 @@ Solaris.</p> <div class="section" id="oracle-solaris-11"> <h2>2.7.1. Oracle Solaris 11<a class="headerlink" href="#oracle-solaris-11" title="Permalink to this headline">¶</a></h2> <p>Install required packages to build Groonga:</p> -<div class="highlight-none"><div class="highlight"><pre>% sudo pkg install gnu-tar gcc-45 system/header +<div class="highlight-none"><div class="highlight"><pre><span></span>% sudo pkg install gnu-tar gcc-45 system/header </pre></div> </div> <p>Download source:</p> -<div class="highlight-none"><div class="highlight"><pre>% wget http://packages.groonga.org/source/groonga/groonga-6.0.0.tar.gz +<div class="highlight-none"><div class="highlight"><pre><span></span>% wget http://packages.groonga.org/source/groonga/groonga-6.0.0.tar.gz % gtar xvzf groonga-6.0.0.tar.gz % cd groonga-6.0.0 </pre></div> @@ -103,15 +103,15 @@ Solaris.</p> needed for building 64-bit version. To build 32-bit version, just remove those variables. (see <a class="reference internal" href="others.html#source-configure"><span>configure</span></a> about <code class="docutils literal"><span class="pre">configure</span></code> options):</p> -<div class="highlight-none"><div class="highlight"><pre>% ./configure CFLAGS="-m64" CXXFLAGS="-m64" +<div class="highlight-none"><div class="highlight"><pre><span></span>% ./configure CFLAGS="-m64" CXXFLAGS="-m64" </pre></div> </div> <p>Build:</p> -<div class="highlight-none"><div class="highlight"><pre>% make +<div class="highlight-none"><div class="highlight"><pre><span></span>% make </pre></div> </div> <p>Install:</p> -<div class="highlight-none"><div class="highlight"><pre>% sudo make install +<div class="highlight-none"><div class="highlight"><pre><span></span>% sudo make install </pre></div> </div> </div> Modified: docs/install/ubuntu.html (+12 -12) =================================================================== --- docs/install/ubuntu.html 2016-03-05 15:09:34 +0900 (e80210e) +++ docs/install/ubuntu.html 2016-03-17 12:56:59 +0900 (668b2b8) @@ -106,17 +106,17 @@ Archive) on Launchpad. You can install Groonga by APT from the PPA.</p> </ul> </div></blockquote> <p>Enable the universe repository to install Groonga:</p> -<div class="highlight-none"><div class="highlight"><pre>% sudo apt-get -y install software-properties-common +<div class="highlight-none"><div class="highlight"><pre><span></span>% sudo apt-get -y install software-properties-common % sudo add-apt-repository -y universe </pre></div> </div> <p>Add the <code class="docutils literal"><span class="pre">ppa:groonga/ppa</span></code> PPA to your system:</p> -<div class="highlight-none"><div class="highlight"><pre>% sudo add-apt-repository -y ppa:groonga/ppa +<div class="highlight-none"><div class="highlight"><pre><span></span>% sudo add-apt-repository -y ppa:groonga/ppa % sudo apt-get update </pre></div> </div> <p>Install:</p> -<div class="highlight-none"><div class="highlight"><pre>% sudo apt-get -y install groonga +<div class="highlight-none"><div class="highlight"><pre><span></span>% sudo apt-get -y install groonga </pre></div> </div> <div class="admonition note"> @@ -134,51 +134,51 @@ additional preconfigured packages.</p> <p>If you want to use <a class="reference external" href="http://mecab.sourceforge.net/">MeCab</a> as a tokenizer, install groonga-tokenizer-mecab package.</p> <p>Install groonga-tokenizer-mecab package:</p> -<div class="highlight-none"><div class="highlight"><pre>% sudo apt-get -y install groonga-tokenizer-mecab +<div class="highlight-none"><div class="highlight"><pre><span></span>% sudo apt-get -y install groonga-tokenizer-mecab </pre></div> </div> <p>If you want to use <code class="docutils literal"><span class="pre">TokenFilterStem</span></code> as a token filter, install groonga-token-filter-stem package.</p> <p>Install groonga-token-filter-stem package:</p> -<div class="highlight-none"><div class="highlight"><pre>% sudo apt-get -y install groonga-token-filter-stem +<div class="highlight-none"><div class="highlight"><pre><span></span>% sudo apt-get -y install groonga-token-filter-stem </pre></div> </div> <p>There is a package that provides <a class="reference external" href="http://munin-monitoring.org/">Munin</a> plugins. If you want to monitor Groonga status by Munin, install groonga-munin-plugins package.</p> <p>Install groonga-munin-plugins package:</p> -<div class="highlight-none"><div class="highlight"><pre>% sudo apt-get -y install groonga-munin-plugins +<div class="highlight-none"><div class="highlight"><pre><span></span>% sudo apt-get -y install groonga-munin-plugins </pre></div> </div> <p>There is a package that provides MySQL compatible normalizer as a Groonga plugin. If you want to use that one, install groonga-normalizer-mysql package.</p> <p>Install groonga-normalizer-mysql package:</p> -<div class="highlight-none"><div class="highlight"><pre>% sudo apt-get -y install groonga-normalizer-mysql +<div class="highlight-none"><div class="highlight"><pre><span></span>% sudo apt-get -y install groonga-normalizer-mysql </pre></div> </div> </div> <div class="section" id="build-from-source"> <h2>2.4.2. Build from source<a class="headerlink" href="#build-from-source" title="Permalink to this headline">¶</a></h2> <p>Install required packages to build Groonga:</p> -<div class="highlight-none"><div class="highlight"><pre>% sudo apt-get -V -y install wget tar build-essential zlib1g-dev liblzo2-dev libmsgpack-dev libzmq-dev libevent-dev libmecab-dev +<div class="highlight-none"><div class="highlight"><pre><span></span>% sudo apt-get -V -y install wget tar build-essential zlib1g-dev liblzo2-dev libmsgpack-dev libzmq-dev libevent-dev libmecab-dev </pre></div> </div> <p>Download source:</p> -<div class="highlight-none"><div class="highlight"><pre>% wget http://packages.groonga.org/source/groonga/groonga-6.0.0.tar.gz +<div class="highlight-none"><div class="highlight"><pre><span></span>% wget http://packages.groonga.org/source/groonga/groonga-6.0.0.tar.gz % tar xvzf groonga-6.0.0.tar.gz % cd groonga-6.0.0 </pre></div> </div> <p>Configure (see <a class="reference internal" href="others.html#source-configure"><span>configure</span></a> about <code class="docutils literal"><span class="pre">configure</span></code> options):</p> -<div class="highlight-none"><div class="highlight"><pre>% ./configure +<div class="highlight-none"><div class="highlight"><pre><span></span>% ./configure </pre></div> </div> <p>Build:</p> -<div class="highlight-none"><div class="highlight"><pre>% make -j$(grep '^processor' /proc/cpuinfo | wc -l) +<div class="highlight-none"><div class="highlight"><pre><span></span>% make -j$(grep '^processor' /proc/cpuinfo | wc -l) </pre></div> </div> <p>Install:</p> -<div class="highlight-none"><div class="highlight"><pre>% sudo make install +<div class="highlight-none"><div class="highlight"><pre><span></span>% sudo make install </pre></div> </div> </div> Modified: docs/install/windows.html (+4 -4) =================================================================== --- docs/install/windows.html 2016-03-05 15:09:34 +0900 (1ec8bcc) +++ docs/install/windows.html 2016-03-17 12:56:59 +0900 (8e29502) @@ -151,21 +151,21 @@ Windows. Here are required tools:</p> </div></blockquote> <p>Then extract it.</p> <p>Move to the Groonga's source folder:</p> -<div class="highlight-none"><div class="highlight"><pre>> cd c:\Users\%USERNAME%\Downloads\groonga-6.0.0 +<div class="highlight-none"><div class="highlight"><pre><span></span>> cd c:\Users\%USERNAME%\Downloads\groonga-6.0.0 </pre></div> </div> <p>Configure by <code class="docutils literal"><span class="pre">cmake</span></code>. The following commnad line is for 64-bit version. To build 32-bit version, use <code class="docutils literal"><span class="pre">-G</span> <span class="pre">"Visual</span> <span class="pre">Studio</span> <span class="pre">12</span> <span class="pre">2013"</span></code> parameter instead:</p> -<div class="highlight-none"><div class="highlight"><pre>groonga-6.0.0> cmake . -G "Visual Studio 12 2013 Win64" -DCMAKE_INSTALL_PREFIX=C:\Groonga +<div class="highlight-none"><div class="highlight"><pre><span></span>groonga-6.0.0> cmake . -G "Visual Studio 12 2013 Win64" -DCMAKE_INSTALL_PREFIX=C:\Groonga </pre></div> </div> <p>Build:</p> -<div class="highlight-none"><div class="highlight"><pre>groonga-6.0.0> cmake --build . --config Release +<div class="highlight-none"><div class="highlight"><pre><span></span>groonga-6.0.0> cmake --build . --config Release </pre></div> </div> <p>Install:</p> -<div class="highlight-none"><div class="highlight"><pre>groonga-6.0.0> cmake --build . --config Release --target Install +<div class="highlight-none"><div class="highlight"><pre><span></span>groonga-6.0.0> cmake --build . --config Release --target Install </pre></div> </div> <p>After the above steps, <a class="reference internal" href="../reference/executables/groonga.html"><em>groonga executable file</em></a> is found at Modified: docs/limitations.html (+4 -3) =================================================================== --- docs/limitations.html 2016-03-05 15:09:34 +0900 (97e1f3c) +++ docs/limitations.html 2016-03-17 12:56:59 +0900 (57d7132) @@ -88,8 +88,9 @@ <h2>9.1. Limitations of table<a class="headerlink" href="#limitations-of-table" title="Permalink to this headline">¶</a></h2> <p>A table has the following limitations.</p> <ul class="simple"> -<li>The maximum one key size: 4096Bytes</li> -<li>The maximum total size of keys: 4GBytes</li> +<li>The maximum one key size: 4KiB</li> +<li>The maximum total size of keys: 4GiB or 1TiB (by specifying +<code class="docutils literal"><span class="pre">KEY_LARGE</span></code> flag to <a class="reference internal" href="reference/commands/table_create.html#table-create-flags"><span>flags</span></a>)</li> <li>The maximum number of records: 268,435,455 (more than 268 million)</li> </ul> <p>Keep in mind that these limitations may vary depending on conditions.</p> @@ -99,7 +100,7 @@ <p>A full-text index has the following limitations.</p> <ul class="simple"> <li>The maximum number of distinct terms: 268,435,455 (more than 268 million)</li> -<li>The maximum index size: 256GBytes</li> +<li>The maximum index size: 256GiB</li> </ul> <p>Keep in mind that these limitations may vary depending on conditions.</p> </div> Modified: docs/news.html (+11 -11) =================================================================== --- docs/news.html 2016-03-05 15:09:34 +0900 (d04e5a3) +++ docs/news.html 2016-03-17 12:56:59 +0900 (cab29b6) @@ -120,7 +120,7 @@ returns information of the target object.</p> vector includes any element that satisfies <code class="docutils literal"><span class="pre">left_hand_side_element</span> <span class="pre">OP</span> <span class="pre">right_hand_side</span></code>, it returns true.</p> <p>Example:</p> -<div class="highlight-none"><div class="highlight"><pre>[1, 2, 3] < 2 # -> true because 1 is less than 2 +<div class="highlight-none"><div class="highlight"><pre><span></span>[1, 2, 3] < 2 # -> true because 1 is less than 2 [1, 2, 3] > 4 # -> false because all elements are less than 4 </pre></div> </div> @@ -151,7 +151,7 @@ provides getting string argument value feature.</p> <li><p class="first">[<a class="reference internal" href="reference/commands/object_remove.html"><em>object_remove</em></a>] Added a new command that removes an object. <code class="docutils literal"><span class="pre">object_remove</span></code> can also remove a broken object.</p> </li> -<li><p class="first">Supported mips/mpisel. [debian-bugs:770243][Reported by Nobuhiro +<li><p class="first">Supported mips/mipsel. [debian-bugs:770243][Reported by Nobuhiro Iwamatsu][Reported by Thorsten Glaser][Reported by YunQiang Su][Reported by Dejan Latinovic][Reported by Steve Langasek]</p> </li> @@ -724,7 +724,7 @@ indexes.</p> <a class="reference internal" href="reference/grn_expr/script_syntax.html#script-syntax-bitwise-not"><span>Bitwise NOT operator</span></a> against unsigned int value doesn't work for comparing to <code class="docutils literal"><span class="pre">-NUMBER_LITERAL</span></code>.</p> <p>For example, the following expression doesn't work:</p> -<div class="highlight-none"><div class="highlight"><pre>~UINT32_COLUMN == -6 +<div class="highlight-none"><div class="highlight"><pre><span></span>~UINT32_COLUMN == -6 </pre></div> </div> </li> @@ -758,7 +758,7 @@ End of Life on July 23, 2015.</p> </li> <li><p class="first">Supported offline index construction for reference vector. For example, <code class="docutils literal"><span class="pre">load</span></code> data before <code class="docutils literal"><span class="pre">column_create</span></code> an index:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Entries TABLE_NO_KEY +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Entries TABLE_NO_KEY column_create Entries numbers COLUMN_VECTOR Int32 load --table Entries @@ -777,7 +777,7 @@ select Numbers --output_columns _key </li> <li><p class="first">Supported <code class="docutils literal"><span class="pre">'vector_text_column</span> <span class="pre">@</span> <span class="pre">"element"'</span></code> without index. For example, the <code class="docutils literal"><span class="pre">select</span></code> command in the following commands:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Memos TABLE_NO_KEY +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Memos TABLE_NO_KEY column_create Memos tags COLUMN_VECTOR Text load --table Memos @@ -791,7 +791,7 @@ select Memos --filter 'tags @ "Rroonga"' </li> <li><p class="first">Supported <code class="docutils literal"><span class="pre">'fixed_size_type_vector_column</span> <span class="pre">@</span> <span class="pre">n'</span></code> without index. For example, the <code class="docutils literal"><span class="pre">select</span></code> command in the following commands:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Memos TABLE_NO_KEY +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Memos TABLE_NO_KEY column_create Memos numbers COLUMN_VECTOR Int32 load --table Memos @@ -815,7 +815,7 @@ that the proc can't be used with sequential search.</p> </li> <li><p class="first">Supported function call with complex argument. An example complex argument is <code class="docutils literal"><span class="pre">Table["key"].column</span></code>. For example:</p> -<div class="highlight-none"><div class="highlight"><pre>function(_key, Table["key"].column) +<div class="highlight-none"><div class="highlight"><pre><span></span>function(_key, Table["key"].column) </pre></div> </div> </li> @@ -938,7 +938,7 @@ owner/group. [GitHub#358] [Reported by jacob16bit]</p> <li><p class="first">[<a class="reference internal" href="reference/executables/groonga.html"><em>groonga executable file</em></a>] Fixed reported the maximum number of threads.</p> </li> <li><p class="first">[<a class="reference internal" href="reference/executables/groonga-httpd.html"><em>groonga-httpd</em></a>] Remove a needless space in log message:</p> -<div class="highlight-none"><div class="highlight"><pre>|n| grn_fin (0) -> +<div class="highlight-none"><div class="highlight"><pre><span></span>|n| grn_fin (0) -> |n| grn_fin (0) ^ </pre></div> @@ -1014,7 +1014,7 @@ this command.</p> <li><p class="first">[<a class="reference internal" href="reference/commands/logical_count.html"><em>logical_count</em></a>] Supported month and day mixed shards. In the same month, month shard must have earlier records rather than day shards in the same month. For example:</p> -<div class="highlight-none"><div class="highlight"><pre>XXX_201506 <- includes only 2015-06-01 and 2015-06-02 records +<div class="highlight-none"><div class="highlight"><pre><span></span>XXX_201506 <- includes only 2015-06-01 and 2015-06-02 records XXX_20150603 <- includes only 2015-06-03 records XXX_20150604 <- includes only 2015-06-04 records </pre></div> @@ -1250,7 +1250,7 @@ API users. This <em>isn't</em> incompatible change for query API users. It means that users who just use <a class="reference internal" href="reference/commands/select.html"><em>select</em></a> aren't affected. Use the following code that works with both older and newer Groonga:</p> -<div class="highlight-c"><div class="highlight"><pre><span class="n">grn_obj</span> <span class="o">*</span><span class="n">score</span><span class="p">;</span> +<div class="highlight-c"><div class="highlight"><pre><span></span><span class="n">grn_obj</span> <span class="o">*</span><span class="n">score</span><span class="p">;</span> <span class="kt">double</span> <span class="n">score_value</span><span class="p">;</span> <span class="k">if</span> <span class="p">(</span><span class="n">score</span><span class="o">-></span><span class="n">header</span><span class="p">.</span><span class="n">domain</span> <span class="o">==</span> <span class="n">GRN_DB_FLOAT</span><span class="p">)</span> <span class="p">{</span> @@ -1274,7 +1274,7 @@ for details.</p> incompatibilities in DB API layer. If you're using <a class="reference internal" href="reference/api/grn_search.html#c.grn_search_optarg" title="grn_search_optarg"><code class="xref c c-type docutils literal"><span class="pre">grn_search_optarg</span></code></a>, please check that your code initializes your <a class="reference internal" href="reference/api/grn_search.html#c.grn_search_optarg" title="grn_search_optarg"><code class="xref c c-type docutils literal"><span class="pre">grn_search_optarg</span></code></a> by <code class="docutils literal"><span class="pre">0</span></code> like the following:</p> -<div class="highlight-c"><div class="highlight"><pre><span class="n">grn_search_optarg</span> <span class="n">options</span><span class="p">;</span> +<div class="highlight-c"><div class="highlight"><pre><span></span><span class="n">grn_search_optarg</span> <span class="n">options</span><span class="p">;</span> <span class="n">memset</span><span class="p">(</span><span class="o">&</span><span class="n">options</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="k">sizeof</span><span class="p">(</span><span class="n">grn_search_optarg</span><span class="p">));</span> </pre></div> </div> Modified: docs/news/1.2.x.html (+1 -1) =================================================================== --- docs/news/1.2.x.html 2016-03-05 15:09:34 +0900 (b3e0a78) +++ docs/news/1.2.x.html 2016-03-17 12:56:59 +0900 (0acc7b8) @@ -129,7 +129,7 @@ may keep a garbage.</li> <p>Object, table and column renamings are supported! These features require database re-creation. You can re-create your database by the following command:</p> -<div class="highlight-none"><div class="highlight"><pre>% groonga YOUR_DB dump > db.dump +<div class="highlight-none"><div class="highlight"><pre><span></span>% groonga YOUR_DB dump > db.dump % groonga -n YOUR_NEW_DB < db.dump </pre></div> </div> Modified: docs/news/2.x.html (+2 -2) =================================================================== --- docs/news/2.x.html 2016-03-05 15:09:34 +0900 (5e8d507) +++ docs/news/2.x.html 2016-03-17 12:56:59 +0900 (0a5323d) @@ -535,12 +535,12 @@ expression. [#1372]</li> <p>The package sign key is changed since this release. Import the new package sign key before updating groogna packages.</p> <p>Debian/Ubuntu:</p> -<div class="highlight-none"><div class="highlight"><pre>% sudo apt-get update +<div class="highlight-none"><div class="highlight"><pre><span></span>% sudo apt-get update % sudo apt-get -y --allow-unauthenticated install groonga-keyring </pre></div> </div> <p>CentOS/Fedora:</p> -<div class="last highlight-none"><div class="highlight"><pre>% sudo yum makecache +<div class="last highlight-none"><div class="highlight"><pre><span></span>% sudo yum makecache % sudo yum install --nogpgcheck -y groonga-repository </pre></div> </div> Modified: docs/news/4.x.html (+1 -1) =================================================================== --- docs/news/4.x.html 2016-03-05 15:09:34 +0900 (de89a25) +++ docs/news/4.x.html 2016-03-17 12:56:59 +0900 (18068e9) @@ -134,7 +134,7 @@ dictionary. [Reported by Shuhei Tanuma]</li> <p>If you have already upgraded to 4.0.9, please upgrade to 4.1.0. And re-create your all indexes. You can re-create your indexes by removing and re-creating your indexes such as:</p> -<div class="highlight-none"><div class="highlight"><pre>column_remove TABLE INDEX_COLUMN +<div class="highlight-none"><div class="highlight"><pre><span></span>column_remove TABLE INDEX_COLUMN column_create TABLE INDEX_COLUMN COLUMN_INDEX|... </pre></div> </div> Modified: docs/reference/alias.html (+13 -13) =================================================================== --- docs/reference/alias.html 2016-03-05 15:09:34 +0900 (41195f3) +++ docs/reference/alias.html 2016-03-17 12:56:59 +0900 (64be922) @@ -27,7 +27,7 @@ <link rel="top" title="Groonga v6.0.0 documentation" href="../index.html" /> <link rel="up" title="7. Reference manual" href="../reference.html" /> <link rel="next" title="7.18. Suggest" href="suggest.html" /> - <link rel="prev" title="7.3.16. config_set" href="commands/config_set.html" /> + <link rel="prev" title="7.16. Configuration" href="configuration.html" /> <meta property="fb:page_id" content="201193596592346" /><!-- groonga --> <meta property="fb:admins" content="664204556" /><!-- kouhei.sutou --> <meta property="og:type" content="product" /> @@ -71,7 +71,7 @@ <a href="suggest.html" title="7.18. Suggest" accesskey="N">next</a> |</li> <li class="right" > - <a href="commands/config_set.html" title="7.3.16. config_set" + <a href="configuration.html" title="7.16. Configuration" accesskey="P">previous</a> |</li> <li class="nav-item nav-item-0"><a href="../index.html">Groonga v6.0.0 documentation</a> »</li> <li class="nav-item nav-item-1"><a href="../reference.html" accesskey="U">7. Reference manual</a> »</li> @@ -126,7 +126,7 @@ they are meaningless. Because the max table/column name size is 4KiB. <code class="docutils literal"><span class="pre">ShortText</span></code> can store 4KiB data.</p> <p>Here are example definitions of table and column for managing aliases:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Aliases TABLE_HASH_KEY ShortText +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Aliases TABLE_HASH_KEY ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] column_create Aliases real_name COLUMN_SCALAR ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -137,13 +137,13 @@ The alias feature uses <code class="docutils literal"><span class="pre">alias.co register the table and column by the following <a class="reference internal" href="commands/config_set.html"><em>config_set</em></a>:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>config_set alias.column Aliases.real_name +<div class="highlight-none"><div class="highlight"><pre><span></span>config_set alias.column Aliases.real_name # [[0, 1337566253.89858, 0.000355720520019531], true] </pre></div> </div> <p>Here are schema and data to show how to use alias:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Users TABLE_HASH_KEY ShortText +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Users TABLE_HASH_KEY ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] column_create Users age COLUMN_SCALAR UInt8 # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -157,7 +157,7 @@ load --table Users </div> <p>You can use <code class="docutils literal"><span class="pre">Users.age</span></code> in <a class="reference internal" href="commands/select.html"><em>select</em></a>:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Users --filter 'age < 20' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Users --filter 'age < 20' # [ # [ # 0, @@ -196,7 +196,7 @@ load --table Users <p>You can't use <code class="docutils literal"><span class="pre">Users.age</span></code> when you rename <code class="docutils literal"><span class="pre">Users.age</span></code> to <code class="docutils literal"><span class="pre">Users.years</span></code> by <a class="reference internal" href="commands/column_rename.html"><em>column_rename</em></a>:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>column_rename Users age years +<div class="highlight-none"><div class="highlight"><pre><span></span>column_rename Users age years # [[0, 1337566253.89858, 0.000355720520019531], true] select Users --filter 'age < 20' # [ @@ -220,7 +220,7 @@ select Users --filter 'age < 20' <p>But you can use <code class="docutils literal"><span class="pre">Users.age</span></code> by registering <code class="docutils literal"><span class="pre">Users.age</span></code> to <code class="docutils literal"><span class="pre">Users.years</span></code> mapping to <code class="docutils literal"><span class="pre">Aliases</span></code>.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>load --table Aliases +<div class="highlight-none"><div class="highlight"><pre><span></span>load --table Aliases [ {"_key": "Users.age", "real_name": "Users.years"} ] @@ -273,7 +273,7 @@ column, command, function and so on) by the alias feature.</p> <p>For example, alias isn't resolved in the following example because <code class="docutils literal"><span class="pre">Users.years</span></code> exists:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>column_rename Users years years_old +<div class="highlight-none"><div class="highlight"><pre><span></span>column_rename Users years years_old # [[0, 1337566253.89858, 0.000355720520019531], true] select Users --filter 'age < 20' # [ @@ -337,7 +337,7 @@ records:</p> </table> <p>Here is an example to <code class="docutils literal"><span class="pre">Users.age</span></code> is resolved recursively:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>column_rename Users years years_old +<div class="highlight-none"><div class="highlight"><pre><span></span>column_rename Users years years_old # [[0, 1337566253.89858, 0.000355720520019531], true] select Users --filter 'age < 20' # [ @@ -408,8 +408,8 @@ select Users --filter 'age < 20' </ul> <h4>Previous topic</h4> - <p class="topless"><a href="commands/config_set.html" - title="previous chapter">7.3.16. <code class="docutils literal"><span class="pre">config_set</span></code></a></p> + <p class="topless"><a href="configuration.html" + title="previous chapter">7.16. Configuration</a></p> <h4>Next topic</h4> <p class="topless"><a href="suggest.html" title="next chapter">7.18. Suggest</a></p> @@ -447,7 +447,7 @@ select Users --filter 'age < 20' <a href="suggest.html" title="7.18. Suggest" >next</a> |</li> <li class="right" > - <a href="commands/config_set.html" title="7.3.16. config_set" + <a href="configuration.html" title="7.16. Configuration" >previous</a> |</li> <li class="nav-item nav-item-0"><a href="../index.html">Groonga v6.0.0 documentation</a> »</li> <li class="nav-item nav-item-1"><a href="../reference.html" >7. Reference manual</a> »</li> Modified: docs/reference/api/grn_cache.html (+1 -1) =================================================================== --- docs/reference/api/grn_cache.html 2016-03-05 15:09:34 +0900 (fee9e40) +++ docs/reference/api/grn_cache.html 2016-03-17 12:56:59 +0900 (5181c57) @@ -111,7 +111,7 @@ case. If you open only one database or don't use <div class="section" id="example"> <h2>7.23.4.2. Example<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h2> <p>Here is an example that change the current cache object.</p> -<div class="highlight-c"><div class="highlight"><pre><span class="n">grn_cache</span> <span class="o">*</span><span class="n">cache</span><span class="p">;</span> +<div class="highlight-c"><div class="highlight"><pre><span></span><span class="n">grn_cache</span> <span class="o">*</span><span class="n">cache</span><span class="p">;</span> <span class="n">grn_cache</span> <span class="o">*</span><span class="n">cache_previous</span><span class="p">;</span> <span class="n">cache</span> <span class="o">=</span> <span class="n">grn_cache_open</span><span class="p">(</span><span class="n">ctx</span><span class="p">);</span> <span class="n">cache_previous</span> <span class="o">=</span> <span class="n">grn_cache_current_get</span><span class="p">(</span><span class="n">ctx</span><span class="p">);</span> Modified: docs/reference/api/grn_column.html (+5 -5) =================================================================== --- docs/reference/api/grn_column.html 2016-03-05 15:09:34 +0900 (6c6a4ef) +++ docs/reference/api/grn_column.html 2016-03-17 12:56:59 +0900 (8dce39d) @@ -102,7 +102,7 @@ <dd><p>It returns the name of <a class="reference internal" href="../columns/pseudo.html"><em>Pseudo column</em></a> <code class="docutils literal"><span class="pre">_id</span></code>.</p> <p>It is useful to use with <a class="reference internal" href="#c.GRN_COLUMN_NAME_ID_LEN" title="GRN_COLUMN_NAME_ID_LEN"><code class="xref c c-macro docutils literal"><span class="pre">GRN_COLUMN_NAME_ID_LEN</span></code></a> like the following:</p> -<div class="highlight-c"><div class="highlight"><pre><span class="n">grn_obj</span> <span class="o">*</span><span class="n">id_column</span><span class="p">;</span> +<div class="highlight-c"><div class="highlight"><pre><span></span><span class="n">grn_obj</span> <span class="o">*</span><span class="n">id_column</span><span class="p">;</span> <span class="n">id_column</span> <span class="o">=</span> <span class="n">grn_ctx_get</span><span class="p">(</span><span class="n">ctx</span><span class="p">,</span> <span class="n">GRN_COLUMN_NAME_ID</span><span class="p">,</span> <span class="n">GRN_COLUMN_NAME_ID_LEN</span><span class="p">);</span> </pre></div> </div> @@ -122,7 +122,7 @@ the following:</p> <dd><p>It returns the name of <a class="reference internal" href="../columns/pseudo.html"><em>Pseudo column</em></a> <code class="docutils literal"><span class="pre">_key</span></code>.</p> <p>It is useful to use with <a class="reference internal" href="#c.GRN_COLUMN_NAME_KEY_LEN" title="GRN_COLUMN_NAME_KEY_LEN"><code class="xref c c-macro docutils literal"><span class="pre">GRN_COLUMN_NAME_KEY_LEN</span></code></a> like the following:</p> -<div class="highlight-c"><div class="highlight"><pre><span class="n">grn_obj</span> <span class="o">*</span><span class="n">key_column</span><span class="p">;</span> +<div class="highlight-c"><div class="highlight"><pre><span></span><span class="n">grn_obj</span> <span class="o">*</span><span class="n">key_column</span><span class="p">;</span> <span class="n">key_column</span> <span class="o">=</span> <span class="n">grn_ctx_get</span><span class="p">(</span><span class="n">ctx</span><span class="p">,</span> <span class="n">GRN_COLUMN_NAME_KEY</span><span class="p">,</span> <span class="n">GRN_COLUMN_NAME_KEY_LEN</span><span class="p">);</span> </pre></div> </div> @@ -142,7 +142,7 @@ the following:</p> <dd><p>It returns the name of <a class="reference internal" href="../columns/pseudo.html"><em>Pseudo column</em></a> <code class="docutils literal"><span class="pre">_value</span></code>.</p> <p>It is useful to use with <a class="reference internal" href="#c.GRN_COLUMN_NAME_VALUE_LEN" title="GRN_COLUMN_NAME_VALUE_LEN"><code class="xref c c-macro docutils literal"><span class="pre">GRN_COLUMN_NAME_VALUE_LEN</span></code></a> like the following:</p> -<div class="highlight-c"><div class="highlight"><pre><span class="n">grn_obj</span> <span class="o">*</span><span class="n">value_column</span><span class="p">;</span> +<div class="highlight-c"><div class="highlight"><pre><span></span><span class="n">grn_obj</span> <span class="o">*</span><span class="n">value_column</span><span class="p">;</span> <span class="n">value_column</span> <span class="o">=</span> <span class="n">grn_ctx_get</span><span class="p">(</span><span class="n">ctx</span><span class="p">,</span> <span class="n">GRN_COLUMN_NAME_VALUE</span><span class="p">,</span> <span class="n">GRN_COLUMN_NAME_VALUE_LEN</span><span class="p">);</span> </pre></div> </div> @@ -162,7 +162,7 @@ the following:</p> <dd><p>It returns the name of <a class="reference internal" href="../columns/pseudo.html"><em>Pseudo column</em></a> <code class="docutils literal"><span class="pre">_score</span></code>.</p> <p>It is useful to use with <a class="reference internal" href="#c.GRN_COLUMN_NAME_SCORE_LEN" title="GRN_COLUMN_NAME_SCORE_LEN"><code class="xref c c-macro docutils literal"><span class="pre">GRN_COLUMN_NAME_SCORE_LEN</span></code></a> like the following:</p> -<div class="highlight-c"><div class="highlight"><pre><span class="n">grn_obj</span> <span class="o">*</span><span class="n">score_column</span><span class="p">;</span> +<div class="highlight-c"><div class="highlight"><pre><span></span><span class="n">grn_obj</span> <span class="o">*</span><span class="n">score_column</span><span class="p">;</span> <span class="n">score_column</span> <span class="o">=</span> <span class="n">grn_ctx_get</span><span class="p">(</span><span class="n">ctx</span><span class="p">,</span> <span class="n">GRN_COLUMN_NAME_SCORE</span><span class="p">,</span> <span class="n">GRN_COLUMN_NAME_SCORE_LEN</span><span class="p">);</span> </pre></div> </div> @@ -182,7 +182,7 @@ the following:</p> <dd><p>It returns the name of <a class="reference internal" href="../columns/pseudo.html"><em>Pseudo column</em></a> <code class="docutils literal"><span class="pre">_nsubrecs</span></code>.</p> <p>It is useful to use with <a class="reference internal" href="#c.GRN_COLUMN_NAME_NSUBRECS_LEN" title="GRN_COLUMN_NAME_NSUBRECS_LEN"><code class="xref c c-macro docutils literal"><span class="pre">GRN_COLUMN_NAME_NSUBRECS_LEN</span></code></a> like the following:</p> -<div class="highlight-c"><div class="highlight"><pre><span class="n">grn_obj</span> <span class="o">*</span><span class="n">nsubrecs_column</span><span class="p">;</span> +<div class="highlight-c"><div class="highlight"><pre><span></span><span class="n">grn_obj</span> <span class="o">*</span><span class="n">nsubrecs_column</span><span class="p">;</span> <span class="n">nsubrecs_column</span> <span class="o">=</span> <span class="n">grn_ctx_get</span><span class="p">(</span><span class="n">ctx</span><span class="p">,</span> <span class="n">GRN_COLUMN_NAME_NSUBRECS</span><span class="p">,</span> <span class="n">GRN_COLUMN_NAME_NSUBRECS_LEN</span><span class="p">);</span> </pre></div> </div> Modified: docs/reference/api/grn_ctx.html (+1 -1) =================================================================== --- docs/reference/api/grn_ctx.html 2016-03-05 15:09:34 +0900 (1c87243) +++ docs/reference/api/grn_ctx.html 2016-03-17 12:56:59 +0900 (4229558) @@ -317,7 +317,7 @@ grn_rc <code class="descname">grn_ctx_get_all_tables</code><span class="sig-pare <code class="docutils literal"><span class="pre">GRN_PVECTOR</span></code>. You can use <code class="docutils literal"><span class="pre">GRN_PTR_INIT()</span></code> with <code class="docutils literal"><span class="pre">GRN_OBJ_VECTOR</span></code> flags to initialize <code class="docutils literal"><span class="pre">tables_buffer</span></code>.</p> <p>Here is an example:</p> -<div class="highlight-c"><div class="highlight"><pre><span class="n">grn_rc</span> <span class="n">rc</span><span class="p">;</span> +<div class="highlight-c"><div class="highlight"><pre><span></span><span class="n">grn_rc</span> <span class="n">rc</span><span class="p">;</span> <span class="n">grn_obj</span> <span class="n">tables</span><span class="p">;</span> <span class="kt">int</span> <span class="n">i</span><span class="p">;</span> <span class="kt">int</span> <span class="n">n_tables</span><span class="p">;</span> Modified: docs/reference/api/grn_expr.html (+1 -1) =================================================================== --- docs/reference/api/grn_expr.html 2016-03-05 15:09:34 +0900 (f554602) +++ docs/reference/api/grn_expr.html 2016-03-17 12:56:59 +0900 (076ad32) @@ -166,7 +166,7 @@ unlink them. Each keyword is <code class="docutils literal"><span class="pre">GR <code class="docutils literal"><span class="pre">GRN_DB_TEXT</span></code>.</p> <p><code class="docutils literal"><span class="pre">keywords</span></code> must be <code class="docutils literal"><span class="pre">GRN_PVECTOR</span></code>.</p> <p>Here is an example code:</p> -<div class="highlight-c"><div class="highlight"><pre><span class="n">grn_obj</span> <span class="n">keywords</span><span class="p">;</span> +<div class="highlight-c"><div class="highlight"><pre><span></span><span class="n">grn_obj</span> <span class="n">keywords</span><span class="p">;</span> <span class="n">GRN_PTR_INIT</span><span class="p">(</span><span class="o">&</span><span class="n">keywords</span><span class="p">,</span> <span class="n">GRN_OBJ_VECTOR</span><span class="p">,</span> <span class="n">GRN_ID_NIL</span><span class="p">);</span> <span class="n">grn_expr_get_keywords</span><span class="p">(</span><span class="n">ctx</span><span class="p">,</span> <span class="n">expr</span><span class="p">,</span> <span class="o">&</span><span class="n">keywords</span><span class="p">);</span> <span class="p">{</span> Modified: docs/reference/api/grn_thread.html (+1 -1) =================================================================== --- docs/reference/api/grn_thread.html 2016-03-05 15:09:34 +0900 (9b29a1a) +++ docs/reference/api/grn_thread.html 2016-03-17 12:56:59 +0900 (ab42e8b) @@ -100,7 +100,7 @@ increases its thread pool size when the max number of threads is increased. <a class="reference internal" href="../executables/groonga.html"><em>groonga executable file</em></a> decreases its thread pool size and stops too many threads when the max number of threads is decreased.</p> -<div class="highlight-c"><div class="highlight"><pre><span class="k">static</span> <span class="n">grn_mutex</span> <span class="n">q_mutex</span><span class="p">;</span> +<div class="highlight-c"><div class="highlight"><pre><span></span><span class="k">static</span> <span class="n">grn_mutex</span> <span class="n">q_mutex</span><span class="p">;</span> <span class="k">static</span> <span class="n">grn_cond</span> <span class="n">q_cond</span><span class="p">;</span> <span class="k">static</span> <span class="kt">uint32_t</span> <span class="n">nfthreads</span><span class="p">;</span> <span class="k">static</span> <span class="kt">uint32_t</span> <span class="n">max_nfthreads</span><span class="p">;</span> Modified: docs/reference/api/overview.html (+1 -1) =================================================================== --- docs/reference/api/overview.html 2016-03-05 15:09:34 +0900 (af9e7e3) +++ docs/reference/api/overview.html 2016-03-17 12:56:59 +0900 (93ea8f8) @@ -99,7 +99,7 @@ after you finish to use APIs which are provided by Groonga.</p> <div class="section" id="example"> <h2>7.23.1.2. Example<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h2> <p>Here is an example that uses Groonga as a full-text search library.</p> -<div class="highlight-c"><div class="highlight"><pre><span class="n">grn_rc</span> <span class="n">rc</span><span class="p">;</span> +<div class="highlight-c"><div class="highlight"><pre><span></span><span class="n">grn_rc</span> <span class="n">rc</span><span class="p">;</span> <span class="cm">/* It initializes resources used by Groonga. */</span> <span class="n">rc</span> <span class="o">=</span> <span class="n">grn_init</span><span class="p">();</span> <span class="k">if</span> <span class="p">(</span><span class="n">rc</span> <span class="o">!=</span> <span class="n">GRN_SUCCESS</span><span class="p">)</span> <span class="p">{</span> Modified: docs/reference/columns/vector.html (+19 -19) =================================================================== --- docs/reference/columns/vector.html 2016-03-05 15:09:34 +0900 (445b5cd) +++ docs/reference/columns/vector.html 2016-03-17 12:56:59 +0900 (78e8540) @@ -127,7 +127,7 @@ a key. Tags are the most popular use case.</p> <p>Use <a class="reference internal" href="../commands/column_create.html"><em>column_create</em></a> command to create a normal vector column. The point is <code class="docutils literal"><span class="pre">COLUMN_VECTOR</span></code> flag:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Bookmarks TABLE_HASH_KEY ShortText +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Bookmarks TABLE_HASH_KEY ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] column_create Bookmarks tags COLUMN_VECTOR ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -138,7 +138,7 @@ column_create Bookmarks tags COLUMN_VECTOR ShortText <div class="section" id="how-to-load"> <h4>7.6.2.2.1.2. How to load<a class="headerlink" href="#how-to-load" title="Permalink to this headline">¶</a></h4> <p>You can load vector data by JSON array syntax:</p> -<div class="highlight-none"><div class="highlight"><pre>[ELEMENT1, ELEMENT2, ELEMENT3, ...] +<div class="highlight-none"><div class="highlight"><pre><span></span>[ELEMENT1, ELEMENT2, ELEMENT3, ...] </pre></div> </div> <p>Let's load the following data:</p> @@ -166,7 +166,7 @@ column_create Bookmarks tags COLUMN_VECTOR ShortText </table> <p>Here is a command that loads the data:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>load --table Bookmarks +<div class="highlight-none"><div class="highlight"><pre><span></span>load --table Bookmarks [ {"_key": "http://groonga.org/", "tags": ["groonga"]}, {"_key": "http://mroonga.org/", "tags": ["mroonga", "mysql", "groonga"]}, @@ -177,7 +177,7 @@ column_create Bookmarks tags COLUMN_VECTOR ShortText </div> <p>The loaded data can be outputted as JSON array syntax:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Bookmarks +<div class="highlight-none"><div class="highlight"><pre><span></span>select Bookmarks # [ # [ # 0, @@ -237,18 +237,18 @@ column_create Bookmarks tags COLUMN_VECTOR ShortText <h4>7.6.2.2.1.3. How to search<a class="headerlink" href="#how-to-search" title="Permalink to this headline">¶</a></h4> <p>You need to create an index to search normal vector column:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Tags TABLE_PAT_KEY ShortText +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Tags TABLE_PAT_KEY ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] column_create Tags bookmark_index COLUMN_INDEX Bookmarks tags # [[0, 1337566253.89858, 0.000355720520019531], true] </pre></div> </div> -<p>There are no vector column specific way. You can create an index like +<p>There is no vector column specific way. You can create an index like a scalar column.</p> <p>You can search an element in <code class="docutils literal"><span class="pre">tags</span></code> like full text search syntax.</p> <p>With <a class="reference internal" href="../commands/select.html#select-match-columns"><span>match_columns</span></a> and <a class="reference internal" href="../commands/select.html#select-query"><span>query</span></a>:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Bookmarks --match_columns tags --query mysql --output_columns _key,tags,_score +<div class="highlight-none"><div class="highlight"><pre><span></span>select Bookmarks --match_columns tags --query mysql --output_columns _key,tags,_score # [ # [ # 0, @@ -290,7 +290,7 @@ a scalar column.</p> </div> <p>You can also use weight in <a class="reference internal" href="../commands/select.html#select-match-columns"><span>match_columns</span></a>:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Bookmarks --match_columns 'tags * 3' --query mysql --output_columns _key,tags,_score +<div class="highlight-none"><div class="highlight"><pre><span></span>select Bookmarks --match_columns 'tags * 3' --query mysql --output_columns _key,tags,_score # [ # [ # 0, @@ -332,7 +332,7 @@ a scalar column.</p> </div> <p>With <a class="reference internal" href="../commands/select.html#select-filter"><span>filter</span></a>:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Bookmarks --filter 'tags @ "msyql"' --output_columns _key,tags,_score +<div class="highlight-none"><div class="highlight"><pre><span></span>select Bookmarks --filter 'tags @ "msyql"' --output_columns _key,tags,_score # [ # [ # 0, @@ -416,7 +416,7 @@ For example, you can't use <code class="docutils literal"><span class="pre">29</ weight vector column. The point is <code class="docutils literal"><span class="pre">COLUMN_VECTOR|WITH_WEIGHT</span></code> flags:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Bookmarks TABLE_HASH_KEY ShortText +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Bookmarks TABLE_HASH_KEY ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] column_create Bookmarks tags COLUMN_VECTOR|WITH_WEIGHT ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -429,7 +429,7 @@ column.</p> <div class="section" id="id8"> <h4>7.6.2.2.3.3. How to load<a class="headerlink" href="#id8" title="Permalink to this headline">¶</a></h4> <p>You can load vector data by JSON object syntax:</p> -<div class="highlight-none"><div class="highlight"><pre>{"ELEMENT1": WEIGHT1, "ELEMENT2": WEIGHT2, "ELEMENT3": WEIGHT3, ...} +<div class="highlight-none"><div class="highlight"><pre><span></span>{"ELEMENT1": WEIGHT1, "ELEMENT2": WEIGHT2, "ELEMENT3": WEIGHT3, ...} </pre></div> </div> <p>Let's load the following data:</p> @@ -457,7 +457,7 @@ column.</p> </table> <p>Here is a command that loads the data:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>load --table Bookmarks +<div class="highlight-none"><div class="highlight"><pre><span></span>load --table Bookmarks [ {"_key": "http://groonga.org/", "tags": {"groonga": 100}}, @@ -474,7 +474,7 @@ column.</p> </div> <p>The loaded data can be outputted as JSON object syntax:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Bookmarks +<div class="highlight-none"><div class="highlight"><pre><span></span>select Bookmarks # [ # [ # 0, @@ -535,18 +535,18 @@ column.</p> <p>You need to create an index to search weight vector column. You don't forget to specify <code class="docutils literal"><span class="pre">WITH_WEIGHT</span></code> flag to <code class="docutils literal"><span class="pre">column_create</span></code>:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Tags TABLE_PAT_KEY ShortText +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Tags TABLE_PAT_KEY ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] column_create Tags bookmark_index COLUMN_INDEX|WITH_WEIGHT Bookmarks tags # [[0, 1337566253.89858, 0.000355720520019531], true] </pre></div> </div> -<p>There are no weight vector column specific way except <code class="docutils literal"><span class="pre">WITH_WEIGHT</span></code> +<p>There is no weight vector column specific way except <code class="docutils literal"><span class="pre">WITH_WEIGHT</span></code> flag. You can create an index like a scalar column.</p> <p>You can search an element in <code class="docutils literal"><span class="pre">tags</span></code> like full text search syntax.</p> <p>With <a class="reference internal" href="../commands/select.html#select-match-columns"><span>match_columns</span></a> and <a class="reference internal" href="../commands/select.html#select-query"><span>query</span></a>:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Bookmarks --match_columns tags --query groonga --output_columns _key,tags,_score +<div class="highlight-none"><div class="highlight"><pre><span></span>select Bookmarks --match_columns tags --query groonga --output_columns _key,tags,_score # [ # [ # 0, @@ -604,7 +604,7 @@ flag. You can create an index like a scalar column.</p> <p>You can also use weight in <a class="reference internal" href="../commands/select.html#select-match-columns"><span>match_columns</span></a>. The score is <code class="docutils literal"><span class="pre">(1</span> <span class="pre">+</span> <span class="pre">weight_in_weight_vector)</span> <span class="pre">*</span> <span class="pre">weight_in_match_columns</span></code>:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Bookmarks --match_columns 'tags * 3' --query groonga --output_columns _key,tags,_score +<div class="highlight-none"><div class="highlight"><pre><span></span>select Bookmarks --match_columns 'tags * 3' --query groonga --output_columns _key,tags,_score # [ # [ # 0, @@ -661,7 +661,7 @@ flag. You can create an index like a scalar column.</p> </div> <p>With <a class="reference internal" href="../commands/select.html#select-filter"><span>filter</span></a>:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Bookmarks --filter 'tags @ "groonga"' --output_columns _key,tags,_score +<div class="highlight-none"><div class="highlight"><pre><span></span>select Bookmarks --filter 'tags @ "groonga"' --output_columns _key,tags,_score # [ # [ # 0, @@ -723,7 +723,7 @@ flag. You can create an index like a scalar column.</p> score without changing a set of matched records.</p> <p>Use <a class="reference internal" href="../commands/select.html#select-adjuster"><span>adjuster</span></a> for the purpose:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Bookmarks \ +<div class="highlight-none"><div class="highlight"><pre><span></span>select Bookmarks \ --filter true \ --adjuster 'tags @ "mysql" * 10 + tags @ "groonga" * 5' \ --output_columns _key,tags,_score Modified: docs/reference/command/command_version.html (+3 -3) =================================================================== --- docs/reference/command/command_version.html 2016-03-05 15:09:34 +0900 (072d863) +++ docs/reference/command/command_version.html 2016-03-17 12:56:59 +0900 (d1a64b0) @@ -106,7 +106,7 @@ </dl> <p>あるバージョンのGroongaがサポートする二つのコマンドバージョンのうち、いずれか一つが必ずstableの位置づけとなります。残りの一つは、developないしdeprecatedとなります。</p> <p>たとえば下記のようにGroongaのサポートするコマンドバージョンは推移します。:</p> -<div class="highlight-none"><div class="highlight"><pre>groonga1.1: command-version1=stable command-version2=develop +<div class="highlight-none"><div class="highlight"><pre><span></span>groonga1.1: command-version1=stable command-version2=develop groonga1.2: command-version1=deprecated command-version2=stable groonga1.3: command-version2=stable command-version3=develop groonga1.4: command-version2=deprecated command-version3=stable @@ -126,7 +126,7 @@ groonga1.5: command-version3=stable command-version4=develop <p>groonga実行モジュールの引数としてdefault-command-versionパラメータを指定できます。 (configファイルの中に指定することも可能です)</p> <p>実行例:</p> -<div class="highlight-none"><div class="highlight"><pre>groonga --default-command-version 1 +<div class="highlight-none"><div class="highlight"><pre><span></span>groonga --default-command-version 1 </pre></div> </div> <p>そのプロセスで実行するすべてのコマンドについて、デフォルトのコマンドバージョンとして指定されたバージョンを使用します。指定されたコマンドバージョンがstableであった場合にはなんのメッセージも表示されずそのまま起動します。指定されたコマンドバージョンがdevelopあるいはdeprecatedであった場合には、groonga.logファイルに警告メッセージを出力します。指定されたコマンドバージョンがサポート対象外であった場合には標準エラー出力にエラーメッセージを出力し、プロセスは速やかに終了します。</p> @@ -135,7 +135,7 @@ groonga1.5: command-version3=stable command-version4=develop <h3>7.3.1.3.2. command_versionパラメータ<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h3> <p>select,loadなどのすべてのgroongaコマンドにcommand_versionが指定できます。</p> <p>実行例:</p> -<div class="highlight-none"><div class="highlight"><pre>select --command_version 1 --table tablename +<div class="highlight-none"><div class="highlight"><pre><span></span>select --command_version 1 --table tablename </pre></div> </div> <p>指定されたコマンドバージョンでコマンドを実行します。指定されたコマンドバージョンがサポート対象外であった場合にはエラーが返されます。command-versionが指定されなかった場合は、当該プロセス起動時にdefault-command-versionに指定した値が指定されたものとみなします。</p> Modified: docs/reference/command/output_format.html (+9 -9) =================================================================== --- docs/reference/command/output_format.html 2016-03-05 15:09:34 +0900 (f4bd2d1) +++ docs/reference/command/output_format.html 2016-03-17 12:56:59 +0900 (5a242ae) @@ -101,11 +101,11 @@ to use TSV.</p> MessagePack format. JSON is used to show structure because MessagePack is binary format. Binary format isn't proper for documenataion.</p> <p>JSON and MessagePack uses the following structure:</p> -<div class="highlight-none"><div class="highlight"><pre>[HEADER, BODY] +<div class="highlight-none"><div class="highlight"><pre><span></span>[HEADER, BODY] </pre></div> </div> <p>For example:</p> -<div class="highlight-none"><div class="highlight"><pre>[ +<div class="highlight-none"><div class="highlight"><pre><span></span>[ [ 0, 1337566253.89858, @@ -146,7 +146,7 @@ is binary format. Binary format isn't proper for documenataion.</p> </pre></div> </div> <p>In the example, the following part is <code class="docutils literal"><span class="pre">HEADER</span></code>:</p> -<div class="highlight-none"><div class="highlight"><pre>[ +<div class="highlight-none"><div class="highlight"><pre><span></span>[ 0, 1337566253.89858, 0.000355720520019531 @@ -154,7 +154,7 @@ is binary format. Binary format isn't proper for documenataion.</p> </pre></div> </div> <p>The following part is <code class="docutils literal"><span class="pre">BODY</span></code>:</p> -<div class="highlight-none"><div class="highlight"><pre>[ +<div class="highlight-none"><div class="highlight"><pre><span></span>[ [ [ 1 @@ -193,7 +193,7 @@ is binary format. Binary format isn't proper for documenataion.</p> <div class="section" id="success-case"> <h4>7.3.2.2.1.1. Success case<a class="headerlink" href="#success-case" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal"><span class="pre">HEADER</span></code> has three elements on success:</p> -<div class="highlight-none"><div class="highlight"><pre>[0, UNIX_TIME_WHEN_COMMAND_IS_STARTED, ELAPSED_TIME] +<div class="highlight-none"><div class="highlight"><pre><span></span>[0, UNIX_TIME_WHEN_COMMAND_IS_STARTED, ELAPSED_TIME] </pre></div> </div> <p>The first element is always <code class="docutils literal"><span class="pre">0</span></code>.</p> @@ -207,7 +207,7 @@ nanosecond.</p> <div class="section" id="error-case"> <h4>7.3.2.2.1.2. Error case<a class="headerlink" href="#error-case" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal"><span class="pre">HEADER</span></code> has four or five elements on error:</p> -<div class="highlight-none"><div class="highlight"><pre>[ +<div class="highlight-none"><div class="highlight"><pre><span></span>[ RETURN_CODE, UNIX_TIME_WHEN_COMMAND_IS_STARTED, ELAPSED_TIME, @@ -226,7 +226,7 @@ same as success case.</p> <p><code class="docutils literal"><span class="pre">ERROR_LOCATION</span></code> is optional. If error location is collected, <code class="docutils literal"><span class="pre">ERROR_LOCATION</span></code> is included. <code class="docutils literal"><span class="pre">ERROR_LOCATION</span></code> is an array. <code class="docutils literal"><span class="pre">ERROR_LOCATION</span></code> has one ore two elements:</p> -<div class="highlight-none"><div class="highlight"><pre>[ +<div class="highlight-none"><div class="highlight"><pre><span></span>[ LOCATION_IN_GROONGA, LOCATION_IN_INPUT ] @@ -236,7 +236,7 @@ array. <code class="docutils literal"><span class="pre">ERROR_LOCATION</span></c in groonga. It is useful for groonga developers but not useful for users. <code class="docutils literal"><span class="pre">LOCATION_IN_GROONGA</span></code> is an array. <code class="docutils literal"><span class="pre">LOCATION_IN_GROONGA</span></code> has three elements:</p> -<div class="highlight-none"><div class="highlight"><pre>[ +<div class="highlight-none"><div class="highlight"><pre><span></span>[ FUNCTION_NAME, SOURCE_FILE_NAME, LINE_NUMBER @@ -253,7 +253,7 @@ when the location that error is occurred in input file is collected. Input file can be specified by <code class="docutils literal"><span class="pre">--file</span></code> command line option for <code class="docutils literal"><span class="pre">groonga</span></code> command. <code class="docutils literal"><span class="pre">LOCATION_IN_GROONGA</span></code> is an array. <code class="docutils literal"><span class="pre">LOCATION_IN_GROONGA</span></code> has three elements:</p> -<div class="highlight-none"><div class="highlight"><pre>[ +<div class="highlight-none"><div class="highlight"><pre><span></span>[ INPUT_FILE_NAME, LINE_NUMBER, LINE_CONTENT Modified: docs/reference/command/pretty_print.html (+2 -2) =================================================================== --- docs/reference/command/pretty_print.html 2016-03-05 15:09:34 +0900 (4ecd032) +++ docs/reference/command/pretty_print.html 2016-03-17 12:56:59 +0900 (2339090) @@ -97,7 +97,7 @@ <div class="section" id="usage"> <h2>7.3.3.2. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2> <p>Just specify <code class="docutils literal"><span class="pre">yes</span></code> to <code class="docutils literal"><span class="pre">output_pretty</span></code> parameter:</p> -<div class="highlight-none"><div class="highlight"><pre>> status --output_pretty yes +<div class="highlight-none"><div class="highlight"><pre><span></span>> status --output_pretty yes [ [ 0, @@ -120,7 +120,7 @@ </pre></div> </div> <p>Here is a result without <code class="docutils literal"><span class="pre">output_pretty</span></code> parameter:</p> -<div class="highlight-none"><div class="highlight"><pre>> status +<div class="highlight-none"><div class="highlight"><pre><span></span>> status [[0,1448344438.43783,5.29289245605469e-05],{"alloc_count":233,"starttime":1448344437,...}] </pre></div> </div> Modified: docs/reference/command/request_id.html (+1 -1) =================================================================== --- docs/reference/command/request_id.html 2016-03-05 15:09:34 +0900 (29d5082) +++ docs/reference/command/request_id.html 2016-03-17 12:56:59 +0900 (ea62b28) @@ -106,7 +106,7 @@ some running requests, you can't cancel the request.</p> <p>All commands accept <code class="docutils literal"><span class="pre">request_id</span></code> parameter. You can assign ID to request by adding <code class="docutils literal"><span class="pre">request_id</span></code> parameter.</p> <p>Here is an example to assign <code class="docutils literal"><span class="pre">id-1</span></code> ID to a request:</p> -<div class="highlight-none"><div class="highlight"><pre>select Users --request_id id-1 +<div class="highlight-none"><div class="highlight"><pre><span></span>select Users --request_id id-1 </pre></div> </div> </div> Modified: docs/reference/commands/cache_limit.html (+4 -4) =================================================================== --- docs/reference/commands/cache_limit.html 2016-03-05 15:09:34 +0900 (e3bf0f0) +++ docs/reference/commands/cache_limit.html 2016-03-17 12:56:59 +0900 (2cb6306) @@ -97,7 +97,7 @@ entries. Query cache is used only by <a class="reference internal" href="select. <div class="section" id="syntax"> <h2>7.3.6.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> <p>This command takes only one optional parameter:</p> -<div class="highlight-none"><div class="highlight"><pre>cache_limit [max=null] +<div class="highlight-none"><div class="highlight"><pre><span></span>cache_limit [max=null] </pre></div> </div> </div> @@ -106,7 +106,7 @@ entries. Query cache is used only by <a class="reference internal" href="select. <p>You can get the current max number of cache entries by executing <code class="docutils literal"><span class="pre">cache_limit</span></code> without parameter.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>cache_limit +<div class="highlight-none"><div class="highlight"><pre><span></span>cache_limit # [[0, 1337566253.89858, 0.000355720520019531], 100] </pre></div> </div> @@ -115,7 +115,7 @@ with <code class="docutils literal"><span class="pre">max</span></code> paramete <p>Here is an example that sets <code class="docutils literal"><span class="pre">10</span></code> as the max number of cache entries.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>cache_limit 10 +<div class="highlight-none"><div class="highlight"><pre><span></span>cache_limit 10 # [[0, 1337566253.89858, 0.000355720520019531], 100] cache_limit # [[0, 1337566253.89858, 0.000355720520019531], 10] @@ -138,7 +138,7 @@ max number of query cache entries.</p> <div class="section" id="return-value"> <h2>7.3.6.5. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2> <p><code class="docutils literal"><span class="pre">cache_limit</span></code> returns the current max number of query cache entries:</p> -<div class="highlight-none"><div class="highlight"><pre>[HEADER, N_ENTRIES] +<div class="highlight-none"><div class="highlight"><pre><span></span>[HEADER, N_ENTRIES] </pre></div> </div> <p><code class="docutils literal"><span class="pre">HEADER</span></code></p> Modified: docs/reference/commands/check.html (+3 -3) =================================================================== --- docs/reference/commands/check.html 2016-03-05 15:09:34 +0900 (322fcdf) +++ docs/reference/commands/check.html 2016-03-17 12:56:59 +0900 (3979a07) @@ -94,14 +94,14 @@ </div> <div class="section" id="syntax"> <h2>7.3.7.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> -<div class="highlight-none"><div class="highlight"><pre>check obj +<div class="highlight-none"><div class="highlight"><pre><span></span>check obj </pre></div> </div> </div> <div class="section" id="usage"> <h2>7.3.7.3. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2> <p>テーブルTermsのインデックスカラムnameの状態を表示します。:</p> -<div class="highlight-none"><div class="highlight"><pre>check Terms.name +<div class="highlight-none"><div class="highlight"><pre><span></span>check Terms.name [{"flags":"00008202", "max sid":1, "number of garbage segments":0, @@ -147,7 +147,7 @@ <h2>7.3.7.5. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2> <p>チェックするオブジェクトにより返される値が変わります。</p> <p>インデックスカラムの場合:</p> -<div class="highlight-none"><div class="highlight"><pre>下記のような配列が出力されます。 +<div class="highlight-none"><div class="highlight"><pre><span></span>下記のような配列が出力されます。 [インデックスの状態, バッファの状態1, バッファの状態2, ...] </pre></div> Modified: docs/reference/commands/clearlock.html (+4 -4) =================================================================== --- docs/reference/commands/clearlock.html 2016-03-05 15:09:34 +0900 (5651fb1) +++ docs/reference/commands/clearlock.html 2016-03-17 12:56:59 +0900 (5e59c1e) @@ -97,19 +97,19 @@ </div> <div class="section" id="syntax"> <h2>7.3.8.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> -<div class="highlight-none"><div class="highlight"><pre>clearlock objname +<div class="highlight-none"><div class="highlight"><pre><span></span>clearlock objname </pre></div> </div> </div> <div class="section" id="usage"> <h2>7.3.8.3. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2> <p>開いているデータベースのロックをすべて解除する:</p> -<div class="highlight-none"><div class="highlight"><pre>clearlock +<div class="highlight-none"><div class="highlight"><pre><span></span>clearlock [true] </pre></div> </div> <p>テーブル名 Entry のカラム body のロックを解除する:</p> -<div class="highlight-none"><div class="highlight"><pre>clearlock Entry.body +<div class="highlight-none"><div class="highlight"><pre><span></span>clearlock Entry.body [true] </pre></div> </div> @@ -122,7 +122,7 @@ </div> <div class="section" id="return-value"> <h2>7.3.8.5. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2> -<div class="highlight-none"><div class="highlight"><pre>[成功かどうかのフラグ] +<div class="highlight-none"><div class="highlight"><pre><span></span>[成功かどうかのフラグ] </pre></div> </div> <p><code class="docutils literal"><span class="pre">成功かどうかのフラグ</span></code></p> Modified: docs/reference/commands/column_copy.html (+17 -17) =================================================================== --- docs/reference/commands/column_copy.html 2016-03-05 15:09:34 +0900 (67c20f2) +++ docs/reference/commands/column_copy.html 2016-03-17 12:56:59 +0900 (0fc9226) @@ -133,7 +133,7 @@ key.</p> <h2>7.3.9.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> <p>This command takes four parameters.</p> <p>All parameters are required:</p> -<div class="highlight-none"><div class="highlight"><pre>column_copy from_table +<div class="highlight-none"><div class="highlight"><pre><span></span>column_copy from_table from_name to_table to_name @@ -170,7 +170,7 @@ key.</p> <code class="docutils literal"><span class="pre">ShortText</span></code>.</p> <p>Here are schema and data:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Logs TABLE_HASH_KEY ShortText +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Logs TABLE_HASH_KEY ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] column_create Logs serial COLUMN_SCALAR Int32 # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -184,7 +184,7 @@ load --table Logs <p>The following commands change <code class="docutils literal"><span class="pre">Logs.serial</span></code> column value type to <code class="docutils literal"><span class="pre">ShortText</span></code> from <code class="docutils literal"><span class="pre">Int32</span></code>:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>column_create Logs new_serial COLUMN_SCALAR ShortText +<div class="highlight-none"><div class="highlight"><pre><span></span>column_create Logs new_serial COLUMN_SCALAR ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] column_copy Logs serial Logs new_serial # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -234,7 +234,7 @@ response of <code class="docutils literal"><span class="pre">select</span></code <code class="docutils literal"><span class="pre">COLUMN_SCALAR</span></code>.</p> <p>Here are schema and data:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Entries TABLE_HASH_KEY ShortText +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Entries TABLE_HASH_KEY ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] column_create Entries tag COLUMN_SCALAR ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -248,7 +248,7 @@ load --table Entries <p>The following commands change <code class="docutils literal"><span class="pre">Entries.tag</span></code> column to <code class="docutils literal"><span class="pre">COLUMN_VECTOR</span></code> from <code class="docutils literal"><span class="pre">COLUMN_SCALAR</span></code>:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>column_create Entries new_tag COLUMN_VECTOR ShortText +<div class="highlight-none"><div class="highlight"><pre><span></span>column_create Entries new_tag COLUMN_VECTOR ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] column_copy Entries tag Entries new_tag # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -300,7 +300,7 @@ response of <code class="docutils literal"><span class="pre">select</span></code from <code class="docutils literal"><span class="pre">Players</span></code> table.</p> <p>Here are schema and data:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Players TABLE_HASH_KEY ShortText +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Players TABLE_HASH_KEY ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] column_create Players high_score COLUMN_SCALAR Int32 # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -314,7 +314,7 @@ load --table Players <p>The following commands move <code class="docutils literal"><span class="pre">high_score</span></code> column to <code class="docutils literal"><span class="pre">Users</span></code> table from <code class="docutils literal"><span class="pre">Players</span></code> table:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Users TABLE_HASH_KEY ShortText +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Users TABLE_HASH_KEY ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] column_create Users high_score COLUMN_SCALAR Int32 # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -390,7 +390,7 @@ record without record key.</p> <code class="docutils literal"><span class="pre">Int32</span></code>.</p> <p>Here are schema and data:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create IDs TABLE_HASH_KEY Int32 +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create IDs TABLE_HASH_KEY Int32 # [[0, 1337566253.89858, 0.000355720520019531], true] column_create IDs label COLUMN_SCALAR ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -406,7 +406,7 @@ load --table IDs <p>The following commands change <code class="docutils literal"><span class="pre">IDs</span></code> table key type to <code class="docutils literal"><span class="pre">ShortText</span></code> from <code class="docutils literal"><span class="pre">Int32</span></code>:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create NewIDs TABLE_HASH_KEY Int32 +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create NewIDs TABLE_HASH_KEY Int32 # [[0, 1337566253.89858, 0.000355720520019531], true] column_create NewIDs label COLUMN_SCALAR ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -467,7 +467,7 @@ select IDs <code class="docutils literal"><span class="pre">TABLE_HASH_KEY</span></code>.</p> <p>Here are schema and data:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Names TABLE_HASH_KEY ShortText +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Names TABLE_HASH_KEY ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] column_create Names used COLUMN_SCALAR Bool # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -481,7 +481,7 @@ load --table Entries <p>The following commands change <code class="docutils literal"><span class="pre">Names</span></code> table to <code class="docutils literal"><span class="pre">TABLE_PAT_KEY</span></code> from <code class="docutils literal"><span class="pre">TABLE_HASH_KEY</span></code>:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create NewNames TABLE_PAT_KEY ShortText +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create NewNames TABLE_PAT_KEY ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] column_create NewNames used COLUMN_SCALAR Bool # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -542,7 +542,7 @@ must be the same table.</p> <p>Here is an example to use <code class="docutils literal"><span class="pre">from_table</span></code>.</p> <p>Here are schema and data:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create FromTable TABLE_HASH_KEY ShortText +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create FromTable TABLE_HASH_KEY ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] column_create FromTable from_column COLUMN_SCALAR ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -591,7 +591,7 @@ select FromTable --output_columns _key,from_column,to_column </div> <p>You can copy all values to <code class="docutils literal"><span class="pre">to_column</span></code> from <code class="docutils literal"><span class="pre">from_column</span></code>:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>column_copy FromTable from_column FromTable to_column +<div class="highlight-none"><div class="highlight"><pre><span></span>column_copy FromTable from_column FromTable to_column # [[0, 1337566253.89858, 0.000355720520019531], true] select FromTable --output_columns _key,from_column,to_column # [ @@ -649,7 +649,7 @@ source table and destination table is the same table.</p> <p>Here is an example to use <code class="docutils literal"><span class="pre">to_table</span></code>.</p> <p>Here are schema and data:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Table TABLE_HASH_KEY ShortText +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Table TABLE_HASH_KEY ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] column_create Table column COLUMN_SCALAR ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -667,7 +667,7 @@ load --table Table <p>You can copy all values to <code class="docutils literal"><span class="pre">ToTable.to_column</span></code> from <code class="docutils literal"><span class="pre">Table.column</span></code>:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>column_copy Table column ToTable to_column +<div class="highlight-none"><div class="highlight"><pre><span></span>column_copy Table column ToTable to_column # [[0, 1337566253.89858, 0.000355720520019531], true] select ToTable --output_columns _key,to_column # [ @@ -709,13 +709,13 @@ select ToTable --output_columns _key,to_column </div> <div class="section" id="optional-parameters"> <h3>7.3.9.4.2. Optional parameters<a class="headerlink" href="#optional-parameters" title="Permalink to this headline">¶</a></h3> -<p>There is no optional parameters.</p> +<p>There is no optional parameter.</p> </div> </div> <div class="section" id="return-value"> <h2>7.3.9.5. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2> <p>The command returns <code class="docutils literal"><span class="pre">true</span></code> as body on success such as:</p> -<div class="highlight-none"><div class="highlight"><pre>[HEADER, true] +<div class="highlight-none"><div class="highlight"><pre><span></span>[HEADER, true] </pre></div> </div> <p>If the command fails, error details are in <code class="docutils literal"><span class="pre">HEADER</span></code>.</p> Modified: docs/reference/commands/column_create.html (+4 -4) =================================================================== --- docs/reference/commands/column_create.html 2016-03-05 15:09:34 +0900 (34d06b8) +++ docs/reference/commands/column_create.html 2016-03-17 12:56:59 +0900 (0898ab9) @@ -94,19 +94,19 @@ </div> <div class="section" id="syntax"> <h2>7.3.10.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> -<div class="highlight-none"><div class="highlight"><pre>column_create table name flags type [source] +<div class="highlight-none"><div class="highlight"><pre><span></span>column_create table name flags type [source] </pre></div> </div> </div> <div class="section" id="usage"> <h2>7.3.10.3. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2> <p>テーブルEntryに、ShortText型の値を格納するカラム、bodyを作成します。:</p> -<div class="highlight-none"><div class="highlight"><pre>column_create Entry body --type ShortText +<div class="highlight-none"><div class="highlight"><pre><span></span>column_create Entry body --type ShortText [true] </pre></div> </div> <p>テーブルTermに、Entryテーブルのbodyカラムの値を対象とする完全転置インデックス型カラム、entry_bodyを作成します。:</p> -<div class="highlight-none"><div class="highlight"><pre>column_create Term entry_body COLUMN_INDEX|WITH_POSITION Entry body +<div class="highlight-none"><div class="highlight"><pre><span></span>column_create Term entry_body COLUMN_INDEX|WITH_POSITION Entry body [true] </pre></div> </div> @@ -159,7 +159,7 @@ </div> <div class="section" id="return-value"> <h2>7.3.10.5. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2> -<div class="highlight-none"><div class="highlight"><pre>[HEADER, SUCCEEDED] +<div class="highlight-none"><div class="highlight"><pre><span></span>[HEADER, SUCCEEDED] </pre></div> </div> <p><code class="docutils literal"><span class="pre">HEADER</span></code></p> Modified: docs/reference/commands/column_list.html (+5 -5) =================================================================== --- docs/reference/commands/column_list.html 2016-03-05 15:09:34 +0900 (913c70f) +++ docs/reference/commands/column_list.html 2016-03-17 12:56:59 +0900 (151951f) @@ -93,7 +93,7 @@ <div class="section" id="syntax"> <h2>7.3.11.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> <p>This command takes only one required parameter:</p> -<div class="highlight-none"><div class="highlight"><pre>column_list table +<div class="highlight-none"><div class="highlight"><pre><span></span>column_list table </pre></div> </div> </div> @@ -101,7 +101,7 @@ <h2>7.3.11.3. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2> <p>Here is a simple example of <code class="docutils literal"><span class="pre">column_list</span></code> command.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Users TABLE_PAT_KEY ShortText +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Users TABLE_PAT_KEY ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] column_create Users age COLUMN_SCALAR UInt8 # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -199,7 +199,7 @@ column_list Users <div class="section" id="return-value"> <h2>7.3.11.5. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2> <p><code class="docutils literal"><span class="pre">column_list</span></code> returns the list of column information in the table:</p> -<div class="highlight-none"><div class="highlight"><pre>[ +<div class="highlight-none"><div class="highlight"><pre><span></span>[ HEADER, [ COLUMN_LIST_HEADER, @@ -218,7 +218,7 @@ column_list Users <div><p><code class="docutils literal"><span class="pre">COLUMN_LIST_HEADER</span></code> describes about content of each <code class="docutils literal"><span class="pre">COLUMN_INFORMATION</span></code>.</p> <p><code class="docutils literal"><span class="pre">COLUMN_LIST_HEADER</span></code> is the following format:</p> -<div class="highlight-none"><div class="highlight"><pre>[ +<div class="highlight-none"><div class="highlight"><pre><span></span>[ ["id", "UInt32"], ["name", "ShortText"], ["path", "ShortText"], @@ -247,7 +247,7 @@ will be useful for programs rather than humans.</p> <p><code class="docutils literal"><span class="pre">COLUMN_INFORMATION</span></code></p> <blockquote> <div><p>Each <code class="docutils literal"><span class="pre">COLUMN_INFORMATION</span></code> is the following format:</p> -<div class="highlight-none"><div class="highlight"><pre>[ +<div class="highlight-none"><div class="highlight"><pre><span></span>[ ID, NAME, PATH, Modified: docs/reference/commands/column_remove.html (+3 -3) =================================================================== --- docs/reference/commands/column_remove.html 2016-03-05 15:09:34 +0900 (cedc7dc) +++ docs/reference/commands/column_remove.html 2016-03-17 12:56:59 +0900 (d4ee4f5) @@ -95,13 +95,13 @@ </div> <div class="section" id="syntax"> <h2>7.3.12.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> -<div class="highlight-none"><div class="highlight"><pre>column_remove table name +<div class="highlight-none"><div class="highlight"><pre><span></span>column_remove table name </pre></div> </div> </div> <div class="section" id="usage"> <h2>7.3.12.3. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2> -<div class="highlight-none"><div class="highlight"><pre>column_remove Entry body +<div class="highlight-none"><div class="highlight"><pre><span></span>column_remove Entry body [true] </pre></div> @@ -125,7 +125,7 @@ </div> <div class="section" id="return-value"> <h2>7.3.12.5. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2> -<div class="highlight-none"><div class="highlight"><pre>[成功かどうかのフラグ] +<div class="highlight-none"><div class="highlight"><pre><span></span>[成功かどうかのフラグ] </pre></div> </div> <p><code class="docutils literal"><span class="pre">成功かどうかのフラグ</span></code></p> Modified: docs/reference/commands/column_rename.html (+3 -3) =================================================================== --- docs/reference/commands/column_rename.html 2016-03-05 15:09:34 +0900 (9c47d60) +++ docs/reference/commands/column_rename.html 2016-03-17 12:56:59 +0900 (9926719) @@ -112,7 +112,7 @@ crash the Groonga process.</li> <h2>7.3.13.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> <p>This command takes three parameters.</p> <p>All parameters are required:</p> -<div class="highlight-none"><div class="highlight"><pre>column_rename table name new_name +<div class="highlight-none"><div class="highlight"><pre><span></span>column_rename table name new_name </pre></div> </div> </div> @@ -120,7 +120,7 @@ crash the Groonga process.</li> <h2>7.3.13.3. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2> <p>Here is a simple example of <code class="docutils literal"><span class="pre">column_rename</span></code> command.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Users TABLE_PAT_KEY ShortText +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Users TABLE_PAT_KEY ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] column_create Users score COLUMN_SCALAR Int32 # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -266,7 +266,7 @@ select Users </div> <div class="section" id="return-value"> <h2>7.3.13.5. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2> -<div class="highlight-none"><div class="highlight"><pre>[HEADER, SUCCEEDED_OR_NOT] +<div class="highlight-none"><div class="highlight"><pre><span></span>[HEADER, SUCCEEDED_OR_NOT] </pre></div> </div> <p><code class="docutils literal"><span class="pre">HEADER</span></code></p> Modified: docs/reference/commands/config_delete.html (+13 -13) =================================================================== --- docs/reference/commands/config_delete.html 2016-03-05 15:09:34 +0900 (e7d69d5) +++ docs/reference/commands/config_delete.html 2016-03-17 12:56:59 +0900 (cb71ec8) @@ -25,9 +25,9 @@ <script type="text/javascript" src="../../static/doctools.js"></script> <link rel="shortcut icon" href="../../static/favicon.ico"/> <link rel="top" title="Groonga v6.0.0 documentation" href="../../index.html" /> - <link rel="up" title="7.16. Configuration" href="../configuration.html" /> + <link rel="up" title="7.3. Command" href="../command.html" /> <link rel="next" title="7.3.15. config_get" href="config_get.html" /> - <link rel="prev" title="7.16. Configuration" href="../configuration.html" /> + <link rel="prev" title="7.3.13. column_rename" href="column_rename.html" /> <meta property="fb:page_id" content="201193596592346" /><!-- groonga --> <meta property="fb:admins" content="664204556" /><!-- kouhei.sutou --> <meta property="og:type" content="product" /> @@ -71,11 +71,11 @@ <a href="config_get.html" title="7.3.15. config_get" accesskey="N">next</a> |</li> <li class="right" > - <a href="../configuration.html" title="7.16. Configuration" + <a href="column_rename.html" title="7.3.13. column_rename" accesskey="P">previous</a> |</li> <li class="nav-item nav-item-0"><a href="../../index.html">Groonga v6.0.0 documentation</a> »</li> <li class="nav-item nav-item-1"><a href="../../reference.html" >7. Reference manual</a> »</li> - <li class="nav-item nav-item-2"><a href="../configuration.html" accesskey="U">7.16. Configuration</a> »</li> + <li class="nav-item nav-item-2"><a href="../command.html" accesskey="U">7.3. Command</a> »</li> </ul> </div> @@ -96,7 +96,7 @@ <div class="section" id="syntax"> <h2>7.3.14.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> <p>This command takes only one required parameter:</p> -<div class="highlight-none"><div class="highlight"><pre>config_delete key +<div class="highlight-none"><div class="highlight"><pre><span></span>config_delete key </pre></div> </div> </div> @@ -104,7 +104,7 @@ <h2>7.3.14.3. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2> <p>Here is an example to delete <code class="docutils literal"><span class="pre">alias.column</span></code> configuration item:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>config_set alias.column Aliases.real_name +<div class="highlight-none"><div class="highlight"><pre><span></span>config_set alias.column Aliases.real_name # [[0, 1337566253.89858, 0.000355720520019531], true] config_get alias.column # [[0, 1337566253.89858, 0.000355720520019531], "Aliases.real_name"] @@ -116,7 +116,7 @@ config_get alias.column </div> <p>Here is an example to delete nonexistent configuration item:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>config_delete nonexistent +<div class="highlight-none"><div class="highlight"><pre><span></span>config_delete nonexistent # [ # [ # -22, @@ -153,14 +153,14 @@ configuration item.</p> </div> <div class="section" id="optional-parameters"> <h3>7.3.14.4.2. Optional parameters<a class="headerlink" href="#optional-parameters" title="Permalink to this headline">¶</a></h3> -<p>There is no optional parameters.</p> +<p>There is no optional parameter.</p> </div> </div> <div class="section" id="return-value"> <h2>7.3.14.5. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2> <p><code class="docutils literal"><span class="pre">config_delete</span></code> command returns whether deleting a configuration item is succeeded or not:</p> -<div class="highlight-none"><div class="highlight"><pre>[HEADER, SUCCEEDED_OR_NOT] +<div class="highlight-none"><div class="highlight"><pre><span></span>[HEADER, SUCCEEDED_OR_NOT] </pre></div> </div> <div class="section" id="header"> @@ -215,8 +215,8 @@ item is succeeded or not:</p> </ul> <h4>Previous topic</h4> - <p class="topless"><a href="../configuration.html" - title="previous chapter">7.16. Configuration</a></p> + <p class="topless"><a href="column_rename.html" + title="previous chapter">7.3.13. <code class="docutils literal"><span class="pre">column_rename</span></code></a></p> <h4>Next topic</h4> <p class="topless"><a href="config_get.html" title="next chapter">7.3.15. <code class="docutils literal"><span class="pre">config_get</span></code></a></p> @@ -254,11 +254,11 @@ item is succeeded or not:</p> <a href="config_get.html" title="7.3.15. config_get" >next</a> |</li> <li class="right" > - <a href="../configuration.html" title="7.16. Configuration" + <a href="column_rename.html" title="7.3.13. column_rename" >previous</a> |</li> <li class="nav-item nav-item-0"><a href="../../index.html">Groonga v6.0.0 documentation</a> »</li> <li class="nav-item nav-item-1"><a href="../../reference.html" >7. Reference manual</a> »</li> - <li class="nav-item nav-item-2"><a href="../configuration.html" >7.16. Configuration</a> »</li> + <li class="nav-item nav-item-2"><a href="../command.html" >7.3. Command</a> »</li> </ul> </div> <div class="footer" role="contentinfo"> Modified: docs/reference/commands/config_get.html (+8 -8) =================================================================== --- docs/reference/commands/config_get.html 2016-03-05 15:09:34 +0900 (2608faf) +++ docs/reference/commands/config_get.html 2016-03-17 12:56:59 +0900 (1b6e64d) @@ -25,7 +25,7 @@ <script type="text/javascript" src="../../static/doctools.js"></script> <link rel="shortcut icon" href="../../static/favicon.ico"/> <link rel="top" title="Groonga v6.0.0 documentation" href="../../index.html" /> - <link rel="up" title="7.16. Configuration" href="../configuration.html" /> + <link rel="up" title="7.3. Command" href="../command.html" /> <link rel="next" title="7.3.16. config_set" href="config_set.html" /> <link rel="prev" title="7.3.14. config_delete" href="config_delete.html" /> <meta property="fb:page_id" content="201193596592346" /><!-- groonga --> @@ -75,7 +75,7 @@ accesskey="P">previous</a> |</li> <li class="nav-item nav-item-0"><a href="../../index.html">Groonga v6.0.0 documentation</a> »</li> <li class="nav-item nav-item-1"><a href="../../reference.html" >7. Reference manual</a> »</li> - <li class="nav-item nav-item-2"><a href="../configuration.html" accesskey="U">7.16. Configuration</a> »</li> + <li class="nav-item nav-item-2"><a href="../command.html" accesskey="U">7.3. Command</a> »</li> </ul> </div> @@ -97,7 +97,7 @@ configuration item.</p> <div class="section" id="syntax"> <h2>7.3.15.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> <p>This command takes only one required parameter:</p> -<div class="highlight-none"><div class="highlight"><pre>config_get key +<div class="highlight-none"><div class="highlight"><pre><span></span>config_get key </pre></div> </div> </div> @@ -106,7 +106,7 @@ configuration item.</p> <p>Here is an example to set a value to <code class="docutils literal"><span class="pre">alias.column</span></code> configuration item and get the value:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>config_set alias.column Aliases.real_name +<div class="highlight-none"><div class="highlight"><pre><span></span>config_set alias.column Aliases.real_name # [[0, 1337566253.89858, 0.000355720520019531], true] config_get alias.column # [[0, 1337566253.89858, 0.000355720520019531], "Aliases.real_name"] @@ -114,7 +114,7 @@ config_get alias.column </div> <p>Here is an example to get nonexistent configuration item value:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>config_get nonexistent +<div class="highlight-none"><div class="highlight"><pre><span></span>config_get nonexistent # [[0, 1337566253.89858, 0.000355720520019531], ""] </pre></div> </div> @@ -136,14 +136,14 @@ item key.</p> </div> <div class="section" id="optional-parameters"> <h3>7.3.15.4.2. Optional parameters<a class="headerlink" href="#optional-parameters" title="Permalink to this headline">¶</a></h3> -<p>There is no optional parameters.</p> +<p>There is no optional parameter.</p> </div> </div> <div class="section" id="return-value"> <h2>7.3.15.5. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2> <p><code class="docutils literal"><span class="pre">config_get</span></code> command returns the value of the specified configuration item:</p> -<div class="highlight-none"><div class="highlight"><pre>[HEADER, VALUE] +<div class="highlight-none"><div class="highlight"><pre><span></span>[HEADER, VALUE] </pre></div> </div> <div class="section" id="header"> @@ -242,7 +242,7 @@ configuration item:</p> >previous</a> |</li> <li class="nav-item nav-item-0"><a href="../../index.html">Groonga v6.0.0 documentation</a> »</li> <li class="nav-item nav-item-1"><a href="../../reference.html" >7. Reference manual</a> »</li> - <li class="nav-item nav-item-2"><a href="../configuration.html" >7.16. Configuration</a> »</li> + <li class="nav-item nav-item-2"><a href="../command.html" >7.3. Command</a> »</li> </ul> </div> <div class="footer" role="contentinfo"> Modified: docs/reference/commands/config_set.html (+12 -12) =================================================================== --- docs/reference/commands/config_set.html 2016-03-05 15:09:34 +0900 (e6bcb0c) +++ docs/reference/commands/config_set.html 2016-03-17 12:56:59 +0900 (f9a61d2) @@ -25,8 +25,8 @@ <script type="text/javascript" src="../../static/doctools.js"></script> <link rel="shortcut icon" href="../../static/favicon.ico"/> <link rel="top" title="Groonga v6.0.0 documentation" href="../../index.html" /> - <link rel="up" title="7.16. Configuration" href="../configuration.html" /> - <link rel="next" title="7.17. Alias" href="../alias.html" /> + <link rel="up" title="7.3. Command" href="../command.html" /> + <link rel="next" title="7.3.17. database_unmap" href="database_unmap.html" /> <link rel="prev" title="7.3.15. config_get" href="config_get.html" /> <meta property="fb:page_id" content="201193596592346" /><!-- groonga --> <meta property="fb:admins" content="664204556" /><!-- kouhei.sutou --> @@ -68,14 +68,14 @@ <a href="../../genindex.html" title="General Index" accesskey="I">index</a></li> <li class="right" > - <a href="../alias.html" title="7.17. Alias" + <a href="database_unmap.html" title="7.3.17. database_unmap" accesskey="N">next</a> |</li> <li class="right" > <a href="config_get.html" title="7.3.15. config_get" accesskey="P">previous</a> |</li> <li class="nav-item nav-item-0"><a href="../../index.html">Groonga v6.0.0 documentation</a> »</li> <li class="nav-item nav-item-1"><a href="../../reference.html" >7. Reference manual</a> »</li> - <li class="nav-item nav-item-2"><a href="../configuration.html" accesskey="U">7.16. Configuration</a> »</li> + <li class="nav-item nav-item-2"><a href="../command.html" accesskey="U">7.3. Command</a> »</li> </ul> </div> @@ -97,7 +97,7 @@ configuration item.</p> <div class="section" id="syntax"> <h2>7.3.16.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> <p>This command takes two required parameters:</p> -<div class="highlight-none"><div class="highlight"><pre>config_set key value +<div class="highlight-none"><div class="highlight"><pre><span></span>config_set key value </pre></div> </div> </div> @@ -106,7 +106,7 @@ configuration item.</p> <p>Here is an example to set a value to <code class="docutils literal"><span class="pre">alias.column</span></code> configuration item and confirm the set value:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>config_set alias.column Aliases.real_name +<div class="highlight-none"><div class="highlight"><pre><span></span>config_set alias.column Aliases.real_name # [[0, 1337566253.89858, 0.000355720520019531], true] config_get alias.column # [[0, 1337566253.89858, 0.000355720520019531], "Aliases.real_name"] @@ -134,14 +134,14 @@ config_get alias.column </div> <div class="section" id="optional-parameters"> <h3>7.3.16.4.2. Optional parameters<a class="headerlink" href="#optional-parameters" title="Permalink to this headline">¶</a></h3> -<p>There is no optional parameters.</p> +<p>There is no optional parameter.</p> </div> </div> <div class="section" id="return-value"> <h2>7.3.16.5. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2> <p><code class="docutils literal"><span class="pre">config_set</span></code> command returns whether setting a configuration item value is succeeded or not:</p> -<div class="highlight-none"><div class="highlight"><pre>[HEADER, SUCCEEDED_OR_NOT] +<div class="highlight-none"><div class="highlight"><pre><span></span>[HEADER, SUCCEEDED_OR_NOT] </pre></div> </div> <div class="section" id="header"> @@ -200,8 +200,8 @@ value is succeeded or not:</p> <p class="topless"><a href="config_get.html" title="previous chapter">7.3.15. <code class="docutils literal"><span class="pre">config_get</span></code></a></p> <h4>Next topic</h4> - <p class="topless"><a href="../alias.html" - title="next chapter">7.17. Alias</a></p> + <p class="topless"><a href="database_unmap.html" + title="next chapter">7.3.17. <code class="docutils literal"><span class="pre">database_unmap</span></code></a></p> <div role="note" aria-label="source link"> <h3>This Page</h3> <ul class="this-page-menu"> @@ -233,14 +233,14 @@ value is succeeded or not:</p> <a href="../../genindex.html" title="General Index" >index</a></li> <li class="right" > - <a href="../alias.html" title="7.17. Alias" + <a href="database_unmap.html" title="7.3.17. database_unmap" >next</a> |</li> <li class="right" > <a href="config_get.html" title="7.3.15. config_get" >previous</a> |</li> <li class="nav-item nav-item-0"><a href="../../index.html">Groonga v6.0.0 documentation</a> »</li> <li class="nav-item nav-item-1"><a href="../../reference.html" >7. Reference manual</a> »</li> - <li class="nav-item nav-item-2"><a href="../configuration.html" >7.16. Configuration</a> »</li> + <li class="nav-item nav-item-2"><a href="../command.html" >7.3. Command</a> »</li> </ul> </div> <div class="footer" role="contentinfo"> Modified: docs/reference/commands/database_unmap.html (+6 -6) =================================================================== --- docs/reference/commands/database_unmap.html 2016-03-05 15:09:34 +0900 (8921b42) +++ docs/reference/commands/database_unmap.html 2016-03-17 12:56:59 +0900 (2f4ab64) @@ -110,7 +110,7 @@ memory. OS moves unused memory preferentially.</p> <div class="section" id="syntax"> <h2>7.3.17.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> <p>This command takes no parameters:</p> -<div class="highlight-none"><div class="highlight"><pre>database_unmap +<div class="highlight-none"><div class="highlight"><pre><span></span>database_unmap </pre></div> </div> </div> @@ -119,7 +119,7 @@ memory. OS moves unused memory preferentially.</p> <p>You can unmap database after you change the max number of threads to <code class="docutils literal"><span class="pre">1</span></code>:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>thread_limit --max 1 +<div class="highlight-none"><div class="highlight"><pre><span></span>thread_limit --max 1 # [[0, 1337566253.89858, 0.000355720520019531], 2] database_unmap # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -128,7 +128,7 @@ database_unmap <p>If the max number of threads is larger than <code class="docutils literal"><span class="pre">1</span></code>, <code class="docutils literal"><span class="pre">database_unmap</span></code> fails:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>thread_limit --max 2 +<div class="highlight-none"><div class="highlight"><pre><span></span>thread_limit --max 2 # [[0, 1337566253.89858, 0.000355720520019531], 1] database_unmap # [ @@ -155,17 +155,17 @@ database_unmap <p>This section describes all parameters.</p> <div class="section" id="required-parameters"> <h3>7.3.17.4.1. Required parameters<a class="headerlink" href="#required-parameters" title="Permalink to this headline">¶</a></h3> -<p>There is no required parameters.</p> +<p>There is no required parameter.</p> </div> <div class="section" id="optional-parameters"> <h3>7.3.17.4.2. Optional parameters<a class="headerlink" href="#optional-parameters" title="Permalink to this headline">¶</a></h3> -<p>There is no optional parameters.</p> +<p>There is no optional parameter.</p> </div> </div> <div class="section" id="return-value"> <h2>7.3.17.5. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2> <p>The command returns <code class="docutils literal"><span class="pre">true</span></code> as body on success such as:</p> -<div class="highlight-none"><div class="highlight"><pre>[HEADER, true] +<div class="highlight-none"><div class="highlight"><pre><span></span>[HEADER, true] </pre></div> </div> <p>If the command fails, error details are in <code class="docutils literal"><span class="pre">HEADER</span></code>.</p> Modified: docs/reference/commands/define_selector.html (+3 -3) =================================================================== --- docs/reference/commands/define_selector.html 2016-03-05 15:09:34 +0900 (279c0eb) +++ docs/reference/commands/define_selector.html 2016-03-17 12:56:59 +0900 (7f1650f) @@ -94,7 +94,7 @@ </div> <div class="section" id="syntax"> <h2>7.3.18.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> -<div class="highlight-none"><div class="highlight"><pre>define_selector name table [match_columns [query [filter [scorer [sortby +<div class="highlight-none"><div class="highlight"><pre><span></span>define_selector name table [match_columns [query [filter [scorer [sortby [output_columns [offset [limit [drilldown [drilldown_sortby [drilldown_output_columns [drilldown_offset [drilldown_limit]]]]]]]]]]]]] </pre></div> @@ -103,7 +103,7 @@ <div class="section" id="usage"> <h2>7.3.18.3. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2> <p>テーブルEntryの全レコード・全カラムの値を出力するselectorコマンドを定義します。:</p> -<div class="highlight-none"><div class="highlight"><pre>define_selector entry_selector Entry +<div class="highlight-none"><div class="highlight"><pre><span></span>define_selector entry_selector Entry [true] </pre></div> </div> @@ -158,7 +158,7 @@ </div> <div class="section" id="return-value"> <h2>7.3.18.5. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2> -<div class="highlight-none"><div class="highlight"><pre>[成功かどうかのフラグ] +<div class="highlight-none"><div class="highlight"><pre><span></span>[成功かどうかのフラグ] </pre></div> </div> <p><code class="docutils literal"><span class="pre">成功かどうかのフラグ</span></code></p> Modified: docs/reference/commands/defrag.html (+4 -4) =================================================================== --- docs/reference/commands/defrag.html 2016-03-05 15:09:34 +0900 (057aeea) +++ docs/reference/commands/defrag.html 2016-03-17 12:56:59 +0900 (304a9ad) @@ -96,19 +96,19 @@ </div> <div class="section" id="syntax"> <h2>7.3.19.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> -<div class="highlight-none"><div class="highlight"><pre>defrag objname threshold +<div class="highlight-none"><div class="highlight"><pre><span></span>defrag objname threshold </pre></div> </div> </div> <div class="section" id="usage"> <h2>7.3.19.3. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2> <p>開いているデータベースのフラグメンテーションを解消する:</p> -<div class="highlight-none"><div class="highlight"><pre>defrag +<div class="highlight-none"><div class="highlight"><pre><span></span>defrag [300] </pre></div> </div> <p>テーブル名 Entry のカラム body のフラグメンテーションを解消する:</p> -<div class="highlight-none"><div class="highlight"><pre>defrag Entry.body +<div class="highlight-none"><div class="highlight"><pre><span></span>defrag Entry.body [30] </pre></div> </div> @@ -121,7 +121,7 @@ </div> <div class="section" id="return-value"> <h2>7.3.19.5. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2> -<div class="highlight-none"><div class="highlight"><pre>[フラグメンテーション解消を実行したセグメントの数] +<div class="highlight-none"><div class="highlight"><pre><span></span>[フラグメンテーション解消を実行したセグメントの数] </pre></div> </div> <p><code class="docutils literal"><span class="pre">フラグメンテーション解消を実行したセグメントの数</span></code></p> Modified: docs/reference/commands/delete.html (+4 -4) =================================================================== --- docs/reference/commands/delete.html 2016-03-05 15:09:34 +0900 (848025b) +++ docs/reference/commands/delete.html 2016-03-17 12:56:59 +0900 (2888fa1) @@ -97,7 +97,7 @@ </div> <div class="section" id="syntax"> <h2>7.3.20.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> -<div class="highlight-none"><div class="highlight"><pre>delete table [key [id [filter]]] +<div class="highlight-none"><div class="highlight"><pre><span></span>delete table [key [id [filter]]] </pre></div> </div> </div> @@ -106,7 +106,7 @@ <p>Here are a schema definition and sample data to show usage.</p> <p>Delete the record from Entry table which has "2" as the key.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>delete Entry 2 +<div class="highlight-none"><div class="highlight"><pre><span></span>delete Entry 2 # [[0, 1337566253.89858, 0.000355720520019531], true] select Entry # [ @@ -148,7 +148,7 @@ select Entry <p>The country column of Users table associates with Country table.</p> <p>"Cascaded delete" removes the records which matches specified key and refers that key.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Country TABLE_HASH_KEY ShortText +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Country TABLE_HASH_KEY ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] table_create Users TABLE_HASH_KEY UInt32 # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -280,7 +280,7 @@ you must not specify <code class="docutils literal"><span class="pre">key</span> </div> <div class="section" id="return-value"> <h2>7.3.20.5. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2> -<div class="highlight-none"><div class="highlight"><pre>[HEADER, SUCCEEDED_OR_NOT] +<div class="highlight-none"><div class="highlight"><pre><span></span>[HEADER, SUCCEEDED_OR_NOT] </pre></div> </div> <p><code class="docutils literal"><span class="pre">HEADER</span></code></p> Modified: docs/reference/commands/dump.html (+8 -8) =================================================================== --- docs/reference/commands/dump.html 2016-03-05 15:09:34 +0900 (3c44c9c) +++ docs/reference/commands/dump.html 2016-03-17 12:56:59 +0900 (91fa112) @@ -94,7 +94,7 @@ <p>dumpはデータベースのスキーマとデータを後から読み込めるフォーマットで出力します。dumpの結果は大きくなるため、 主にコマンドラインから使うことを想定しています。データベースのバックアップが主な利用方法です。</p> <p>dumpが出力するフォーマットは直接Groongaが解釈できるフォーマットです。そのため、以下のようにしてデータベース>をコピーすることができます。:</p> -<div class="highlight-none"><div class="highlight"><pre>% groonga original/db dump > dump.grn +<div class="highlight-none"><div class="highlight"><pre><span></span>% groonga original/db dump > dump.grn % mkdir backup % groonga -n backup/db < dump.grn </pre></div> @@ -102,7 +102,7 @@ </div> <div class="section" id="syntax"> <h2>7.3.21.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> -<div class="highlight-none"><div class="highlight"><pre>dump [tables] +<div class="highlight-none"><div class="highlight"><pre><span></span>dump [tables] [dump_plugins] [dump_schema] [dump_records] @@ -113,7 +113,7 @@ <div class="section" id="usage"> <h2>7.3.21.3. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2> <p>Here is the sample schema and data to check dump behaviour:</p> -<div class="highlight-none"><div class="highlight"><pre>plugin_register token_filters/stop_word +<div class="highlight-none"><div class="highlight"><pre><span></span>plugin_register token_filters/stop_word table_create Bookmarks TABLE_HASH_KEY ShortText column_create Bookmarks title COLUMN_SCALAR ShortText table_create Lexicon TABLE_PAT_KEY ShortText @@ -133,7 +133,7 @@ load --table Sites </pre></div> </div> <p>Dump all data in database:</p> -<div class="highlight-none"><div class="highlight"><pre>> dump +<div class="highlight-none"><div class="highlight"><pre><span></span>> dump plugin_register token_filters/stop_word table_create Sites TABLE_NO_KEY @@ -162,7 +162,7 @@ create Lexicon bookmark_title COLUMN_INDEX Bookmarks title </pre></div> </div> <p>Dump schema and specific table data:</p> -<div class="highlight-none"><div class="highlight"><pre>> dump Bookmarks +<div class="highlight-none"><div class="highlight"><pre><span></span>> dump Bookmarks plugin_register token_filters/stop_word table_create Sites TABLE_NO_KEY @@ -184,12 +184,12 @@ column_create Lexicon bookmark_title COLUMN_INDEX Bookmarks title </pre></div> </div> <p>Dump plugin only:</p> -<div class="highlight-none"><div class="highlight"><pre>> dump --dump_schema no --dump_records no --dump_indexes no +<div class="highlight-none"><div class="highlight"><pre><span></span>> dump --dump_schema no --dump_records no --dump_indexes no plugin_register token_filters/stop_word </pre></div> </div> <p>Dump records only:</p> -<div class="highlight-none"><div class="highlight"><pre>> dump --dump_schema no --dump_plugins no --dump_indexes no +<div class="highlight-none"><div class="highlight"><pre><span></span>> dump --dump_schema no --dump_plugins no --dump_indexes no load --table Sites [ ["_id","url"], @@ -206,7 +206,7 @@ load --table Bookmarks </pre></div> </div> <p>Dump schema only:</p> -<div class="highlight-none"><div class="highlight"><pre>> dump --dump_records no --dump_plugins no --dump_indexes no +<div class="highlight-none"><div class="highlight"><pre><span></span>> dump --dump_records no --dump_plugins no --dump_indexes no table_create Sites TABLE_NO_KEY column_create Sites url COLUMN_SCALAR ShortText Modified: docs/reference/commands/io_flush.html (+27 -27) =================================================================== --- docs/reference/commands/io_flush.html 2016-03-05 15:09:34 +0900 (3a8c0cd) +++ docs/reference/commands/io_flush.html 2016-03-17 12:56:59 +0900 (6aeef03) @@ -130,7 +130,7 @@ changes in memory, flushing them to disk is a heavy process.</p> <h2>7.3.22.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> <p>This command takes two parameters.</p> <p>All parameters are optional:</p> -<div class="highlight-none"><div class="highlight"><pre>io_flush [target_name=null] +<div class="highlight-none"><div class="highlight"><pre><span></span>io_flush [target_name=null] [recursive=yes] </pre></div> </div> @@ -139,7 +139,7 @@ changes in memory, flushing them to disk is a heavy process.</p> <h2>7.3.22.3. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2> <p>You can flush all changes in memory to disk with no arguments:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>io_flush +<div class="highlight-none"><div class="highlight"><pre><span></span>io_flush # [[0, 1337566253.89858, 0.000355720520019531], true] </pre></div> </div> @@ -167,19 +167,19 @@ tables of corresponding index columns and corresponding index columns are also flush targets.</p> </td> <td><p class="first">Table and its columns:</p> -<div class="highlight-none"><div class="highlight"><pre>io_flush --target_name TABLE_NAME +<div class="highlight-none"><div class="highlight"><pre><span></span>io_flush --target_name TABLE_NAME </pre></div> </div> <p>A referenced table:</p> -<div class="highlight-none"><div class="highlight"><pre>io_flush --target_name REFERENCED_TABLE_NAME --recursive no +<div class="highlight-none"><div class="highlight"><pre><span></span>io_flush --target_name REFERENCED_TABLE_NAME --recursive no </pre></div> </div> <p>A table of an index column:</p> -<div class="highlight-none"><div class="highlight"><pre>io_flush --target_name TABLE_NAME_OF_INDEX_COLUMN --recursive no +<div class="highlight-none"><div class="highlight"><pre><span></span>io_flush --target_name TABLE_NAME_OF_INDEX_COLUMN --recursive no </pre></div> </div> <p>An index column:</p> -<div class="last highlight-none"><div class="highlight"><pre>io_flush --target_name TABLE_NAME_OF_INDEX_COLUMN.INDEX_COLUMN +<div class="last highlight-none"><div class="highlight"><pre><span></span>io_flush --target_name TABLE_NAME_OF_INDEX_COLUMN.INDEX_COLUMN </pre></div> </div> </td> @@ -194,23 +194,23 @@ columns are also flush targets.</p> <p class="last">Database is also flush target.</p> </td> <td><p class="first">Table and its columns:</p> -<div class="highlight-none"><div class="highlight"><pre>io_flush --target_name TABLE_NAME +<div class="highlight-none"><div class="highlight"><pre><span></span>io_flush --target_name TABLE_NAME </pre></div> </div> <p>A referenced table:</p> -<div class="highlight-none"><div class="highlight"><pre>io_flush --target_name REFERENCED_TABLE_NAME --recursive no +<div class="highlight-none"><div class="highlight"><pre><span></span>io_flush --target_name REFERENCED_TABLE_NAME --recursive no </pre></div> </div> <p>A table of an index column:</p> -<div class="highlight-none"><div class="highlight"><pre>io_flush --target_name TABLE_NAME_OF_INDEX_COLUMN --recursive no +<div class="highlight-none"><div class="highlight"><pre><span></span>io_flush --target_name TABLE_NAME_OF_INDEX_COLUMN --recursive no </pre></div> </div> <p>An index column:</p> -<div class="highlight-none"><div class="highlight"><pre>io_flush --target_name TABLE_NAME_OF_INDEX_COLUMN.INDEX_COLUMN +<div class="highlight-none"><div class="highlight"><pre><span></span>io_flush --target_name TABLE_NAME_OF_INDEX_COLUMN.INDEX_COLUMN </pre></div> </div> <p>Database:</p> -<div class="last highlight-none"><div class="highlight"><pre>io_flush --recursive no +<div class="last highlight-none"><div class="highlight"><pre><span></span>io_flush --recursive no </pre></div> </div> </td> @@ -218,11 +218,11 @@ columns are also flush targets.</p> <tr class="row-even"><td><a class="reference internal" href="table_create.html"><em>table_create</em></a></td> <td>Target table and database.</td> <td><p class="first">Table:</p> -<div class="highlight-none"><div class="highlight"><pre>io_flush --target_name TABLE_NAME +<div class="highlight-none"><div class="highlight"><pre><span></span>io_flush --target_name TABLE_NAME </pre></div> </div> <p>Database:</p> -<div class="last highlight-none"><div class="highlight"><pre>io_flush --recursive no +<div class="last highlight-none"><div class="highlight"><pre><span></span>io_flush --recursive no </pre></div> </div> </td> @@ -230,7 +230,7 @@ columns are also flush targets.</p> <tr class="row-odd"><td><a class="reference internal" href="table_remove.html"><em>table_remove</em></a> and <a class="reference internal" href="table_rename.html"><em>table_rename</em></a></td> <td>Database.</td> <td><p class="first">Database:</p> -<div class="last highlight-none"><div class="highlight"><pre>io_flush --recursive no +<div class="last highlight-none"><div class="highlight"><pre><span></span>io_flush --recursive no </pre></div> </div> </td> @@ -238,11 +238,11 @@ columns are also flush targets.</p> <tr class="row-even"><td><a class="reference internal" href="column_create.html"><em>column_create</em></a></td> <td>Target column and database.</td> <td><p class="first">Table:</p> -<div class="highlight-none"><div class="highlight"><pre>io_flush --target_name TABLE_NAME.COLUMN_NAME +<div class="highlight-none"><div class="highlight"><pre><span></span>io_flush --target_name TABLE_NAME.COLUMN_NAME </pre></div> </div> <p>Database:</p> -<div class="last highlight-none"><div class="highlight"><pre>io_flush --recursive no +<div class="last highlight-none"><div class="highlight"><pre><span></span>io_flush --recursive no </pre></div> </div> </td> @@ -250,7 +250,7 @@ columns are also flush targets.</p> <tr class="row-odd"><td><a class="reference internal" href="column_remove.html"><em>column_remove</em></a> and <a class="reference internal" href="column_rename.html"><em>column_rename</em></a></td> <td>Database.</td> <td><p class="first">Database:</p> -<div class="last highlight-none"><div class="highlight"><pre>io_flush --recursive no +<div class="last highlight-none"><div class="highlight"><pre><span></span>io_flush --recursive no </pre></div> </div> </td> @@ -258,7 +258,7 @@ columns are also flush targets.</p> <tr class="row-even"><td><a class="reference internal" href="plugin_register.html"><em>plugin_register</em></a> and <a class="reference internal" href="plugin_unregister.html"><em>plugin_unregister</em></a></td> <td>Database.</td> <td><p class="first">Database:</p> -<div class="last highlight-none"><div class="highlight"><pre>io_flush --recursive no +<div class="last highlight-none"><div class="highlight"><pre><span></span>io_flush --recursive no </pre></div> </div> </td> @@ -271,7 +271,7 @@ columns are also flush targets.</p> <p>This section describes all parameters.</p> <div class="section" id="required-parameters"> <h3>7.3.22.4.1. Required parameters<a class="headerlink" href="#required-parameters" title="Permalink to this headline">¶</a></h3> -<p>There is no required parameters.</p> +<p>There is no required parameter.</p> </div> <div class="section" id="optional-parameters"> <h3>7.3.22.4.2. Optional parameters<a class="headerlink" href="#optional-parameters" title="Permalink to this headline">¶</a></h3> @@ -282,13 +282,13 @@ columns are also flush targets.</p> database, table or column.</p> <p>If you omit this parameter, database is flush target object:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>io_flush +<div class="highlight-none"><div class="highlight"><pre><span></span>io_flush # [[0, 1337566253.89858, 0.000355720520019531], true] </pre></div> </div> <p>If you specify table name, the table is flush target object:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Users TABLE_HASH_KEY ShortText +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Users TABLE_HASH_KEY ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] io_flush --target_name Users # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -296,7 +296,7 @@ io_flush --target_name Users </div> <p>If you specify column name, the column is flush target object:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>column_create Users age COLUMN_SCALAR UInt8 +<div class="highlight-none"><div class="highlight"><pre><span></span>column_create Users age COLUMN_SCALAR UInt8 # [[0, 1337566253.89858, 0.000355720520019531], true] io_flush --target_name Users.age # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -317,13 +317,13 @@ object is flush target object.</p> <p>The following <code class="docutils literal"><span class="pre">io_flush</span></code> flushes all changes in database, all tables and all columns:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>io_flush --recursive yes +<div class="highlight-none"><div class="highlight"><pre><span></span>io_flush --recursive yes # [[0, 1337566253.89858, 0.000355720520019531], true] </pre></div> </div> <p>The following <code class="docutils literal"><span class="pre">io_flush</span></code> flushes all changes only in database:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>io_flush --recursive no +<div class="highlight-none"><div class="highlight"><pre><span></span>io_flush --recursive no # [[0, 1337566253.89858, 0.000355720520019531], true] </pre></div> </div> @@ -332,14 +332,14 @@ and all columns:</p> <p><code class="docutils literal"><span class="pre">yes</span></code> is used in the following case because invalid <code class="docutils literal"><span class="pre">recursive</span></code> argument is specified:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>io_flush --recursive invalid +<div class="highlight-none"><div class="highlight"><pre><span></span>io_flush --recursive invalid # [[0, 1337566253.89858, 0.000355720520019531], true] </pre></div> </div> <p><code class="docutils literal"><span class="pre">yes</span></code> is used in the following case because <code class="docutils literal"><span class="pre">recursive</span></code> parameter isn't specified:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>io_flush +<div class="highlight-none"><div class="highlight"><pre><span></span>io_flush # [[0, 1337566253.89858, 0.000355720520019531], true] </pre></div> </div> @@ -349,7 +349,7 @@ isn't specified:</p> <div class="section" id="return-value"> <h2>7.3.22.5. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2> <p>The command returns <code class="docutils literal"><span class="pre">true</span></code> as body on success such as:</p> -<div class="highlight-none"><div class="highlight"><pre>[HEADER, true] +<div class="highlight-none"><div class="highlight"><pre><span></span>[HEADER, true] </pre></div> </div> <p>If the command fails, error details are in <code class="docutils literal"><span class="pre">HEADER</span></code>.</p> Modified: docs/reference/commands/load.html (+5 -5) =================================================================== --- docs/reference/commands/load.html 2016-03-05 15:09:34 +0900 (78f4abf) +++ docs/reference/commands/load.html 2016-03-17 12:56:59 +0900 (8f10147) @@ -92,7 +92,7 @@ </div> <div class="section" id="syntax"> <h2>7.3.23.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> -<div class="highlight-none"><div class="highlight"><pre>load values table [columns [ifexists [input_type]]] +<div class="highlight-none"><div class="highlight"><pre><span></span>load values table [columns [ifexists [input_type]]] </pre></div> </div> </div> @@ -110,7 +110,7 @@ If you specify "json" as <code class="docutils literal"><span class="p <dt><code class="docutils literal"><span class="pre">Format</span> <span class="pre">2:</span></code></dt> <dd>[{COLUMN_NAME1: VALUE1, COLUMN_NAME2: VALUE2}, {COLUMN_NAME1: VALUE1, COLUMN_NAME2: VALUE2},..]</dd> </dl> -<p><code class="docutils literal"><span class="pre">[COLUMN_NAME1,</span> <span class="pre">COLUMN_NAME2,..]</span></code> format in <code class="docutils literal"><span class="pre">Format</span> <span class="pre">1</span></code> is effective only when <code class="docutils literal"><span class="pre">column</span></code> parameter isn't specified.</p> +<p><code class="docutils literal"><span class="pre">[COLUMN_NAME1,</span> <span class="pre">COLUMN_NAME2,..]</span></code> format in <code class="docutils literal"><span class="pre">Format</span> <span class="pre">1</span></code> is effective only when <code class="docutils literal"><span class="pre">columns</span></code> parameter isn't specified.</p> <p>When a target table contains primary key, you must specify <code class="docutils literal"><span class="pre">_key</span></code> column (pseudo column associated primary key) as the one of <code class="docutils literal"><span class="pre">COLUMN_NAME</span></code>.</p> <p>If <code class="docutils literal"><span class="pre">values</span></code> isn't specified any values, they are read from the standard input until all opened parenthes match their closed ones. You don't have to enclose them with single-quotes or double-quotes, but if you specified values with <code class="docutils literal"><span class="pre">values</span></code> parameter, you should do.</p> @@ -136,13 +136,13 @@ column) columns is updated.</div></blockquote> <div class="section" id="usage"> <h2>7.3.23.4. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2> <p>Here is an example to add records to "Entry" table.</p> -<div class="highlight-none"><div class="highlight"><pre>load --table Entry --input_type json --values [{\"_key\":\"Groonga\",\"body\":\"It's very fast!!\"}] +<div class="highlight-none"><div class="highlight"><pre><span></span>load --table Entry --input_type json --values [{\"_key\":\"Groonga\",\"body\":\"It's very fast!!\"}] [1] </pre></div> </div> <p>This example shows how to add values from standard input.</p> -<div class="highlight-none"><div class="highlight"><pre>load --table Entry --input_type json +<div class="highlight-none"><div class="highlight"><pre><span></span>load --table Entry --input_type json [ {"_key": "Groonga", "body": "It's very fast!!"} ] @@ -157,7 +157,7 @@ column) columns is updated.</div></blockquote> <h3>7.3.23.5.1. JSON format<a class="headerlink" href="#json-format" title="Permalink to this headline">¶</a></h3> <blockquote> <div><p><code class="docutils literal"><span class="pre">load</span></code> returns the number of added records such as</p> -<div class="highlight-none"><div class="highlight"><pre>[NUMBER] +<div class="highlight-none"><div class="highlight"><pre><span></span>[NUMBER] </pre></div> </div> </div></blockquote> Modified: docs/reference/commands/lock_acquire.html (+6 -6) =================================================================== --- docs/reference/commands/lock_acquire.html 2016-03-05 15:09:34 +0900 (c008d4f) +++ docs/reference/commands/lock_acquire.html 2016-03-17 12:56:59 +0900 (a2433d6) @@ -104,7 +104,7 @@ broken.</p> <div class="section" id="syntax"> <h2>7.3.24.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> <p>This command takes only one optional parameter:</p> -<div class="highlight-none"><div class="highlight"><pre>lock_clear [target_name=null] +<div class="highlight-none"><div class="highlight"><pre><span></span>lock_clear [target_name=null] </pre></div> </div> <p>If <code class="docutils literal"><span class="pre">target_name</span></code> parameters is omitted, database is used for the @@ -114,20 +114,20 @@ target object.</p> <h2>7.3.24.3. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2> <p>Here is an example to acquire the lock of the database:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>lock_acquire +<div class="highlight-none"><div class="highlight"><pre><span></span>lock_acquire # [[0, 1337566253.89858, 0.000355720520019531], true] </pre></div> </div> <p>If the database is locked, you can't create a new table and column. Release the lock of the database to show another examples.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>lock_release +<div class="highlight-none"><div class="highlight"><pre><span></span>lock_release # [[0, 1337566253.89858, 0.000355720520019531], true] </pre></div> </div> <p>Here is an example to acquire the lock of <code class="docutils literal"><span class="pre">Entries</span></code> table:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Entries TABLE_NO_KEY +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Entries TABLE_NO_KEY # [[0, 1337566253.89858, 0.000355720520019531], true] lock_acquire Entries # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -135,7 +135,7 @@ lock_acquire Entries </div> <p>Here is an example to acquire the lock of <code class="docutils literal"><span class="pre">Sites.title</span></code> column:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Sites TABLE_HASH_KEY ShortText +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Sites TABLE_HASH_KEY ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] column_create Sites title COLUMN_SCALAR ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -157,7 +157,7 @@ lock_acquire Sites.title <div class="section" id="return-value"> <h2>7.3.24.5. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2> <p><code class="docutils literal"><span class="pre">lock_acquire</span></code> command returns whether lock is acquired or not:</p> -<div class="highlight-none"><div class="highlight"><pre>[HEADER, SUCCEEDED_OR_NOT] +<div class="highlight-none"><div class="highlight"><pre><span></span>[HEADER, SUCCEEDED_OR_NOT] </pre></div> </div> <div class="section" id="header"> Modified: docs/reference/commands/lock_clear.html (+5 -5) =================================================================== --- docs/reference/commands/lock_clear.html 2016-03-05 15:09:34 +0900 (afbaf2d) +++ docs/reference/commands/lock_clear.html 2016-03-17 12:56:59 +0900 (5d42c00) @@ -104,7 +104,7 @@ process may be crashed.</p> <div class="section" id="syntax"> <h2>7.3.25.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> <p>This command takes only one optional parameter:</p> -<div class="highlight-none"><div class="highlight"><pre>lock_clear [target_name=null] +<div class="highlight-none"><div class="highlight"><pre><span></span>lock_clear [target_name=null] </pre></div> </div> <p>If <code class="docutils literal"><span class="pre">target_name</span></code> parameters is omitted, database is used for the @@ -114,14 +114,14 @@ target object. It means that all locks in the database are cleared.</p> <h2>7.3.25.3. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2> <p>Here is an example to clear all locks in the database:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>lock_clear +<div class="highlight-none"><div class="highlight"><pre><span></span>lock_clear # [[0, 1337566253.89858, 0.000355720520019531], true] </pre></div> </div> <p>Here is an example to clear locks of <code class="docutils literal"><span class="pre">Entries</span></code> table and <code class="docutils literal"><span class="pre">Entries</span></code> table columns:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Entries TABLE_NO_KEY +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Entries TABLE_NO_KEY # [[0, 1337566253.89858, 0.000355720520019531], true] column_create Entries body COLUMN_SCALAR Text # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -131,7 +131,7 @@ lock_clear Entries </div> <p>Here is an example to clear the lock of <code class="docutils literal"><span class="pre">Sites.title</span></code> column:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Sites TABLE_HASH_KEY ShortText +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Sites TABLE_HASH_KEY ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] column_create Sites title COLUMN_SCALAR ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -154,7 +154,7 @@ lock_clear Sites.title <h2>7.3.25.5. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2> <p><code class="docutils literal"><span class="pre">lock_clear</span></code> command returns whether lock is cleared successfully or not:</p> -<div class="highlight-none"><div class="highlight"><pre>[HEADER, SUCCEEDED_OR_NOT] +<div class="highlight-none"><div class="highlight"><pre><span></span>[HEADER, SUCCEEDED_OR_NOT] </pre></div> </div> <p><code class="docutils literal"><span class="pre">HEADER</span></code></p> Modified: docs/reference/commands/lock_release.html (+5 -5) =================================================================== --- docs/reference/commands/lock_release.html 2016-03-05 15:09:34 +0900 (cb63f15) +++ docs/reference/commands/lock_release.html 2016-03-17 12:56:59 +0900 (9aba4fb) @@ -103,7 +103,7 @@ acquire by <a class="reference internal" href="lock_acquire.html"><em>lock_acqui <div class="section" id="syntax"> <h2>7.3.26.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> <p>This command takes only one optional parameter:</p> -<div class="highlight-none"><div class="highlight"><pre>lock_clear [target_name=null] +<div class="highlight-none"><div class="highlight"><pre><span></span>lock_clear [target_name=null] </pre></div> </div> <p>If <code class="docutils literal"><span class="pre">target_name</span></code> parameters is omitted, database is used for the @@ -113,7 +113,7 @@ target object.</p> <h2>7.3.26.3. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2> <p>Here is an example to release the lock of the database:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>lock_acquire +<div class="highlight-none"><div class="highlight"><pre><span></span>lock_acquire # [[0, 1337566253.89858, 0.000355720520019531], true] lock_release # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -121,7 +121,7 @@ lock_release </div> <p>Here is an example to release the lock of <code class="docutils literal"><span class="pre">Entries</span></code> table:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Entries TABLE_NO_KEY +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Entries TABLE_NO_KEY # [[0, 1337566253.89858, 0.000355720520019531], true] lock_acquire Entries # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -131,7 +131,7 @@ lock_release Entries </div> <p>Here is an example to release the lock of <code class="docutils literal"><span class="pre">Sites.title</span></code> column:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Sites TABLE_HASH_KEY ShortText +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Sites TABLE_HASH_KEY ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] column_create Sites title COLUMN_SCALAR ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -156,7 +156,7 @@ lock_release Sites.title <h2>7.3.26.5. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2> <p><code class="docutils literal"><span class="pre">lock_release</span></code> command returns whether lock is released successfully or not:</p> -<div class="highlight-none"><div class="highlight"><pre>[HEADER, SUCCEEDED_OR_NOT] +<div class="highlight-none"><div class="highlight"><pre><span></span>[HEADER, SUCCEEDED_OR_NOT] </pre></div> </div> <div class="section" id="header"> Modified: docs/reference/commands/log_level.html (+3 -3) =================================================================== --- docs/reference/commands/log_level.html 2016-03-05 15:09:34 +0900 (82e4422) +++ docs/reference/commands/log_level.html 2016-03-17 12:56:59 +0900 (89967f5) @@ -94,13 +94,13 @@ </div> <div class="section" id="syntax"> <h2>7.3.27.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> -<div class="highlight-none"><div class="highlight"><pre>log_level level +<div class="highlight-none"><div class="highlight"><pre><span></span>log_level level </pre></div> </div> </div> <div class="section" id="usage"> <h2>7.3.27.3. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2> -<div class="highlight-none"><div class="highlight"><pre>log_level warning +<div class="highlight-none"><div class="highlight"><pre><span></span>log_level warning [true] </pre></div> </div> @@ -123,7 +123,7 @@ debug</div></blockquote> </div> <div class="section" id="return-value"> <h2>7.3.27.5. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2> -<div class="highlight-none"><div class="highlight"><pre>[成功かどうかのフラグ] +<div class="highlight-none"><div class="highlight"><pre><span></span>[成功かどうかのフラグ] </pre></div> </div> <p><code class="docutils literal"><span class="pre">成功かどうかのフラグ</span></code></p> Modified: docs/reference/commands/log_put.html (+3 -3) =================================================================== --- docs/reference/commands/log_put.html 2016-03-05 15:09:34 +0900 (948e491) +++ docs/reference/commands/log_put.html 2016-03-17 12:56:59 +0900 (91229c5) @@ -94,13 +94,13 @@ </div> <div class="section" id="syntax"> <h2>7.3.28.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> -<div class="highlight-none"><div class="highlight"><pre>log_put level message +<div class="highlight-none"><div class="highlight"><pre><span></span>log_put level message </pre></div> </div> </div> <div class="section" id="usage"> <h2>7.3.28.3. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2> -<div class="highlight-none"><div class="highlight"><pre>log_put ERROR ****MESSAGE**** +<div class="highlight-none"><div class="highlight"><pre><span></span>log_put ERROR ****MESSAGE**** [true] </pre></div> </div> @@ -126,7 +126,7 @@ debug</div></blockquote> </div> <div class="section" id="return-value"> <h2>7.3.28.5. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2> -<div class="highlight-none"><div class="highlight"><pre>[成功かどうかのフラグ] +<div class="highlight-none"><div class="highlight"><pre><span></span>[成功かどうかのフラグ] </pre></div> </div> <p><code class="docutils literal"><span class="pre">成功かどうかのフラグ</span></code></p> Modified: docs/reference/commands/log_reopen.html (+3 -3) =================================================================== --- docs/reference/commands/log_reopen.html 2016-03-05 15:09:34 +0900 (d31d53c) +++ docs/reference/commands/log_reopen.html 2016-03-17 12:56:59 +0900 (cbf6af0) @@ -95,13 +95,13 @@ </div> <div class="section" id="syntax"> <h2>7.3.29.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> -<div class="highlight-none"><div class="highlight"><pre>log_reopen +<div class="highlight-none"><div class="highlight"><pre><span></span>log_reopen </pre></div> </div> </div> <div class="section" id="usage"> <h2>7.3.29.3. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2> -<div class="highlight-none"><div class="highlight"><pre>log_reopen +<div class="highlight-none"><div class="highlight"><pre><span></span>log_reopen [true] </pre></div> @@ -123,7 +123,7 @@ </div> <div class="section" id="return-value"> <h2>7.3.29.5. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2> -<div class="highlight-none"><div class="highlight"><pre>[成功かどうかのフラグ] +<div class="highlight-none"><div class="highlight"><pre><span></span>[成功かどうかのフラグ] </pre></div> </div> <p><code class="docutils literal"><span class="pre">成功かどうかのフラグ</span></code></p> Modified: docs/reference/commands/logical_count.html (+16 -16) =================================================================== --- docs/reference/commands/logical_count.html 2016-03-05 15:09:34 +0900 (62f33bb) +++ docs/reference/commands/logical_count.html 2016-03-17 12:56:59 +0900 (9cc7df9) @@ -25,9 +25,9 @@ <script type="text/javascript" src="../../static/doctools.js"></script> <link rel="shortcut icon" href="../../static/favicon.ico"/> <link rel="top" title="Groonga v6.0.0 documentation" href="../../index.html" /> - <link rel="up" title="7.20. Sharding" href="../sharding.html" /> + <link rel="up" title="7.3. Command" href="../command.html" /> <link rel="next" title="7.3.31. logical_parameters" href="logical_parameters.html" /> - <link rel="prev" title="7.20. Sharding" href="../sharding.html" /> + <link rel="prev" title="7.3.29. log_reopen" href="log_reopen.html" /> <meta property="fb:page_id" content="201193596592346" /><!-- groonga --> <meta property="fb:admins" content="664204556" /><!-- kouhei.sutou --> <meta property="og:type" content="product" /> @@ -71,11 +71,11 @@ <a href="logical_parameters.html" title="7.3.31. logical_parameters" accesskey="N">next</a> |</li> <li class="right" > - <a href="../sharding.html" title="7.20. Sharding" + <a href="log_reopen.html" title="7.3.29. log_reopen" accesskey="P">previous</a> |</li> <li class="nav-item nav-item-0"><a href="../../index.html">Groonga v6.0.0 documentation</a> »</li> <li class="nav-item nav-item-1"><a href="../../reference.html" >7. Reference manual</a> »</li> - <li class="nav-item nav-item-2"><a href="../sharding.html" accesskey="U">7.20. Sharding</a> »</li> + <li class="nav-item nav-item-2"><a href="../command.html" accesskey="U">7.3. Command</a> »</li> </ul> </div> @@ -106,7 +106,7 @@ <h2>7.3.30.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> <p>This command takes many parameters.</p> <p>The required parameters are <code class="docutils literal"><span class="pre">logical_table</span></code> and <code class="docutils literal"><span class="pre">shard_key</span></code>:</p> -<div class="highlight-none"><div class="highlight"><pre>logical_count logical_table +<div class="highlight-none"><div class="highlight"><pre><span></span>logical_count logical_table shard_key [min] [min_border] @@ -123,7 +123,7 @@ <p>Here is the simple example which shows how to use this feature. Let's consider to count specified logs which are stored into multiple tables.</p> <p>Here is the schema and data.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Logs_20150203 TABLE_NO_KEY +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Logs_20150203 TABLE_NO_KEY # [[0, 1337566253.89858, 0.000355720520019531], true] column_create Logs_20150203 timestamp COLUMN_SCALAR Time # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -144,7 +144,7 @@ column_create Logs_20150205 message COLUMN_SCALAR Text </pre></div> </div> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>load --table Logs_20150203 +<div class="highlight-none"><div class="highlight"><pre><span></span>load --table Logs_20150203 [ {"timestamp": "2015-02-03 23:59:58", "message": "Start"}, {"timestamp": "2015-02-03 23:59:58", "message": "Shutdown"}, @@ -182,7 +182,7 @@ load --table Logs_20150205 <p>Let's count logs which contains "Shutdown" in <code class="docutils literal"><span class="pre">message</span></code> column and the value of timestamp is "2015-02-04 00:00:00" or later.</p> <p>Here is the query to achieve above purpose.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>logical_count Logs timestamp --filter 'message == "Shutdown"' --min "2015-02-04 00:00:00" --min_border "include" +<div class="highlight-none"><div class="highlight"><pre><span></span>logical_count Logs timestamp --filter 'message == "Shutdown"' --min "2015-02-04 00:00:00" --min_border "include" # [[0, 1337566253.89858, 0.000355720520019531], 5] </pre></div> </div> @@ -195,8 +195,8 @@ load --table Logs_20150205 <div class="section" id="parameters"> <h2>7.3.30.4. Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></h2> <p>This section describes parameters of <code class="docutils literal"><span class="pre">logical_count</span></code>.</p> -<div class="section" id="required-parameter"> -<h3>7.3.30.4.1. Required parameter<a class="headerlink" href="#required-parameter" title="Permalink to this headline">¶</a></h3> +<div class="section" id="required-parameters"> +<h3>7.3.30.4.1. Required parameters<a class="headerlink" href="#required-parameters" title="Permalink to this headline">¶</a></h3> <p>There are required parameters, <code class="docutils literal"><span class="pre">logical_table</span></code> and <code class="docutils literal"><span class="pre">shard_key</span></code>.</p> <div class="section" id="logical-table"> <h4>7.3.30.4.1.1. <code class="docutils literal"><span class="pre">logical_table</span></code><a class="headerlink" href="#logical-table" title="Permalink to this headline">¶</a></h4> @@ -237,7 +237,7 @@ Specify <code class="docutils literal"><span class="pre">include</span></code> o <div class="section" id="return-value"> <h2>7.3.30.5. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2> <p>TODO</p> -<div class="highlight-none"><div class="highlight"><pre>[HEADER, LOGICAL_COUNT] +<div class="highlight-none"><div class="highlight"><pre><span></span>[HEADER, LOGICAL_COUNT] </pre></div> </div> </div> @@ -256,7 +256,7 @@ Specify <code class="docutils literal"><span class="pre">include</span></code> o <li><a class="reference internal" href="#syntax">7.3.30.2. Syntax</a></li> <li><a class="reference internal" href="#usage">7.3.30.3. Usage</a></li> <li><a class="reference internal" href="#parameters">7.3.30.4. Parameters</a><ul> -<li><a class="reference internal" href="#required-parameter">7.3.30.4.1. Required parameter</a><ul> +<li><a class="reference internal" href="#required-parameters">7.3.30.4.1. Required parameters</a><ul> <li><a class="reference internal" href="#logical-table">7.3.30.4.1.1. <code class="docutils literal"><span class="pre">logical_table</span></code></a></li> <li><a class="reference internal" href="#shard-key">7.3.30.4.1.2. <code class="docutils literal"><span class="pre">shard_key</span></code></a></li> </ul> @@ -277,8 +277,8 @@ Specify <code class="docutils literal"><span class="pre">include</span></code> o </ul> <h4>Previous topic</h4> - <p class="topless"><a href="../sharding.html" - title="previous chapter">7.20. Sharding</a></p> + <p class="topless"><a href="log_reopen.html" + title="previous chapter">7.3.29. <code class="docutils literal"><span class="pre">log_reopen</span></code></a></p> <h4>Next topic</h4> <p class="topless"><a href="logical_parameters.html" title="next chapter">7.3.31. <code class="docutils literal"><span class="pre">logical_parameters</span></code></a></p> @@ -316,11 +316,11 @@ Specify <code class="docutils literal"><span class="pre">include</span></code> o <a href="logical_parameters.html" title="7.3.31. logical_parameters" >next</a> |</li> <li class="right" > - <a href="../sharding.html" title="7.20. Sharding" + <a href="log_reopen.html" title="7.3.29. log_reopen" >previous</a> |</li> <li class="nav-item nav-item-0"><a href="../../index.html">Groonga v6.0.0 documentation</a> »</li> <li class="nav-item nav-item-1"><a href="../../reference.html" >7. Reference manual</a> »</li> - <li class="nav-item nav-item-2"><a href="../sharding.html" >7.20. Sharding</a> »</li> + <li class="nav-item nav-item-2"><a href="../command.html" >7.3. Command</a> »</li> </ul> </div> <div class="footer" role="contentinfo"> Modified: docs/reference/commands/logical_parameters.html (+12 -12) =================================================================== --- docs/reference/commands/logical_parameters.html 2016-03-05 15:09:34 +0900 (65f98a8) +++ docs/reference/commands/logical_parameters.html 2016-03-17 12:56:59 +0900 (854c512) @@ -25,7 +25,7 @@ <script type="text/javascript" src="../../static/doctools.js"></script> <link rel="shortcut icon" href="../../static/favicon.ico"/> <link rel="top" title="Groonga v6.0.0 documentation" href="../../index.html" /> - <link rel="up" title="7.20. Sharding" href="../sharding.html" /> + <link rel="up" title="7.3. Command" href="../command.html" /> <link rel="next" title="7.3.32. logical_range_filter" href="logical_range_filter.html" /> <link rel="prev" title="7.3.30. logical_count" href="logical_count.html" /> <meta property="fb:page_id" content="201193596592346" /><!-- groonga --> @@ -75,7 +75,7 @@ accesskey="P">previous</a> |</li> <li class="nav-item nav-item-0"><a href="../../index.html">Groonga v6.0.0 documentation</a> »</li> <li class="nav-item nav-item-1"><a href="../../reference.html" >7. Reference manual</a> »</li> - <li class="nav-item nav-item-2"><a href="../sharding.html" accesskey="U">7.20. Sharding</a> »</li> + <li class="nav-item nav-item-2"><a href="../command.html" accesskey="U">7.3. Command</a> »</li> </ul> </div> @@ -122,7 +122,7 @@ parameters.</p> <div class="section" id="syntax"> <h2>7.3.31.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> <p>This command takes only one optional parameter:</p> -<div class="highlight-none"><div class="highlight"><pre>logical_parameters [range_index=null] +<div class="highlight-none"><div class="highlight"><pre><span></span>logical_parameters [range_index=null] </pre></div> </div> </div> @@ -130,20 +130,20 @@ parameters.</p> <h2>7.3.31.3. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2> <p>You need to register <code class="docutils literal"><span class="pre">sharding</span></code> plugin to use this command:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>plugin_register sharding +<div class="highlight-none"><div class="highlight"><pre><span></span>plugin_register sharding # [[0, 1337566253.89858, 0.000355720520019531], true] </pre></div> </div> <p>You can get the all current parameter values by calling without parameters:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>logical_parameters +<div class="highlight-none"><div class="highlight"><pre><span></span>logical_parameters # [[0, 1337566253.89858, 0.000355720520019531], {"range_index": "auto"}] </pre></div> </div> <p>You can set new values by calling with parameters:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>logical_parameters --range_index never +<div class="highlight-none"><div class="highlight"><pre><span></span>logical_parameters --range_index never # [[0, 1337566253.89858, 0.000355720520019531], {"range_index": "auto"}] </pre></div> </div> @@ -155,7 +155,7 @@ are set when you set new values.</p> <p>This section describes parameters.</p> <div class="section" id="required-parameters"> <h3>7.3.31.4.1. Required parameters<a class="headerlink" href="#required-parameters" title="Permalink to this headline">¶</a></h3> -<p>There is no required parameters.</p> +<p>There is no required parameter.</p> </div> <div class="section" id="optional-parameters"> <h3>7.3.31.4.2. Optional parameters<a class="headerlink" href="#optional-parameters" title="Permalink to this headline">¶</a></h3> @@ -175,21 +175,21 @@ keyword.</p> <p>If <code class="docutils literal"><span class="pre">auto</span></code> is specified, range index is used only when it'll be efficient. This is the default value.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>logical_parameters --range_index auto +<div class="highlight-none"><div class="highlight"><pre><span></span>logical_parameters --range_index auto # [[0, 1337566253.89858, 0.000355720520019531], {"range_index": "never"}] </pre></div> </div> <p>If <code class="docutils literal"><span class="pre">always</span></code> is specified, range index is always used. It'll be useful for testing a case that range index is used.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>logical_parameters --range_index always +<div class="highlight-none"><div class="highlight"><pre><span></span>logical_parameters --range_index always # [[0, 1337566253.89858, 0.000355720520019531], {"range_index": "auto"}] </pre></div> </div> <p>If <code class="docutils literal"><span class="pre">never</span></code> is specified, range index is never used. It'll be useful for testing a case that range index isn't used.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>logical_parameters --range_index never +<div class="highlight-none"><div class="highlight"><pre><span></span>logical_parameters --range_index never # [[0, 1337566253.89858, 0.000355720520019531], {"range_index": "always"}] </pre></div> </div> @@ -199,7 +199,7 @@ for testing a case that range index isn't used.</p> <div class="section" id="return-value"> <h2>7.3.31.5. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2> <p>The command returns the current parameters for <code class="docutils literal"><span class="pre">logical_*</span></code> command:</p> -<div class="highlight-none"><div class="highlight"><pre>[ +<div class="highlight-none"><div class="highlight"><pre><span></span>[ HEADER, {"range_index": HOW_TO_USE_RANGE_INDEX} ] @@ -286,7 +286,7 @@ for testing a case that range index isn't used.</p> >previous</a> |</li> <li class="nav-item nav-item-0"><a href="../../index.html">Groonga v6.0.0 documentation</a> »</li> <li class="nav-item nav-item-1"><a href="../../reference.html" >7. Reference manual</a> »</li> - <li class="nav-item nav-item-2"><a href="../sharding.html" >7.20. Sharding</a> »</li> + <li class="nav-item nav-item-2"><a href="../command.html" >7.3. Command</a> »</li> </ul> </div> <div class="footer" role="contentinfo"> Modified: docs/reference/commands/logical_range_filter.html (+8 -8) =================================================================== --- docs/reference/commands/logical_range_filter.html 2016-03-05 15:09:34 +0900 (5a7bfc9) +++ docs/reference/commands/logical_range_filter.html 2016-03-17 12:56:59 +0900 (92005f0) @@ -25,7 +25,7 @@ <script type="text/javascript" src="../../static/doctools.js"></script> <link rel="shortcut icon" href="../../static/favicon.ico"/> <link rel="top" title="Groonga v6.0.0 documentation" href="../../index.html" /> - <link rel="up" title="7.20. Sharding" href="../sharding.html" /> + <link rel="up" title="7.3. Command" href="../command.html" /> <link rel="next" title="7.3.33. logical_select" href="logical_select.html" /> <link rel="prev" title="7.3.31. logical_parameters" href="logical_parameters.html" /> <meta property="fb:page_id" content="201193596592346" /><!-- groonga --> @@ -75,7 +75,7 @@ accesskey="P">previous</a> |</li> <li class="nav-item nav-item-0"><a href="../../index.html">Groonga v6.0.0 documentation</a> »</li> <li class="nav-item nav-item-1"><a href="../../reference.html" >7. Reference manual</a> »</li> - <li class="nav-item nav-item-2"><a href="../sharding.html" accesskey="U">7.20. Sharding</a> »</li> + <li class="nav-item nav-item-2"><a href="../command.html" accesskey="U">7.3. Command</a> »</li> </ul> </div> @@ -101,7 +101,7 @@ <h2>7.3.32.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> <p>This command takes many parameters.</p> <p>The required parameters are <code class="docutils literal"><span class="pre">logical_table</span></code> and <code class="docutils literal"><span class="pre">shard_key</span></code>:</p> -<div class="highlight-none"><div class="highlight"><pre>logical_range_filter +<div class="highlight-none"><div class="highlight"><pre><span></span>logical_range_filter logical_table shard_key [min=null] @@ -134,8 +134,8 @@ must specify parameter name.</p> <div class="section" id="parameters"> <h2>7.3.32.4. Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></h2> <p>This section describes parameters of <code class="docutils literal"><span class="pre">logical_range_filter</span></code>.</p> -<div class="section" id="required-parameter"> -<h3>7.3.32.4.1. Required parameter<a class="headerlink" href="#required-parameter" title="Permalink to this headline">¶</a></h3> +<div class="section" id="required-parameters"> +<h3>7.3.32.4.1. Required parameters<a class="headerlink" href="#required-parameters" title="Permalink to this headline">¶</a></h3> <p>There are required parameters, <code class="docutils literal"><span class="pre">logical_table</span></code> and <code class="docutils literal"><span class="pre">shard_key</span></code>.</p> <div class="section" id="logical-table"> <h4>7.3.32.4.1.1. <code class="docutils literal"><span class="pre">logical_table</span></code><a class="headerlink" href="#logical-table" title="Permalink to this headline">¶</a></h4> @@ -238,7 +238,7 @@ It's the default value.</td> <div class="section" id="return-value"> <h2>7.3.32.5. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2> <p>TODO</p> -<div class="highlight-none"><div class="highlight"><pre>[HEADER, LOGICAL_FILTERED] +<div class="highlight-none"><div class="highlight"><pre><span></span>[HEADER, LOGICAL_FILTERED] </pre></div> </div> </div> @@ -257,7 +257,7 @@ It's the default value.</td> <li><a class="reference internal" href="#syntax">7.3.32.2. Syntax</a></li> <li><a class="reference internal" href="#usage">7.3.32.3. Usage</a></li> <li><a class="reference internal" href="#parameters">7.3.32.4. Parameters</a><ul> -<li><a class="reference internal" href="#required-parameter">7.3.32.4.1. Required parameter</a><ul> +<li><a class="reference internal" href="#required-parameters">7.3.32.4.1. Required parameters</a><ul> <li><a class="reference internal" href="#logical-table">7.3.32.4.1.1. <code class="docutils literal"><span class="pre">logical_table</span></code></a></li> <li><a class="reference internal" href="#shard-key">7.3.32.4.1.2. <code class="docutils literal"><span class="pre">shard_key</span></code></a></li> </ul> @@ -330,7 +330,7 @@ It's the default value.</td> >previous</a> |</li> <li class="nav-item nav-item-0"><a href="../../index.html">Groonga v6.0.0 documentation</a> »</li> <li class="nav-item nav-item-1"><a href="../../reference.html" >7. Reference manual</a> »</li> - <li class="nav-item nav-item-2"><a href="../sharding.html" >7.20. Sharding</a> »</li> + <li class="nav-item nav-item-2"><a href="../command.html" >7.3. Command</a> »</li> </ul> </div> <div class="footer" role="contentinfo"> Modified: docs/reference/commands/logical_select.html (+32 -32) =================================================================== --- docs/reference/commands/logical_select.html 2016-03-05 15:09:34 +0900 (c14c767) +++ docs/reference/commands/logical_select.html 2016-03-17 12:56:59 +0900 (f06716f) @@ -25,7 +25,7 @@ <script type="text/javascript" src="../../static/doctools.js"></script> <link rel="shortcut icon" href="../../static/favicon.ico"/> <link rel="top" title="Groonga v6.0.0 documentation" href="../../index.html" /> - <link rel="up" title="7.20. Sharding" href="../sharding.html" /> + <link rel="up" title="7.3. Command" href="../command.html" /> <link rel="next" title="7.3.34. logical_shard_list" href="logical_shard_list.html" /> <link rel="prev" title="7.3.32. logical_range_filter" href="logical_range_filter.html" /> <meta property="fb:page_id" content="201193596592346" /><!-- groonga --> @@ -75,7 +75,7 @@ accesskey="P">previous</a> |</li> <li class="nav-item nav-item-0"><a href="../../index.html">Groonga v6.0.0 documentation</a> »</li> <li class="nav-item nav-item-1"><a href="../../reference.html" >7. Reference manual</a> »</li> - <li class="nav-item nav-item-2"><a href="../sharding.html" accesskey="U">7.20. Sharding</a> »</li> + <li class="nav-item nav-item-2"><a href="../command.html" accesskey="U">7.3. Command</a> »</li> </ul> </div> @@ -106,7 +106,7 @@ tables and outputs them.</p> <p>This command takes many parameters.</p> <p>The required parameters are <code class="docutils literal"><span class="pre">logical_table</span></code> and <code class="docutils literal"><span class="pre">shard_key</span></code>. Other parameters are optional:</p> -<div class="highlight-none"><div class="highlight"><pre>logical_select logical_table +<div class="highlight-none"><div class="highlight"><pre><span></span>logical_select logical_table shard_key [min=null] [min_border="include"] @@ -190,13 +190,13 @@ shows many popular usages.</p> <p>You need to register <code class="docutils literal"><span class="pre">sharding</span></code> plugin because <code class="docutils literal"><span class="pre">logical_select</span></code> is included in <code class="docutils literal"><span class="pre">sharding</span></code> plugin.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>plugin_register sharding +<div class="highlight-none"><div class="highlight"><pre><span></span>plugin_register sharding # [[0, 1337566253.89858, 0.000355720520019531], true] </pre></div> </div> <p>Here are a schema definition and sample data to show usage.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Entries_20150708 TABLE_HASH_KEY ShortText +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Entries_20150708 TABLE_HASH_KEY ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] column_create Entries_20150708 created_at COLUMN_SCALAR Time # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -294,8 +294,8 @@ fulltext search ready.</p> <div class="section" id="parameters"> <h2>7.3.33.5. Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></h2> <p>This section describes parameters of <code class="docutils literal"><span class="pre">logical_select</span></code>.</p> -<div class="section" id="required-parameter"> -<h3>7.3.33.5.1. Required parameter<a class="headerlink" href="#required-parameter" title="Permalink to this headline">¶</a></h3> +<div class="section" id="required-parameters"> +<h3>7.3.33.5.1. Required parameters<a class="headerlink" href="#required-parameters" title="Permalink to this headline">¶</a></h3> <p>There are required parameters, <code class="docutils literal"><span class="pre">logical_table</span></code> and <code class="docutils literal"><span class="pre">shard_key</span></code>.</p> <div class="section" id="logical-table"> <span id="logical-select-logical-table"></span><h4>7.3.33.5.1.1. <code class="docutils literal"><span class="pre">logical_table</span></code><a class="headerlink" href="#logical-table" title="Permalink to this headline">¶</a></h4> @@ -306,7 +306,7 @@ name is <code class="docutils literal"><span class="pre">Entries</span></code>.< <p>You can show 10 records by specifying <code class="docutils literal"><span class="pre">logical_table</span></code> and <code class="docutils literal"><span class="pre">shard_key</span></code> parameters. They are required parameters.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>logical_select --logical_table Entries --shard_key created_at +<div class="highlight-none"><div class="highlight"><pre><span></span>logical_select --logical_table Entries --shard_key created_at # [ # [ # 0, @@ -391,7 +391,7 @@ name is <code class="docutils literal"><span class="pre">Entries</span></code>.< </div> <p>If nonexistent table is specified, an error is returned.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>logical_select --logical_table Nonexistent --shard_key created_at +<div class="highlight-none"><div class="highlight"><pre><span></span>logical_select --logical_table Nonexistent --shard_key created_at # [ # [ # -22, @@ -432,7 +432,7 @@ isn't searched. Because <code class="docutils literal"><span class="pre">Entry_2 <p>The following example only uses <code class="docutils literal"><span class="pre">Entry_20150709</span></code> table. <code class="docutils literal"><span class="pre">Entry_20150708</span></code> isn't used.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>logical_select \ +<div class="highlight-none"><div class="highlight"><pre><span></span>logical_select \ --logical_table Entries \ --shard_key created_at \ --min "2015/07/09 00:00:00" @@ -522,7 +522,7 @@ available values.</p> <code class="docutils literal"><span class="pre">"Good-bye</span> <span class="pre">Senna"</span></code> record because its <code class="docutils literal"><span class="pre">created_at</span></code> value is <code class="docutils literal"><span class="pre">"2015/07/09</span> <span class="pre">00:00:00"</span></code>.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>logical_select \ +<div class="highlight-none"><div class="highlight"><pre><span></span>logical_select \ --logical_table Entries \ --shard_key created_at \ --min "2015/07/09 00:00:00" \ @@ -588,7 +588,7 @@ isn't searched. Because <code class="docutils literal"><span class="pre">Entry_2 <p>The following example only uses <code class="docutils literal"><span class="pre">Entry_20150708</span></code> table. <code class="docutils literal"><span class="pre">Entry_20150709</span></code> isn't used.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>logical_select \ +<div class="highlight-none"><div class="highlight"><pre><span></span>logical_select \ --logical_table Entries \ --shard_key created_at \ --max "2015/07/08 23:59:59" @@ -686,7 +686,7 @@ available values.</p> <code class="docutils literal"><span class="pre">"Good-bye</span> <span class="pre">Senna"</span></code> record because its <code class="docutils literal"><span class="pre">created_at</span></code> value is <code class="docutils literal"><span class="pre">"2015/07/09</span> <span class="pre">00:00:00"</span></code>.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>logical_select \ +<div class="highlight-none"><div class="highlight"><pre><span></span>logical_select \ --logical_table Entries \ --shard_key created_at \ --max "2015/07/09 00:00:00" \ @@ -779,7 +779,7 @@ only supported for now.</p> <a class="reference internal" href="select.html#select-filter"><span>filter</span></a> for details.</p> <p>Here is an example:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>logical_select \ +<div class="highlight-none"><div class="highlight"><pre><span></span>logical_select \ --logical_table Entries \ --shard_key created_at \ --filter "n_likes <= 5" @@ -875,7 +875,7 @@ only supported for now.</p> <a class="reference internal" href="select.html#select-output-columns"><span>output_columns</span></a> for details.</p> <p>Here is an example:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>logical_select \ +<div class="highlight-none"><div class="highlight"><pre><span></span>logical_select \ --logical_table Entries \ --shard_key created_at \ --output_columns '_key, *' @@ -962,7 +962,7 @@ target shards is one. If the number of search target shards is larger than one, <code class="docutils literal"><span class="pre">sortby</span></code> doesn't work.</p> <p>Here is an example that uses only one shard:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>logical_select \ +<div class="highlight-none"><div class="highlight"><pre><span></span>logical_select \ --logical_table Entries \ --shard_key created_at \ --min "2015/07/08 00:00:00" \ @@ -1043,7 +1043,7 @@ than one, <code class="docutils literal"><span class="pre">sortby</span></code> <a class="reference internal" href="select.html#select-offset"><span>offset</span></a> for details.</p> <p>Here is an example:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>logical_select \ +<div class="highlight-none"><div class="highlight"><pre><span></span>logical_select \ --logical_table Entries \ --shard_key created_at \ --offset 2 @@ -1120,7 +1120,7 @@ than one, <code class="docutils literal"><span class="pre">sortby</span></code> <a class="reference internal" href="select.html#select-limit"><span>limit</span></a> for details.</p> <p>Here is an example:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>logical_select \ +<div class="highlight-none"><div class="highlight"><pre><span></span>logical_select \ --logical_table Entries \ --shard_key created_at \ --limit 2 @@ -1198,7 +1198,7 @@ than one, <code class="docutils literal"><span class="pre">sortby</span></code> <a class="reference internal" href="select.html#select-drilldown"><span>drilldown</span></a> for details.</p> <p>Here is an example:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>logical_select \ +<div class="highlight-none"><div class="highlight"><pre><span></span>logical_select \ --logical_table Entries \ --shard_key created_at \ --output_columns _key,tag \ @@ -1283,7 +1283,7 @@ than one, <code class="docutils literal"><span class="pre">sortby</span></code> <a class="reference internal" href="select.html#select-drilldown-sortby"><span>drilldown_sortby</span></a> for details.</p> <p>Here is an example:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>logical_select \ +<div class="highlight-none"><div class="highlight"><pre><span></span>logical_select \ --logical_table Entries \ --shard_key created_at \ --limit 0 \ @@ -1346,7 +1346,7 @@ than one, <code class="docutils literal"><span class="pre">sortby</span></code> <a class="reference internal" href="select.html"><em>select</em></a>. See <a class="reference internal" href="select.html#select-drilldown-output-columns"><span>drilldown_output_columns</span></a> for details.</p> <p>Here is an example:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>logical_select \ +<div class="highlight-none"><div class="highlight"><pre><span></span>logical_select \ --logical_table Entries \ --shard_key created_at \ --limit 0 \ @@ -1402,7 +1402,7 @@ than one, <code class="docutils literal"><span class="pre">sortby</span></code> <a class="reference internal" href="select.html#select-drilldown-offset"><span>drilldown_offset</span></a> for details.</p> <p>Here is an example:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>logical_select \ +<div class="highlight-none"><div class="highlight"><pre><span></span>logical_select \ --logical_table Entries \ --shard_key created_at \ --limit 0 \ @@ -1461,7 +1461,7 @@ than one, <code class="docutils literal"><span class="pre">sortby</span></code> <a class="reference internal" href="select.html#select-drilldown-limit"><span>drilldown_limit</span></a> for details.</p> <p>Here is an example:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>logical_select \ +<div class="highlight-none"><div class="highlight"><pre><span></span>logical_select \ --logical_table Entries \ --shard_key created_at \ --limit 0 \ @@ -1520,7 +1520,7 @@ than one, <code class="docutils literal"><span class="pre">sortby</span></code> <a class="reference internal" href="select.html"><em>select</em></a>. See <a class="reference internal" href="select.html#select-drilldown-calc-types"><span>drilldown_calc_types</span></a> for details.</p> <p>Here is an example:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>logical_select \ +<div class="highlight-none"><div class="highlight"><pre><span></span>logical_select \ --logical_table Entries \ --shard_key created_at \ --limit -1 \ @@ -1657,7 +1657,7 @@ work with multiple shards. It works with one shard. <code class="docutils litera <a class="reference internal" href="select.html"><em>select</em></a>. See <a class="reference internal" href="select.html#select-drilldown-label-keys"><span>drilldown[${LABEL}].keys</span></a> for details.</p> <p>Here is an example:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>logical_select \ +<div class="highlight-none"><div class="highlight"><pre><span></span>logical_select \ --logical_table Entries \ --shard_key created_at \ --limit 0 \ @@ -1735,7 +1735,7 @@ work with multiple shards. It works with one shard. <code class="docutils litera details.</p> <p>Here is an example:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>logical_select \ +<div class="highlight-none"><div class="highlight"><pre><span></span>logical_select \ --logical_table Entries \ --shard_key created_at \ --limit 0 \ @@ -1805,7 +1805,7 @@ with multiple shards. It works with one shard. <code class="docutils literal"><s <p>Here is an example that uses <code class="docutils literal"><span class="pre">_value.${KEY_NAME}</span></code> with only one shard:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>logical_select \ +<div class="highlight-none"><div class="highlight"><pre><span></span>logical_select \ --logical_table Entries \ --shard_key created_at \ --min "2015/07/08 00:00:00" \ @@ -1882,7 +1882,7 @@ shard:</p> drilldown.</p> <p>Here is an example:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>logical_select \ +<div class="highlight-none"><div class="highlight"><pre><span></span>logical_select \ --logical_table Entries \ --shard_key created_at \ --limit 0 \ @@ -1943,7 +1943,7 @@ drilldown.</p> drilldown.</p> <p>Here is an example:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>logical_select \ +<div class="highlight-none"><div class="highlight"><pre><span></span>logical_select \ --logical_table Entries \ --shard_key created_at \ --limit 0 \ @@ -2004,7 +2004,7 @@ drilldown.</p> labeled drilldown.</p> <p>Here is an example:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>logical_select \ +<div class="highlight-none"><div class="highlight"><pre><span></span>logical_select \ --logical_table Entries \ --shard_key created_at \ --limit 0 \ @@ -2126,7 +2126,7 @@ for an example.</p> </ul> </li> <li><a class="reference internal" href="#parameters">7.3.33.5. Parameters</a><ul> -<li><a class="reference internal" href="#required-parameter">7.3.33.5.1. Required parameter</a><ul> +<li><a class="reference internal" href="#required-parameters">7.3.33.5.1. Required parameters</a><ul> <li><a class="reference internal" href="#logical-table">7.3.33.5.1.1. <code class="docutils literal"><span class="pre">logical_table</span></code></a></li> <li><a class="reference internal" href="#shard-key">7.3.33.5.1.2. <code class="docutils literal"><span class="pre">shard_key</span></code></a></li> </ul> @@ -2229,7 +2229,7 @@ for an example.</p> >previous</a> |</li> <li class="nav-item nav-item-0"><a href="../../index.html">Groonga v6.0.0 documentation</a> »</li> <li class="nav-item nav-item-1"><a href="../../reference.html" >7. Reference manual</a> »</li> - <li class="nav-item nav-item-2"><a href="../sharding.html" >7.20. Sharding</a> »</li> + <li class="nav-item nav-item-2"><a href="../command.html" >7.3. Command</a> »</li> </ul> </div> <div class="footer" role="contentinfo"> Modified: docs/reference/commands/logical_shard_list.html (+10 -10) =================================================================== --- docs/reference/commands/logical_shard_list.html 2016-03-05 15:09:34 +0900 (4c30d6a) +++ docs/reference/commands/logical_shard_list.html 2016-03-17 12:56:59 +0900 (ebaf32d) @@ -25,7 +25,7 @@ <script type="text/javascript" src="../../static/doctools.js"></script> <link rel="shortcut icon" href="../../static/favicon.ico"/> <link rel="top" title="Groonga v6.0.0 documentation" href="../../index.html" /> - <link rel="up" title="7.20. Sharding" href="../sharding.html" /> + <link rel="up" title="7.3. Command" href="../command.html" /> <link rel="next" title="7.3.35. logical_table_remove" href="logical_table_remove.html" /> <link rel="prev" title="7.3.33. logical_select" href="logical_select.html" /> <meta property="fb:page_id" content="201193596592346" /><!-- groonga --> @@ -75,7 +75,7 @@ accesskey="P">previous</a> |</li> <li class="nav-item nav-item-0"><a href="../../index.html">Groonga v6.0.0 documentation</a> »</li> <li class="nav-item nav-item-1"><a href="../../reference.html" >7. Reference manual</a> »</li> - <li class="nav-item nav-item-2"><a href="../sharding.html" accesskey="U">7.20. Sharding</a> »</li> + <li class="nav-item nav-item-2"><a href="../command.html" accesskey="U">7.3. Command</a> »</li> </ul> </div> @@ -101,7 +101,7 @@ specified logical table name.</p> <div class="section" id="syntax"> <h2>7.3.34.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> <p>This command takes only one required parameter:</p> -<div class="highlight-none"><div class="highlight"><pre>logical_shard_list logical_table +<div class="highlight-none"><div class="highlight"><pre><span></span>logical_shard_list logical_table </pre></div> </div> </div> @@ -109,13 +109,13 @@ specified logical table name.</p> <h2>7.3.34.3. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2> <p>You need to register <code class="docutils literal"><span class="pre">sharding</span></code> plugin to use this command:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>plugin_register sharding +<div class="highlight-none"><div class="highlight"><pre><span></span>plugin_register sharding # [[0, 1337566253.89858, 0.000355720520019531], true] </pre></div> </div> <p>Here are sample shards:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Logs_20150801 TABLE_HASH_KEY ShortText +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Logs_20150801 TABLE_HASH_KEY ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] column_create Logs_20150801 timestamp COLUMN_SCALAR Time # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -132,7 +132,7 @@ column_create Logs_20150930 timestamp COLUMN_SCALAR Time <p>You can get the all shard names in ascending order by specifying <code class="docutils literal"><span class="pre">Logs</span></code> as the logical table name:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>logical_shard_list --logical_table Logs +<div class="highlight-none"><div class="highlight"><pre><span></span>logical_shard_list --logical_table Logs # [ # [ # 0, @@ -165,7 +165,7 @@ column_create Logs_20150930 timestamp COLUMN_SCALAR Time <p>Specifies the logical table name. <code class="docutils literal"><span class="pre">logical_shard_list</span></code> returns a list of shard name of the logical table:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>logical_shard_list --logical_table Logs +<div class="highlight-none"><div class="highlight"><pre><span></span>logical_shard_list --logical_table Logs # [ # [ # 0, @@ -191,13 +191,13 @@ list of shard name of the logical table:</p> </div> <div class="section" id="optional-parameters"> <h3>7.3.34.4.2. Optional parameters<a class="headerlink" href="#optional-parameters" title="Permalink to this headline">¶</a></h3> -<p>There is no optional parameters.</p> +<p>There is no optional parameter.</p> </div> </div> <div class="section" id="return-value"> <h2>7.3.34.5. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2> <p>The command returns a list of shard names in ascending order:</p> -<div class="highlight-none"><div class="highlight"><pre>[ +<div class="highlight-none"><div class="highlight"><pre><span></span>[ HEADER, [ {"name": "SHARD_NAME_1"}, @@ -290,7 +290,7 @@ list of shard name of the logical table:</p> >previous</a> |</li> <li class="nav-item nav-item-0"><a href="../../index.html">Groonga v6.0.0 documentation</a> »</li> <li class="nav-item nav-item-1"><a href="../../reference.html" >7. Reference manual</a> »</li> - <li class="nav-item nav-item-2"><a href="../sharding.html" >7.20. Sharding</a> »</li> + <li class="nav-item nav-item-2"><a href="../command.html" >7.3. Command</a> »</li> </ul> </div> <div class="footer" role="contentinfo"> Modified: docs/reference/commands/logical_table_remove.html (+13 -13) =================================================================== --- docs/reference/commands/logical_table_remove.html 2016-03-05 15:09:34 +0900 (ea5e2e0) +++ docs/reference/commands/logical_table_remove.html 2016-03-17 12:56:59 +0900 (11d5337) @@ -25,8 +25,8 @@ <script type="text/javascript" src="../../static/doctools.js"></script> <link rel="shortcut icon" href="../../static/favicon.ico"/> <link rel="top" title="Groonga v6.0.0 documentation" href="../../index.html" /> - <link rel="up" title="7.20. Sharding" href="../sharding.html" /> - <link rel="next" title="7.21. Log" href="../log.html" /> + <link rel="up" title="7.3. Command" href="../command.html" /> + <link rel="next" title="7.3.36. normalize" href="normalize.html" /> <link rel="prev" title="7.3.34. logical_shard_list" href="logical_shard_list.html" /> <meta property="fb:page_id" content="201193596592346" /><!-- groonga --> <meta property="fb:admins" content="664204556" /><!-- kouhei.sutou --> @@ -68,14 +68,14 @@ <a href="../../genindex.html" title="General Index" accesskey="I">index</a></li> <li class="right" > - <a href="../log.html" title="7.21. Log" + <a href="normalize.html" title="7.3.36. normalize" accesskey="N">next</a> |</li> <li class="right" > <a href="logical_shard_list.html" title="7.3.34. logical_shard_list" accesskey="P">previous</a> |</li> <li class="nav-item nav-item-0"><a href="../../index.html">Groonga v6.0.0 documentation</a> »</li> <li class="nav-item nav-item-1"><a href="../../reference.html" >7. Reference manual</a> »</li> - <li class="nav-item nav-item-2"><a href="../sharding.html" accesskey="U">7.20. Sharding</a> »</li> + <li class="nav-item nav-item-2"><a href="../command.html" accesskey="U">7.3. Command</a> »</li> </ul> </div> @@ -101,7 +101,7 @@ <h2>7.3.35.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> <p>This command takes many parameters.</p> <p>The required parameters are <code class="docutils literal"><span class="pre">logical_table</span></code> and <code class="docutils literal"><span class="pre">shard_key</span></code>:</p> -<div class="highlight-none"><div class="highlight"><pre>logical_table_remove logical_table +<div class="highlight-none"><div class="highlight"><pre><span></span>logical_table_remove logical_table shard_key [min] [min_border] @@ -117,8 +117,8 @@ <div class="section" id="parameters"> <h2>7.3.35.4. Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></h2> <p>This section describes parameters of <code class="docutils literal"><span class="pre">logical_table_remove</span></code>.</p> -<div class="section" id="required-parameter"> -<h3>7.3.35.4.1. Required parameter<a class="headerlink" href="#required-parameter" title="Permalink to this headline">¶</a></h3> +<div class="section" id="required-parameters"> +<h3>7.3.35.4.1. Required parameters<a class="headerlink" href="#required-parameters" title="Permalink to this headline">¶</a></h3> <p>There are required parameters, <code class="docutils literal"><span class="pre">logical_table</span></code> and <code class="docutils literal"><span class="pre">shard_key</span></code>.</p> <div class="section" id="logical-table"> <h4>7.3.35.4.1.1. <code class="docutils literal"><span class="pre">logical_table</span></code><a class="headerlink" href="#logical-table" title="Permalink to this headline">¶</a></h4> @@ -156,7 +156,7 @@ Specify <code class="docutils literal"><span class="pre">include</span></code> o <div class="section" id="return-value"> <h2>7.3.35.5. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2> <p>TODO</p> -<div class="highlight-none"><div class="highlight"><pre>[HEADER, true] +<div class="highlight-none"><div class="highlight"><pre><span></span>[HEADER, true] </pre></div> </div> </div> @@ -175,7 +175,7 @@ Specify <code class="docutils literal"><span class="pre">include</span></code> o <li><a class="reference internal" href="#syntax">7.3.35.2. Syntax</a></li> <li><a class="reference internal" href="#usage">7.3.35.3. Usage</a></li> <li><a class="reference internal" href="#parameters">7.3.35.4. Parameters</a><ul> -<li><a class="reference internal" href="#required-parameter">7.3.35.4.1. Required parameter</a><ul> +<li><a class="reference internal" href="#required-parameters">7.3.35.4.1. Required parameters</a><ul> <li><a class="reference internal" href="#logical-table">7.3.35.4.1.1. <code class="docutils literal"><span class="pre">logical_table</span></code></a></li> <li><a class="reference internal" href="#shard-key">7.3.35.4.1.2. <code class="docutils literal"><span class="pre">shard_key</span></code></a></li> </ul> @@ -198,8 +198,8 @@ Specify <code class="docutils literal"><span class="pre">include</span></code> o <p class="topless"><a href="logical_shard_list.html" title="previous chapter">7.3.34. <code class="docutils literal"><span class="pre">logical_shard_list</span></code></a></p> <h4>Next topic</h4> - <p class="topless"><a href="../log.html" - title="next chapter">7.21. Log</a></p> + <p class="topless"><a href="normalize.html" + title="next chapter">7.3.36. <code class="docutils literal"><span class="pre">normalize</span></code></a></p> <div role="note" aria-label="source link"> <h3>This Page</h3> <ul class="this-page-menu"> @@ -231,14 +231,14 @@ Specify <code class="docutils literal"><span class="pre">include</span></code> o <a href="../../genindex.html" title="General Index" >index</a></li> <li class="right" > - <a href="../log.html" title="7.21. Log" + <a href="normalize.html" title="7.3.36. normalize" >next</a> |</li> <li class="right" > <a href="logical_shard_list.html" title="7.3.34. logical_shard_list" >previous</a> |</li> <li class="nav-item nav-item-0"><a href="../../index.html">Groonga v6.0.0 documentation</a> »</li> <li class="nav-item nav-item-1"><a href="../../reference.html" >7. Reference manual</a> »</li> - <li class="nav-item nav-item-2"><a href="../sharding.html" >7.20. Sharding</a> »</li> + <li class="nav-item nav-item-2"><a href="../command.html" >7.3. Command</a> »</li> </ul> </div> <div class="footer" role="contentinfo"> Modified: docs/reference/commands/normalize.html (+6 -6) =================================================================== --- docs/reference/commands/normalize.html 2016-03-05 15:09:34 +0900 (34546b0) +++ docs/reference/commands/normalize.html 2016-03-17 12:56:59 +0900 (46f76fc) @@ -101,7 +101,7 @@ It is useful for you to check the results of normalizer.</p> <h2>7.3.36.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> <p>This command takes three parameters.</p> <p><code class="docutils literal"><span class="pre">normalizer</span></code> and <code class="docutils literal"><span class="pre">string</span></code> are required. Others are optional:</p> -<div class="highlight-none"><div class="highlight"><pre>normalize normalizer +<div class="highlight-none"><div class="highlight"><pre><span></span>normalize normalizer string [flags=NONE] </pre></div> @@ -111,7 +111,7 @@ It is useful for you to check the results of normalizer.</p> <h2>7.3.36.3. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2> <p>Here is a simple example of <code class="docutils literal"><span class="pre">normalize</span></code> command.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>normalize NormalizerAuto "aBcDe 123" +<div class="highlight-none"><div class="highlight"><pre><span></span>normalize NormalizerAuto "aBcDe 123" # [ # [ # 0, @@ -130,8 +130,8 @@ It is useful for you to check the results of normalizer.</p> <div class="section" id="parameters"> <h2>7.3.36.4. Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></h2> <p>This section describes parameters of <code class="docutils literal"><span class="pre">normalizer</span></code>.</p> -<div class="section" id="required-parameter"> -<h3>7.3.36.4.1. Required parameter<a class="headerlink" href="#required-parameter" title="Permalink to this headline">¶</a></h3> +<div class="section" id="required-parameters"> +<h3>7.3.36.4.1. Required parameters<a class="headerlink" href="#required-parameters" title="Permalink to this headline">¶</a></h3> <p>There are required parameters, <code class="docutils literal"><span class="pre">normalizer</span></code> and <code class="docutils literal"><span class="pre">string</span></code>.</p> <div class="section" id="normalizer"> <h4>7.3.36.4.1.1. <code class="docutils literal"><span class="pre">normalizer</span></code><a class="headerlink" href="#normalizer" title="Permalink to this headline">¶</a></h4> @@ -201,7 +201,7 @@ multiple options separated by "<code class="docutils literal"><span class=" </div> <div class="section" id="return-value"> <h2>7.3.36.5. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2> -<div class="highlight-none"><div class="highlight"><pre>[HEADER, normalized_text] +<div class="highlight-none"><div class="highlight"><pre><span></span>[HEADER, normalized_text] </pre></div> </div> <p><code class="docutils literal"><span class="pre">HEADER</span></code></p> @@ -253,7 +253,7 @@ the type of the N-th character in <code class="docutils literal"><span class="pr <li><a class="reference internal" href="#syntax">7.3.36.2. Syntax</a></li> <li><a class="reference internal" href="#usage">7.3.36.3. Usage</a></li> <li><a class="reference internal" href="#parameters">7.3.36.4. Parameters</a><ul> -<li><a class="reference internal" href="#required-parameter">7.3.36.4.1. Required parameter</a><ul> +<li><a class="reference internal" href="#required-parameters">7.3.36.4.1. Required parameters</a><ul> <li><a class="reference internal" href="#normalizer">7.3.36.4.1.1. <code class="docutils literal"><span class="pre">normalizer</span></code></a></li> <li><a class="reference internal" href="#string">7.3.36.4.1.2. <code class="docutils literal"><span class="pre">string</span></code></a></li> </ul> Modified: docs/reference/commands/normalizer_list.html (+3 -3) =================================================================== --- docs/reference/commands/normalizer_list.html 2016-03-05 15:09:34 +0900 (af585d9) +++ docs/reference/commands/normalizer_list.html 2016-03-17 12:56:59 +0900 (9c7ca37) @@ -93,7 +93,7 @@ <div class="section" id="syntax"> <h2>7.3.37.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> <p>This command takes no parameters:</p> -<div class="highlight-none"><div class="highlight"><pre>normalizer_list +<div class="highlight-none"><div class="highlight"><pre><span></span>normalizer_list </pre></div> </div> </div> @@ -101,7 +101,7 @@ <h2>7.3.37.3. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2> <p>Here is a simple example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>normalizer_list +<div class="highlight-none"><div class="highlight"><pre><span></span>normalizer_list # [ # [ # 0, @@ -125,7 +125,7 @@ <h2>7.3.37.4. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2> <p><code class="docutils literal"><span class="pre">normalizer_list</span></code> command returns normalizers. Each normalizers has an attribute that contains the name. The attribute will be increased in the feature:</p> -<div class="highlight-none"><div class="highlight"><pre>[HEADER, normalizers] +<div class="highlight-none"><div class="highlight"><pre><span></span>[HEADER, normalizers] </pre></div> </div> <p><code class="docutils literal"><span class="pre">HEADER</span></code></p> Modified: docs/reference/commands/object_exist.html (+6 -6) =================================================================== --- docs/reference/commands/object_exist.html 2016-03-05 15:09:34 +0900 (04c04cd) +++ docs/reference/commands/object_exist.html 2016-03-17 12:56:59 +0900 (12a7106) @@ -101,7 +101,7 @@ table, column, function and so on.</p> <div class="section" id="syntax"> <h2>7.3.38.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> <p>This command takes only one required parameter:</p> -<div class="highlight-none"><div class="highlight"><pre>object_exist name +<div class="highlight-none"><div class="highlight"><pre><span></span>object_exist name </pre></div> </div> </div> @@ -109,7 +109,7 @@ table, column, function and so on.</p> <h2>7.3.38.3. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2> <p>You can check whether the name is already used in database:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>object_exist Users +<div class="highlight-none"><div class="highlight"><pre><span></span>object_exist Users # [[0, 1337566253.89858, 0.000355720520019531], false] table_create Users TABLE_HASH_KEY ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -134,7 +134,7 @@ table.</p> <p>If you want to check existence of a column, use <code class="docutils literal"><span class="pre">TABLE_NAME.COLUMN_NAME</span></code> format like the following:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Logs TABLE_NO_KEY +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Logs TABLE_NO_KEY # [[0, 1337566253.89858, 0.000355720520019531], true] column_create Logs timestamp COLUMN_SCALAR Time # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -148,18 +148,18 @@ object_exist Logs.timestamp </div> <div class="section" id="optional-parameters"> <h3>7.3.38.4.2. Optional parameters<a class="headerlink" href="#optional-parameters" title="Permalink to this headline">¶</a></h3> -<p>There is no optional parameters.</p> +<p>There is no optional parameter.</p> </div> </div> <div class="section" id="return-value"> <h2>7.3.38.5. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2> <p>The command returns <code class="docutils literal"><span class="pre">true</span></code> as body if object with the specified name exists in database such as:</p> -<div class="highlight-none"><div class="highlight"><pre>[HEADER, true] +<div class="highlight-none"><div class="highlight"><pre><span></span>[HEADER, true] </pre></div> </div> <p>The command returns <code class="docutils literal"><span class="pre">false</span></code> otherwise such as:</p> -<div class="highlight-none"><div class="highlight"><pre>[HEADER, false] +<div class="highlight-none"><div class="highlight"><pre><span></span>[HEADER, false] </pre></div> </div> <p>See <a class="reference internal" href="../command/output_format.html"><em>Output format</em></a> for <code class="docutils literal"><span class="pre">HEADER</span></code>.</p> Modified: docs/reference/commands/object_inspect.html (+8 -8) =================================================================== --- docs/reference/commands/object_inspect.html 2016-03-05 15:09:34 +0900 (2f32b7e) +++ docs/reference/commands/object_inspect.html 2016-03-17 12:56:59 +0900 (01e16b7) @@ -106,7 +106,7 @@ the column.</li> <div class="section" id="syntax"> <h2>7.3.39.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> <p>This command takes only one optional parameter:</p> -<div class="highlight-none"><div class="highlight"><pre>object_inspect [name=null] +<div class="highlight-none"><div class="highlight"><pre><span></span>object_inspect [name=null] </pre></div> </div> </div> @@ -114,7 +114,7 @@ the column.</li> <h2>7.3.39.3. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2> <p>You can inspect an object in the database specified by <code class="docutils literal"><span class="pre">name</span></code>:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Users TABLE_HASH_KEY ShortText +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Users TABLE_HASH_KEY ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] load --table Users [ @@ -168,7 +168,7 @@ object_inspect Users </div></blockquote> <p>You can inspect the database by not specifying <code class="docutils literal"><span class="pre">name</span></code>:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>object_inspect +<div class="highlight-none"><div class="highlight"><pre><span></span>object_inspect # [ # [ # 0, @@ -211,7 +211,7 @@ object_inspect Users <p>This section describes all parameters.</p> <div class="section" id="required-parameters"> <h3>7.3.39.4.1. Required parameters<a class="headerlink" href="#required-parameters" title="Permalink to this headline">¶</a></h3> -<p>There is no required parameters.</p> +<p>There is no required parameter.</p> </div> <div class="section" id="optional-parameters"> <h3>7.3.39.4.2. Optional parameters<a class="headerlink" href="#optional-parameters" title="Permalink to this headline">¶</a></h3> @@ -227,7 +227,7 @@ object_inspect Users <h2>7.3.39.5. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2> <p>The command returns an object (nested key and value pairs) that includes details of the object (such as table) as body:</p> -<div class="highlight-none"><div class="highlight"><pre>[HEADER, object] +<div class="highlight-none"><div class="highlight"><pre><span></span>[HEADER, object] </pre></div> </div> <p>See <a class="reference internal" href="../command/output_format.html"><em>Output format</em></a> for <code class="docutils literal"><span class="pre">HEADER</span></code>.</p> @@ -236,7 +236,7 @@ table has key information but function doesn't have key information.</p> <div class="section" id="database"> <span id="object-inspect-return-value-database"></span><h3>7.3.39.5.1. Database<a class="headerlink" href="#database" title="Permalink to this headline">¶</a></h3> <p>Database inspection returns the following information:</p> -<div class="highlight-none"><div class="highlight"><pre>{ +<div class="highlight-none"><div class="highlight"><pre><span></span>{ "type": { "id": DATABASE_TYPE_ID, "name": DATABASE_TYPE_NAME @@ -264,7 +264,7 @@ database. The table is <a class="reference internal" href="../tables.html#table- <div class="section" id="table"> <span id="object-inspect-return-value-table"></span><h3>7.3.39.5.2. Table<a class="headerlink" href="#table" title="Permalink to this headline">¶</a></h3> <p>Table inspection returns the following information:</p> -<div class="highlight-none"><div class="highlight"><pre>{ +<div class="highlight-none"><div class="highlight"><pre><span></span>{ "name": TABLE_NAME, "type": { "id": TABLE_TYPE_ID, @@ -381,7 +381,7 @@ doesn't have value.</li> <div class="section" id="type"> <span id="object-inspect-return-value-type"></span><h4>7.3.39.5.2.9. Type<a class="headerlink" href="#type" title="Permalink to this headline">¶</a></h4> <p>Type inspection returns the following information:</p> -<div class="highlight-none"><div class="highlight"><pre>{ +<div class="highlight-none"><div class="highlight"><pre><span></span>{ "id": TYPE_ID, "name": TYPE_NAME, "type": { Modified: docs/reference/commands/object_remove.html (+7 -7) =================================================================== --- docs/reference/commands/object_remove.html 2016-03-05 15:09:34 +0900 (ea2cd18) +++ docs/reference/commands/object_remove.html 2016-03-17 12:56:59 +0900 (d55a7fe) @@ -104,7 +104,7 @@ should use <code class="docutils literal"><span class="pre">object_remove</span> <div class="section" id="syntax"> <h2>7.3.40.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> <p>This command takes two parameters:</p> -<div class="highlight-none"><div class="highlight"><pre>object_remove name +<div class="highlight-none"><div class="highlight"><pre><span></span>object_remove name [force=no] </pre></div> </div> @@ -113,7 +113,7 @@ should use <code class="docutils literal"><span class="pre">object_remove</span> <h2>7.3.40.3. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2> <p>You can remove an object in the database specified by <code class="docutils literal"><span class="pre">name</span></code>:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>object_remove Users +<div class="highlight-none"><div class="highlight"><pre><span></span>object_remove Users # [ # [ # -22, @@ -142,7 +142,7 @@ object_remove Users table.</p> <p>You can't remove a broken object by default:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Users TABLE_HASH_KEY ShortText +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Users TABLE_HASH_KEY ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] thread_limit 1 # [[0, 1337566253.89858, 0.000355720520019531], 1] @@ -172,7 +172,7 @@ object_exist Users </div> <p>You can remove a broken object by <code class="docutils literal"><span class="pre">--force</span> <span class="pre">yes</span></code>:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>object_remove Users --force yes +<div class="highlight-none"><div class="highlight"><pre><span></span>object_remove Users --force yes # [ # [ # -65, @@ -208,7 +208,7 @@ object in "force mode".</p> <p>If you want to remove a column, use <code class="docutils literal"><span class="pre">TABLE_NAME.COLUMN_NAME</span></code> format like the following:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Logs TABLE_NO_KEY +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Logs TABLE_NO_KEY # [[0, 1337566253.89858, 0.000355720520019531], true] column_create Logs timestamp COLUMN_SCALAR Time # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -239,12 +239,12 @@ default.</p> <h2>7.3.40.5. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2> <p>The command returns <code class="docutils literal"><span class="pre">true</span></code> as body when the command removed the specified object without any error. For example:</p> -<div class="highlight-none"><div class="highlight"><pre>[HEADER, true] +<div class="highlight-none"><div class="highlight"><pre><span></span>[HEADER, true] </pre></div> </div> <p>The command returns <code class="docutils literal"><span class="pre">false</span></code> as body when the command gets any errors. For example:</p> -<div class="highlight-none"><div class="highlight"><pre>[HEADER, false] +<div class="highlight-none"><div class="highlight"><pre><span></span>[HEADER, false] </pre></div> </div> <p>See <a class="reference internal" href="../command/output_format.html"><em>Output format</em></a> for <code class="docutils literal"><span class="pre">HEADER</span></code>.</p> Modified: docs/reference/commands/plugin_register.html (+3 -3) =================================================================== --- docs/reference/commands/plugin_register.html 2016-03-05 15:09:34 +0900 (2c36a32) +++ docs/reference/commands/plugin_register.html 2016-03-17 12:56:59 +0900 (3f6a2a9) @@ -102,7 +102,7 @@ process loads all registered plugins without <code class="docutils literal"><spa <div class="section" id="syntax"> <h2>7.3.41.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> <p>This command takes only one required parameter:</p> -<div class="highlight-none"><div class="highlight"><pre>plugin_register name +<div class="highlight-none"><div class="highlight"><pre><span></span>plugin_register name </pre></div> </div> </div> @@ -112,7 +112,7 @@ process loads all registered plugins without <code class="docutils literal"><spa that is included in <code class="docutils literal"><span class="pre">${PREFIX}/lib/groonga/plugins/query_expanders/tsv.so</span></code>.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>plugin_register query_expanders/tsv +<div class="highlight-none"><div class="highlight"><pre><span></span>plugin_register query_expanders/tsv # [[0, 1337566253.89858, 0.000355720520019531], true] </pre></div> </div> @@ -124,7 +124,7 @@ They are completed automatically.</p> <div class="section" id="return-value"> <h2>7.3.41.4. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2> <p><code class="docutils literal"><span class="pre">plugin_register</span></code> returns <code class="docutils literal"><span class="pre">true</span></code> as body on success such as:</p> -<div class="highlight-none"><div class="highlight"><pre>[HEADER, true] +<div class="highlight-none"><div class="highlight"><pre><span></span>[HEADER, true] </pre></div> </div> <p>If <code class="docutils literal"><span class="pre">plugin_register</span></code> fails, error details are in <code class="docutils literal"><span class="pre">HEADER</span></code>.</p> Modified: docs/reference/commands/plugin_unregister.html (+3 -3) =================================================================== --- docs/reference/commands/plugin_unregister.html 2016-03-05 15:09:34 +0900 (15b8a6d) +++ docs/reference/commands/plugin_unregister.html 2016-03-17 12:56:59 +0900 (d9b5bc7) @@ -100,7 +100,7 @@ <div class="section" id="syntax"> <h2>7.3.42.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> <p>This command takes only one required parameter:</p> -<div class="highlight-none"><div class="highlight"><pre>plugin_unregister name +<div class="highlight-none"><div class="highlight"><pre><span></span>plugin_unregister name </pre></div> </div> </div> @@ -110,7 +110,7 @@ that is included in <code class="docutils literal"><span class="pre">${PREFIX}/lib/groonga/plugins/query_expanders/tsv.so</span></code>.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>plugin_unregister query_expanders/tsv +<div class="highlight-none"><div class="highlight"><pre><span></span>plugin_unregister query_expanders/tsv # [[0, 1337566253.89858, 0.000355720520019531], true] </pre></div> </div> @@ -122,7 +122,7 @@ They are completed automatically.</p> <div class="section" id="return-value"> <h2>7.3.42.4. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2> <p><code class="docutils literal"><span class="pre">plugin_unregister</span></code> returns <code class="docutils literal"><span class="pre">true</span></code> as body on success such as:</p> -<div class="highlight-none"><div class="highlight"><pre>[HEADER, true] +<div class="highlight-none"><div class="highlight"><pre><span></span>[HEADER, true] </pre></div> </div> <p>If <code class="docutils literal"><span class="pre">plugin_unregister</span></code> fails, error details are in <code class="docutils literal"><span class="pre">HEADER</span></code>.</p> Modified: docs/reference/commands/quit.html (+2 -2) =================================================================== --- docs/reference/commands/quit.html 2016-03-05 15:09:34 +0900 (e7e91f5) +++ docs/reference/commands/quit.html 2016-03-17 12:56:59 +0900 (aadce96) @@ -94,13 +94,13 @@ </div> <div class="section" id="syntax"> <h2>7.3.43.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> -<div class="highlight-none"><div class="highlight"><pre>quit +<div class="highlight-none"><div class="highlight"><pre><span></span>quit </pre></div> </div> </div> <div class="section" id="usage"> <h2>7.3.43.3. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2> -<div class="highlight-none"><div class="highlight"><pre>quit +<div class="highlight-none"><div class="highlight"><pre><span></span>quit </pre></div> </div> </div> Modified: docs/reference/commands/register.html (+3 -3) =================================================================== --- docs/reference/commands/register.html 2016-03-05 15:09:34 +0900 (708d8ba) +++ docs/reference/commands/register.html 2016-03-17 12:56:59 +0900 (5016cef) @@ -106,7 +106,7 @@ process loads all registered plugins without <code class="docutils literal"><spa <div class="section" id="syntax"> <h2>7.3.45.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> <p>This command takes only one required parameter:</p> -<div class="highlight-none"><div class="highlight"><pre>register path +<div class="highlight-none"><div class="highlight"><pre><span></span>register path </pre></div> </div> </div> @@ -116,7 +116,7 @@ process loads all registered plugins without <code class="docutils literal"><spa that is included in <code class="docutils literal"><span class="pre">${PREFIX}/lib/groonga/plugins/query_expanders/tsv.so</span></code>.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>register query_expanders/tsv +<div class="highlight-none"><div class="highlight"><pre><span></span>register query_expanders/tsv # [[0, 1337566253.89858, 0.000355720520019531], true] </pre></div> </div> @@ -128,7 +128,7 @@ They are completed automatically.</p> <div class="section" id="return-value"> <h2>7.3.45.4. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2> <p><code class="docutils literal"><span class="pre">register</span></code> returns <code class="docutils literal"><span class="pre">true</span></code> as body on success such as:</p> -<div class="highlight-none"><div class="highlight"><pre>[HEADER, true] +<div class="highlight-none"><div class="highlight"><pre><span></span>[HEADER, true] </pre></div> </div> <p>If <code class="docutils literal"><span class="pre">register</span></code> fails, error details are in <code class="docutils literal"><span class="pre">HEADER</span></code>.</p> Modified: docs/reference/commands/reindex.html (+6 -6) =================================================================== --- docs/reference/commands/reindex.html 2016-03-05 15:09:34 +0900 (f91f08c) +++ docs/reference/commands/reindex.html 2016-03-17 12:56:59 +0900 (e26c90f) @@ -113,7 +113,7 @@ database. You can use <a class="reference internal" href="database_unmap.html">< <div class="section" id="syntax"> <h2>7.3.46.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> <p>This command takes only one optional parameter:</p> -<div class="highlight-none"><div class="highlight"><pre>reindex [target_name=null] +<div class="highlight-none"><div class="highlight"><pre><span></span>reindex [target_name=null] </pre></div> </div> <p>If <code class="docutils literal"><span class="pre">target_name</span></code> parameters is omitted, database is used for the @@ -124,7 +124,7 @@ recreated.</p> <h2>7.3.46.3. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2> <p>Here is an example to recreate all index columns in the database:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>reindex +<div class="highlight-none"><div class="highlight"><pre><span></span>reindex # [[0, 1337566253.89858, 0.000355720520019531], true] </pre></div> </div> @@ -132,7 +132,7 @@ recreated.</p> (<code class="docutils literal"><span class="pre">Lexicon.entry_key</span></code> and <code class="docutils literal"><span class="pre">Lexicon.entry_body</span></code>) in <code class="docutils literal"><span class="pre">Lexicon</span></code> table:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Entry TABLE_HASH_KEY ShortText +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Entry TABLE_HASH_KEY ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] column_create Entry body COLUMN_SCALAR Text # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -154,7 +154,7 @@ reindex Lexicon (<code class="docutils literal"><span class="pre">BigramLexicon.site_title</span></code> and <code class="docutils literal"><span class="pre">RegexpLexicon.site_title</span></code>) of <code class="docutils literal"><span class="pre">Site.title</span></code> data column:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Site TABLE_HASH_KEY ShortText +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Site TABLE_HASH_KEY ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] column_create Site title COLUMN_SCALAR ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -178,7 +178,7 @@ reindex Site.title </div> <p>Here is an example to recreate an index column (<code class="docutils literal"><span class="pre">Timestamp.index</span></code>):</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Logs TABLE_NO_KEY +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Logs TABLE_NO_KEY # [[0, 1337566253.89858, 0.000355720520019531], true] column_create Logs timestamp COLUMN_SCALAR Time # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -204,7 +204,7 @@ reindex Timestamp.logs_timestamp <div class="section" id="return-value"> <h2>7.3.46.5. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2> <p><code class="docutils literal"><span class="pre">reindex</span></code> command returns whether recreation is succeeded or not:</p> -<div class="highlight-none"><div class="highlight"><pre>[HEADER, SUCCEEDED_OR_NOT] +<div class="highlight-none"><div class="highlight"><pre><span></span>[HEADER, SUCCEEDED_OR_NOT] </pre></div> </div> <p><code class="docutils literal"><span class="pre">HEADER</span></code></p> Modified: docs/reference/commands/request_cancel.html (+8 -8) =================================================================== --- docs/reference/commands/request_cancel.html 2016-03-05 15:09:34 +0900 (1b7a774) +++ docs/reference/commands/request_cancel.html 2016-03-17 12:56:59 +0900 (1bf13f6) @@ -116,14 +116,14 @@ use with <a class="reference internal" href="../executables/groonga-httpd.html"> <div class="section" id="syntax"> <h2>7.3.47.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> <p>This command takes only one required parameter:</p> -<div class="highlight-none"><div class="highlight"><pre>request_cancel id +<div class="highlight-none"><div class="highlight"><pre><span></span>request_cancel id </pre></div> </div> </div> <div class="section" id="usage"> <h2>7.3.47.3. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2> <p>Here is an example of <code class="docutils literal"><span class="pre">request_cancel</span></code> command:</p> -<div class="highlight-none"><div class="highlight"><pre>$ curl 'http://localhost:10041/d/select?table=LargeTable&filter=true&request_id=unique-id-1' & +<div class="highlight-none"><div class="highlight"><pre><span></span>$ curl 'http://localhost:10041/d/select?table=LargeTable&filter=true&request_id=unique-id-1' & # The above "select" takes a long time... # Point: "request_id=unique-id-1" $ curl 'http://localhost:10041/d/request_cancel?id=unique-id-1' @@ -142,7 +142,7 @@ request may be ignored.</p> <p>You can send cancel request for the same request ID multiple times. If the target request is canceled or finished, <code class="docutils literal"><span class="pre">"canceled"</span></code> value is changed to <code class="docutils literal"><span class="pre">false</span></code> from <code class="docutils literal"><span class="pre">true</span></code> in return value:</p> -<div class="highlight-none"><div class="highlight"><pre>$ curl 'http://localhost:10041/d/request_cancel?id=unique-id-1' +<div class="highlight-none"><div class="highlight"><pre><span></span>$ curl 'http://localhost:10041/d/request_cancel?id=unique-id-1' [[...], {"id": "unique-id-1", "canceled": true}] # "select" is still running... ("canceled" is "true") $ curl 'http://localhost:10041/d/request_cancel?id=unique-id-1' @@ -156,7 +156,7 @@ $ curl 'http://localhost:10041/d/request_cancel?id=unique-id-1' <p>If the <code class="docutils literal"><span class="pre">select</span></code> command is canceled, response of the <code class="docutils literal"><span class="pre">select</span></code> command has <code class="docutils literal"><span class="pre">-5</span></code> (<code class="docutils literal"><span class="pre">GRN_INTERRUPTED_FUNCTION_CALL</span></code>) as <a class="reference internal" href="../command/return_code.html"><em>Return code</em></a>:</p> -<div class="highlight-none"><div class="highlight"><pre>$ curl 'http://localhost:10041/d/select?table=LargeTable&filter=true&request_id=unique-id-1' & +<div class="highlight-none"><div class="highlight"><pre><span></span>$ curl 'http://localhost:10041/d/select?table=LargeTable&filter=true&request_id=unique-id-1' & [[-5, ...], ...] </pre></div> </div> @@ -164,8 +164,8 @@ command has <code class="docutils literal"><span class="pre">-5</span></code> (< <div class="section" id="parameters"> <h2>7.3.47.4. Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></h2> <p>This section describes parameters of <code class="docutils literal"><span class="pre">request_cancel</span></code>.</p> -<div class="section" id="required-parameter"> -<h3>7.3.47.4.1. Required parameter<a class="headerlink" href="#required-parameter" title="Permalink to this headline">¶</a></h3> +<div class="section" id="required-parameters"> +<h3>7.3.47.4.1. Required parameters<a class="headerlink" href="#required-parameters" title="Permalink to this headline">¶</a></h3> <p>There is required parameter, <code class="docutils literal"><span class="pre">id</span></code>.</p> <div class="section" id="id"> <h4>7.3.47.4.1.1. <code class="docutils literal"><span class="pre">id</span></code><a class="headerlink" href="#id" title="Permalink to this headline">¶</a></h4> @@ -176,7 +176,7 @@ command has <code class="docutils literal"><span class="pre">-5</span></code> (< <div class="section" id="return-value"> <h2>7.3.47.5. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2> <p><code class="docutils literal"><span class="pre">request_cancel</span></code> command returns the result of the cancel request:</p> -<div class="highlight-none"><div class="highlight"><pre>[ +<div class="highlight-none"><div class="highlight"><pre><span></span>[ HEADER, { "id": ID, @@ -224,7 +224,7 @@ by the target request".</p> <li><a class="reference internal" href="#syntax">7.3.47.2. Syntax</a></li> <li><a class="reference internal" href="#usage">7.3.47.3. Usage</a></li> <li><a class="reference internal" href="#parameters">7.3.47.4. Parameters</a><ul> -<li><a class="reference internal" href="#required-parameter">7.3.47.4.1. Required parameter</a><ul> +<li><a class="reference internal" href="#required-parameters">7.3.47.4.1. Required parameters</a><ul> <li><a class="reference internal" href="#id">7.3.47.4.1.1. <code class="docutils literal"><span class="pre">id</span></code></a></li> </ul> </li> Modified: docs/reference/commands/ruby_eval.html (+3 -3) =================================================================== --- docs/reference/commands/ruby_eval.html 2016-03-05 15:09:34 +0900 (ebb069a) +++ docs/reference/commands/ruby_eval.html 2016-03-17 12:56:59 +0900 (a1e04b6) @@ -93,7 +93,7 @@ <div class="section" id="syntax"> <h2>7.3.48.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> <p>This command takes only one required parameter:</p> -<div class="highlight-none"><div class="highlight"><pre>ruby_eval script +<div class="highlight-none"><div class="highlight"><pre><span></span>ruby_eval script </pre></div> </div> </div> @@ -102,7 +102,7 @@ <p>You can execute any scripts which mruby supports by calling <code class="docutils literal"><span class="pre">ruby_eval</span></code>.</p> <p>Here is an example that just calculate <code class="docutils literal"><span class="pre">1</span> <span class="pre">+</span> <span class="pre">2</span></code> as Ruby script.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>register ruby/eval +<div class="highlight-none"><div class="highlight"><pre><span></span>register ruby/eval # [[0, 1337566253.89858, 0.000355720520019531], true] ruby_eval "1 + 2" # [[0, 1337566253.89858, 0.000355720520019531], {"value": 3}] @@ -124,7 +124,7 @@ and the specification may be changed in the future.</p> <h2>7.3.48.5. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2> <p><code class="docutils literal"><span class="pre">ruby_eval</span></code> returns the evaluated result with metadata such as exception information (Including metadata isn't implemented yet):</p> -<div class="highlight-none"><div class="highlight"><pre>[HEADER, {"value": EVALUATED_VALUE}] +<div class="highlight-none"><div class="highlight"><pre><span></span>[HEADER, {"value": EVALUATED_VALUE}] </pre></div> </div> <p><code class="docutils literal"><span class="pre">HEADER</span></code></p> Modified: docs/reference/commands/ruby_load.html (+3 -3) =================================================================== --- docs/reference/commands/ruby_load.html 2016-03-05 15:09:34 +0900 (ad19746) +++ docs/reference/commands/ruby_load.html 2016-03-17 12:56:59 +0900 (933c9c4) @@ -93,7 +93,7 @@ <div class="section" id="syntax"> <h2>7.3.49.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> <p>This command takes only one required parameter:</p> -<div class="highlight-none"><div class="highlight"><pre>ruby_load path +<div class="highlight-none"><div class="highlight"><pre><span></span>ruby_load path </pre></div> </div> </div> @@ -102,7 +102,7 @@ <p>You can load any script file which mruby supports by calling <code class="docutils literal"><span class="pre">ruby_load</span></code>.</p> <p>Here is an example that just load <code class="docutils literal"><span class="pre">expression.rb</span></code> as Ruby script.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>register ruby/load +<div class="highlight-none"><div class="highlight"><pre><span></span>register ruby/load # [[0, 1337566253.89858, 0.000355720520019531], true] ruby_load "expression.rb" # [[0, 1337566253.89858, 0.000355720520019531], {"value": null}] @@ -124,7 +124,7 @@ and the specification may be changed in the future.</p> <h2>7.3.49.5. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2> <p><code class="docutils literal"><span class="pre">ruby_load</span></code> returns the loaded result with metadata such as exception information (Including metadata isn't implemented yet):</p> -<div class="highlight-none"><div class="highlight"><pre>[HEADER, {"value": LOADED_VALUE}] +<div class="highlight-none"><div class="highlight"><pre><span></span>[HEADER, {"value": LOADED_VALUE}] </pre></div> </div> <p><code class="docutils literal"><span class="pre">HEADER</span></code></p> Modified: docs/reference/commands/schema.html (+23 -23) =================================================================== --- docs/reference/commands/schema.html 2016-03-05 15:09:34 +0900 (e78c307) +++ docs/reference/commands/schema.html 2016-03-17 12:56:59 +0900 (0e0c280) @@ -99,7 +99,7 @@ so on.</p> <div class="section" id="syntax"> <h2>7.3.50.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> <p>This command takes no parameters:</p> -<div class="highlight-none"><div class="highlight"><pre>schema +<div class="highlight-none"><div class="highlight"><pre><span></span>schema </pre></div> </div> </div> @@ -107,7 +107,7 @@ so on.</p> <h2>7.3.50.3. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2> <p>Here is an example schema to show example output:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Memos TABLE_HASH_KEY ShortText +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Memos TABLE_HASH_KEY ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] column_create Memos content COLUMN_SCALAR Text # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -123,7 +123,7 @@ column_create Terms memos_content_index \ </div> <p>Here is an output of <code class="docutils literal"><span class="pre">schema</span></code> command against this example schema:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>schema +<div class="highlight-none"><div class="highlight"><pre><span></span>schema # [ # [ # 0, @@ -421,17 +421,17 @@ column_create Terms memos_content_index \ <p>This section describes all parameters.</p> <div class="section" id="required-parameters"> <h3>7.3.50.4.1. Required parameters<a class="headerlink" href="#required-parameters" title="Permalink to this headline">¶</a></h3> -<p>There is no required parameters.</p> +<p>There is no required parameter.</p> </div> <div class="section" id="optional-parameters"> <h3>7.3.50.4.2. Optional parameters<a class="headerlink" href="#optional-parameters" title="Permalink to this headline">¶</a></h3> -<p>There is no optional parameters.</p> +<p>There is no optional parameter.</p> </div> </div> <div class="section" id="return-value"> <h2>7.3.50.5. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2> <p><code class="docutils literal"><span class="pre">schema</span></code> command returns schema in the database:</p> -<div class="highlight-none"><div class="highlight"><pre>[HEADER, SCHEMA] +<div class="highlight-none"><div class="highlight"><pre><span></span>[HEADER, SCHEMA] </pre></div> </div> <div class="section" id="header"> @@ -441,7 +441,7 @@ column_create Terms memos_content_index \ <div class="section" id="id1"> <h3>7.3.50.5.2. <code class="docutils literal"><span class="pre">SCHEMA</span></code><a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h3> <p><code class="docutils literal"><span class="pre">SCHEMA</span></code> is an object that consists of the following information:</p> -<div class="highlight-none"><div class="highlight"><pre>{ +<div class="highlight-none"><div class="highlight"><pre><span></span>{ "plugins": PLUGINS, "types": TYPES, "tokenizers": TOKENIZERS, @@ -456,7 +456,7 @@ column_create Terms memos_content_index \ <h3>7.3.50.5.3. <code class="docutils literal"><span class="pre">PLUGINS</span></code><a class="headerlink" href="#plugins" title="Permalink to this headline">¶</a></h3> <p><code class="docutils literal"><span class="pre">PLUGINS</span></code> is an object. Its key is plugin name and its value is plugin detail:</p> -<div class="highlight-none"><div class="highlight"><pre>{ +<div class="highlight-none"><div class="highlight"><pre><span></span>{ "PLUGIN_NAME_1": PLUGIN_1, "PLUGIN_NAME_2": PLUGIN_2, ... @@ -468,7 +468,7 @@ plugin detail:</p> <div class="section" id="plugin"> <h3>7.3.50.5.4. <code class="docutils literal"><span class="pre">PLUGIN</span></code><a class="headerlink" href="#plugin" title="Permalink to this headline">¶</a></h3> <p><code class="docutils literal"><span class="pre">PLUGIN</span></code> is an object that describes plugin detail:</p> -<div class="highlight-none"><div class="highlight"><pre>{ +<div class="highlight-none"><div class="highlight"><pre><span></span>{ "name": PLUGIN_NAME } </pre></div> @@ -495,7 +495,7 @@ plugin detail:</p> <h3>7.3.50.5.5. <code class="docutils literal"><span class="pre">TYPES</span></code><a class="headerlink" href="#types" title="Permalink to this headline">¶</a></h3> <p><code class="docutils literal"><span class="pre">TYPES</span></code> is an object. Its key is type name and its value is type detail:</p> -<div class="highlight-none"><div class="highlight"><pre>{ +<div class="highlight-none"><div class="highlight"><pre><span></span>{ "TYPE_NAME_1": TYPE_1, "TYPE_NAME_2": TYPE_2, ... @@ -507,7 +507,7 @@ type detail:</p> <div class="section" id="type"> <h3>7.3.50.5.6. <code class="docutils literal"><span class="pre">TYPE</span></code><a class="headerlink" href="#type" title="Permalink to this headline">¶</a></h3> <p><code class="docutils literal"><span class="pre">TYPE</span></code> is an object that describes type detail:</p> -<div class="highlight-none"><div class="highlight"><pre>{ +<div class="highlight-none"><div class="highlight"><pre><span></span>{ "name": TYPE_NAME, "size": SIZE_OF_ONE_VALUE_IN_BYTE, "can_be_key_type": BOOLEAN, @@ -548,7 +548,7 @@ otherwise.</td> <h3>7.3.50.5.7. <code class="docutils literal"><span class="pre">TOKENIZERS</span></code><a class="headerlink" href="#tokenizers" title="Permalink to this headline">¶</a></h3> <p><code class="docutils literal"><span class="pre">TOKENIZERS</span></code> is an object. Its key is tokenizer name and its value is tokenizer detail:</p> -<div class="highlight-none"><div class="highlight"><pre>{ +<div class="highlight-none"><div class="highlight"><pre><span></span>{ "TOKENIZER_NAME_1": TOKENIZER_1, "TOKENIZER_NAME_2": TOKENIZER_2, ... @@ -560,7 +560,7 @@ is tokenizer detail:</p> <div class="section" id="tokenizer"> <h3>7.3.50.5.8. <code class="docutils literal"><span class="pre">TOKENIZER</span></code><a class="headerlink" href="#tokenizer" title="Permalink to this headline">¶</a></h3> <p><code class="docutils literal"><span class="pre">TOKENIZER</span></code> is an object that describes tokenizer detail:</p> -<div class="highlight-none"><div class="highlight"><pre>{ +<div class="highlight-none"><div class="highlight"><pre><span></span>{ "name": TOKENIZER_NAME } </pre></div> @@ -588,7 +588,7 @@ is tokenizer detail:</p> <h3>7.3.50.5.9. <code class="docutils literal"><span class="pre">NORMALIZERS</span></code><a class="headerlink" href="#normalizers" title="Permalink to this headline">¶</a></h3> <p><code class="docutils literal"><span class="pre">NORMALIZERS</span></code> is an object. Its key is normalizer name and its value is normalizer detail:</p> -<div class="highlight-none"><div class="highlight"><pre>{ +<div class="highlight-none"><div class="highlight"><pre><span></span>{ "NORMALIZER_NAME_1": NORMALIZER_1, "NORMALIZER_NAME_2": NORMALIZER_2, ... @@ -600,7 +600,7 @@ is normalizer detail:</p> <div class="section" id="normalizer"> <h3>7.3.50.5.10. <code class="docutils literal"><span class="pre">NORMALIZER</span></code><a class="headerlink" href="#normalizer" title="Permalink to this headline">¶</a></h3> <p><code class="docutils literal"><span class="pre">NORMALIZER</span></code> is an object that describes normalizer detail:</p> -<div class="highlight-none"><div class="highlight"><pre>{ +<div class="highlight-none"><div class="highlight"><pre><span></span>{ "name": NORMALIZER_NAME } </pre></div> @@ -628,7 +628,7 @@ is normalizer detail:</p> <h3>7.3.50.5.11. <code class="docutils literal"><span class="pre">TOKEN_FILTERS</span></code><a class="headerlink" href="#token-filters" title="Permalink to this headline">¶</a></h3> <p><code class="docutils literal"><span class="pre">TOKEN_FILTERS</span></code> is an object. Its key is token filter name and its value is token filter detail:</p> -<div class="highlight-none"><div class="highlight"><pre>{ +<div class="highlight-none"><div class="highlight"><pre><span></span>{ "TOKEN_FILTER_NAME_1": TOKEN_FILTER_1, "TOKEN_FILTER_NAME_2": TOKEN_FILTER_2, ... @@ -640,7 +640,7 @@ is token filter detail:</p> <div class="section" id="token-filter"> <h3>7.3.50.5.12. <code class="docutils literal"><span class="pre">TOKEN_FILTER</span></code><a class="headerlink" href="#token-filter" title="Permalink to this headline">¶</a></h3> <p><code class="docutils literal"><span class="pre">TOKEN_FILTER</span></code> is an object that describes token filter detail:</p> -<div class="highlight-none"><div class="highlight"><pre>{ +<div class="highlight-none"><div class="highlight"><pre><span></span>{ "name": TOKEN_FILTER_NAME } </pre></div> @@ -668,7 +668,7 @@ is token filter detail:</p> <h3>7.3.50.5.13. <code class="docutils literal"><span class="pre">TABLES</span></code><a class="headerlink" href="#tables" title="Permalink to this headline">¶</a></h3> <p><code class="docutils literal"><span class="pre">TABLES</span></code> is an object. Its key is table name and its value is table detail:</p> -<div class="highlight-none"><div class="highlight"><pre>{ +<div class="highlight-none"><div class="highlight"><pre><span></span>{ "TABLE_NAME_1": TABLE_1, "TABLE_NAME_2": TABLE_2, ... @@ -680,7 +680,7 @@ is table detail:</p> <div class="section" id="table"> <h3>7.3.50.5.14. <code class="docutils literal"><span class="pre">TABLE</span></code><a class="headerlink" href="#table" title="Permalink to this headline">¶</a></h3> <p><code class="docutils literal"><span class="pre">TABLE</span></code> is an object that describes table detail:</p> -<div class="highlight-none"><div class="highlight"><pre>{ +<div class="highlight-none"><div class="highlight"><pre><span></span>{ "name": TABLE_NAME "type": TYPE, "key_type": KEY_TYPE, @@ -825,7 +825,7 @@ is <a class="reference internal" href="#schema-return-value-column"><span>COLUMN <div class="section" id="index"> <span id="schema-return-value-index"></span><h3>7.3.50.5.15. <code class="docutils literal"><span class="pre">INDEX</span></code><a class="headerlink" href="#index" title="Permalink to this headline">¶</a></h3> <p><code class="docutils literal"><span class="pre">INDEX</span></code> is an object that describes index detail:</p> -<div class="highlight-none"><div class="highlight"><pre>{ +<div class="highlight-none"><div class="highlight"><pre><span></span>{ "full_name": INDEX_COLUMN_NAME_WITH_TABLE_NAME, "table": TABLE_NAME, "name": INDEX_COLUMN_NAME, @@ -872,7 +872,7 @@ is <a class="reference internal" href="#schema-return-value-column"><span>COLUMN <span id="schema-return-value-command"></span><h3>7.3.50.5.16. <code class="docutils literal"><span class="pre">COMMAND</span></code><a class="headerlink" href="#command" title="Permalink to this headline">¶</a></h3> <p><code class="docutils literal"><span class="pre">COMMAND</span></code> is an object that describes how to create the table or column:</p> -<div class="highlight-none"><div class="highlight"><pre>{ +<div class="highlight-none"><div class="highlight"><pre><span></span>{ "name": COMMAND_NAME, "arguments": { "KEY_1": "VALUE_1", @@ -917,7 +917,7 @@ is argument value.</p> <div class="section" id="column"> <span id="schema-return-value-column"></span><h3>7.3.50.5.17. <code class="docutils literal"><span class="pre">COLUMN</span></code><a class="headerlink" href="#column" title="Permalink to this headline">¶</a></h3> <p><code class="docutils literal"><span class="pre">COLUMN</span></code> is an object that describes column detail:</p> -<div class="highlight-none"><div class="highlight"><pre>{ +<div class="highlight-none"><div class="highlight"><pre><span></span>{ "name": COLUMN_NAME, "table": TABLE_NAME, "full_name": COLUMN_NAME_WITH_TABLE, @@ -1054,7 +1054,7 @@ empty array.</p> <div class="section" id="source"> <span id="schema-return-value-source"></span><h3>7.3.50.5.18. <code class="docutils literal"><span class="pre">SOURCE</span></code><a class="headerlink" href="#source" title="Permalink to this headline">¶</a></h3> <p><code class="docutils literal"><span class="pre">SOURCE</span></code> is an object that describes source detail:</p> -<div class="highlight-none"><div class="highlight"><pre>{ +<div class="highlight-none"><div class="highlight"><pre><span></span>{ "name": COLUMN_NAME, "table": TABLE_NAME, "full_name": COLUMN_NAME_WITH_TABLE_NAME Modified: docs/reference/commands/select.html (+82 -82) =================================================================== --- docs/reference/commands/select.html 2016-03-05 15:09:34 +0900 (de7099b) +++ docs/reference/commands/select.html 2016-03-17 12:56:59 +0900 (e7a4c46) @@ -98,7 +98,7 @@ understand <code class="docutils literal"><span class="pre">select</span></code> <p>This command takes many parameters.</p> <p>The required parameter is only <code class="docutils literal"><span class="pre">table</span></code>. Other parameters are optional:</p> -<div class="highlight-none"><div class="highlight"><pre>select table +<div class="highlight-none"><div class="highlight"><pre><span></span>select table [match_columns=null] [query=null] [filter=null] @@ -160,7 +160,7 @@ optional:</p> many popular usages.</p> <p>Here are a schema definition and sample data to show usage.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Entries TABLE_HASH_KEY ShortText +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Entries TABLE_HASH_KEY ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] column_create Entries content COLUMN_SCALAR Text # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -214,7 +214,7 @@ using <code class="docutils literal"><span class="pre">TokenBigram</span></code> <p>Here is the most simple usage with the above schema and data. It outputs all records in <code class="docutils literal"><span class="pre">Entries</span></code> table.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries # [ # [ # 0, @@ -315,7 +315,7 @@ conditions. <code class="docutils literal"><span class="pre">match_columns</span matched against <code class="docutils literal"><span class="pre">query</span></code>.</p> <p>Here is a simple <code class="docutils literal"><span class="pre">query</span></code> usage example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --match_columns content --query fast +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --match_columns content --query fast # [ # [ # 0, @@ -379,7 +379,7 @@ in <code class="docutils literal"><span class="pre">content</span></code> column search conditions for <code class="docutils literal"><span class="pre">filter</span></code> as ECMAScript like syntax.</p> <p>Here is a simple <code class="docutils literal"><span class="pre">filter</span></code> usage example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --filter 'content @ "fast" && _key == "Groonga"' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --filter 'content @ "fast" && _key == "Groonga"' # [ # [ # 0, @@ -441,7 +441,7 @@ its details aren't described here. See <p>You can specify range of outputted records by <code class="docutils literal"><span class="pre">offset</span></code> and <code class="docutils literal"><span class="pre">limit</span></code>. Here is an example to output only the 2nd record.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --offset 1 --limit 1 +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --offset 1 --limit 1 # [ # [ # 0, @@ -498,7 +498,7 @@ are matched, <code class="docutils literal"><span class="pre">select</span></cod <p>You can use <code class="docutils literal"><span class="pre">--limit</span> <span class="pre">0</span></code> to retrieve the total number of recrods without any contents of records.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --limit 0 +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --limit 0 # [ # [ # 0, @@ -551,7 +551,7 @@ engine.</p> <p>For example, think about the following situation.</p> <p>You search entries that has <code class="docutils literal"><span class="pre">fast</span></code> word:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --filter 'content @ "fast"' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --filter 'content @ "fast"' # [ # [ # 0, @@ -610,7 +610,7 @@ suitable tag until you see the result of <code class="docutils literal"><span cl <p>If you know the number of matched records of each available tag, you can choose suitable tag. You can use drilldown for the case:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --filter 'content @ "fast"' --drilldown tag +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --filter 'content @ "fast"' --drilldown tag # [ # [ # 0, @@ -704,15 +704,15 @@ in grouped records and so on. See <div class="section" id="parameters"> <h2>7.3.51.4. Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></h2> <p>This section describes all parameters. Parameters are categorized.</p> -<div class="section" id="required-parameter"> -<h3>7.3.51.4.1. Required parameter<a class="headerlink" href="#required-parameter" title="Permalink to this headline">¶</a></h3> +<div class="section" id="required-parameters"> +<h3>7.3.51.4.1. Required parameters<a class="headerlink" href="#required-parameters" title="Permalink to this headline">¶</a></h3> <p>There is a required parameter, <code class="docutils literal"><span class="pre">table</span></code>.</p> <div class="section" id="table"> <span id="select-table"></span><h4>7.3.51.4.1.1. <code class="docutils literal"><span class="pre">table</span></code><a class="headerlink" href="#table" title="Permalink to this headline">¶</a></h4> <p>Specifies a table to be searched. <code class="docutils literal"><span class="pre">table</span></code> must be specified.</p> <p>If nonexistent table is specified, an error is returned.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Nonexistent +<div class="highlight-none"><div class="highlight"><pre><span></span>select Nonexistent # [ # [ # -22, @@ -753,7 +753,7 @@ column gets more hit score rather than a lower weight target column when a record is matched by fulltext search. The default weight is 1.</p> <p>Here is a simple <code class="docutils literal"><span class="pre">match_columns</span></code> usage example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --match_columns content --query fast --output_columns '_key, _score' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --match_columns content --query fast --output_columns '_key, _score' # [ # [ # 0, @@ -802,7 +802,7 @@ fact that <code class="docutils literal"><span class="pre">_score</span></code> <p>To specify weight, <code class="docutils literal"><span class="pre">column</span> <span class="pre">*</span> <span class="pre">weight</span></code> syntax is used. Here is a weight usage example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --match_columns 'content * 2' --query fast --output_columns '_key, _score' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --match_columns 'content * 2' --query fast --output_columns '_key, _score' # [ # [ # 0, @@ -851,7 +851,7 @@ treated as matched.</p> omitted, 1 is used for weight. Here is a one or more columns usage example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --match_columns '_key * 10 || content' --query groonga --output_columns '_key, _score' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --match_columns '_key * 10 || content' --query groonga --output_columns '_key, _score' # [ # [ # 0, @@ -905,7 +905,7 @@ that groonga searches records that contain both <code class="docutils literal">< contain either <code class="docutils literal"><span class="pre">word1</span></code> or <code class="docutils literal"><span class="pre">word2</span></code>.</p> <p>Here is a simple logical and search example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --match_columns content --query "fast groonga" +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --match_columns content --query "fast groonga" # [ # [ # 0, @@ -956,7 +956,7 @@ contain either <code class="docutils literal"><span class="pre">word1</span></co table.</p> <p>Here is a simple logical or search example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --match_columns content --query "groonga OR mroonga" +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --match_columns content --query "groonga OR mroonga" # [ # [ # 0, @@ -1019,7 +1019,7 @@ conditions. For example, <code class="docutils literal"><span class="pre">column value of <code class="docutils literal"><span class="pre">column</span></code> column is less than <code class="docutils literal"><span class="pre">value</span></code>.</p> <p>Here is a simple equality operator search example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --query _key:Groonga +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --query _key:Groonga # [ # [ # 0, @@ -1069,7 +1069,7 @@ value of <code class="docutils literal"><span class="pre">column</span></code> c <code class="docutils literal"><span class="pre">Groonga</span></code> from <code class="docutils literal"><span class="pre">Entries</span></code> table.</p> <p>Here is a simple less than operator search example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --query n_likes:<11 +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --query n_likes:<11 # [ # [ # 0, @@ -1148,14 +1148,14 @@ conditions. <code class="docutils literal"><span class="pre">filter</span></code logical and. It means that matched records should be matched against both <code class="docutils literal"><span class="pre">filter</span></code> and <code class="docutils literal"><span class="pre">query</span></code>.</p> <p><code class="docutils literal"><span class="pre">filter</span></code> parameter is designed for complex conditions. A filter text -should be formated in <a class="reference internal" href="../grn_expr/script_syntax.html"><em>Script syntax</em></a>. The syntax is +should be formatted in <a class="reference internal" href="../grn_expr/script_syntax.html"><em>Script syntax</em></a>. The syntax is similar to ECMAScript. For example, <code class="docutils literal"><span class="pre">column</span> <span class="pre">==</span> <span class="pre">"value"</span></code> means that the value of <code class="docutils literal"><span class="pre">column</span></code> column is equal to <code class="docutils literal"><span class="pre">"value"</span></code>. <code class="docutils literal"><span class="pre">column</span> <span class="pre"><</span> <span class="pre">value</span></code> means that the value of <code class="docutils literal"><span class="pre">column</span></code> column is less than <code class="docutils literal"><span class="pre">value</span></code>.</p> <p>Here is a simple equality operator search example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --filter '_key == "Groonga"' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --filter '_key == "Groonga"' # [ # [ # 0, @@ -1205,7 +1205,7 @@ the value of <code class="docutils literal"><span class="pre">column</span></cod <code class="docutils literal"><span class="pre">Groonga</span></code> from <code class="docutils literal"><span class="pre">Entries</span></code> table.</p> <p>Here is a simple less than operator search example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --filter 'n_likes < 11' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --filter 'n_likes < 11' # [ # [ # 0, @@ -1302,7 +1302,7 @@ first <code class="docutils literal"><span class="pre">select</span></code> does parameter. The second <code class="docutils literal"><span class="pre">select</span></code> has <code class="docutils literal"><span class="pre">match_escalation_threshold</span></code> parameter.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --match_columns content --query groo +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --match_columns content --query groo # [ # [ # 0, @@ -1440,7 +1440,7 @@ default. Be careful about it when you use the flag.</p> <p>The default value is <code class="docutils literal"><span class="pre">ALLOW_PRAGMA|ALLOW_COLUMN</span></code>.</p> <p>Here is a usage example of <code class="docutils literal"><span class="pre">ALLOW_COLUMN</span></code>.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --query content:@mroonga --query_flags ALLOW_COLUMN +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --query content:@mroonga --query_flags ALLOW_COLUMN # [ # [ # 0, @@ -1490,7 +1490,7 @@ default. Be careful about it when you use the flag.</p> <code class="docutils literal"><span class="pre">content</span></code> column value from <code class="docutils literal"><span class="pre">Entries</span></code> table.</p> <p>Here is a usage example of <code class="docutils literal"><span class="pre">ALLOW_UPDATE</span></code>.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Users TABLE_HASH_KEY ShortText +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Users TABLE_HASH_KEY ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] column_create Users age COLUMN_SCALAR UInt32 # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -1585,7 +1585,7 @@ to <code class="docutils literal"><span class="pre">19</span></code>. The second column values.</p> <p>Here is a usage example of <code class="docutils literal"><span class="pre">ALLOW_LEADING_NOT</span></code>.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --match_columns content --query -mroonga --query_flags ALLOW_LEADING_NOT +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --match_columns content --query -mroonga --query_flags ALLOW_LEADING_NOT # [ # [ # 0, @@ -1656,7 +1656,7 @@ column values.</p> in <code class="docutils literal"><span class="pre">content</span></code> column value from <code class="docutils literal"><span class="pre">Entries</span></code> table.</p> <p>Here is a usage example of <code class="docutils literal"><span class="pre">NONE</span></code>.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --match_columns content --query 'mroonga OR _key:Groonga' --query_flags NONE +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --match_columns content --query 'mroonga OR _key:Groonga' --query_flags NONE # [ # [ # 0, @@ -1733,7 +1733,7 @@ query aren't substituted.</p> <p>Here is a sample substitution table to show a simple <code class="docutils literal"><span class="pre">query_expander</span></code> usage example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Thesaurus TABLE_PAT_KEY ShortText --normalizer NormalizerAuto +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Thesaurus TABLE_PAT_KEY ShortText --normalizer NormalizerAuto # [[0, 1337566253.89858, 0.000355720520019531], true] column_create Thesaurus synonym COLUMN_VECTOR ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -1764,7 +1764,7 @@ word. For example, you can implement "stop words" by an empty vector value.</p> <p>Here is a simple <code class="docutils literal"><span class="pre">query_expander</span></code> usage example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --match_columns content --query "mroonga" +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --match_columns content --query "mroonga" # [ # [ # 0, @@ -1922,7 +1922,7 @@ such as <code class="docutils literal"><span class="pre">(...)</span></code> and using those syntax.</p> <p>Here is a complex substitution usage example that uses query syntax.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>load --table Thesaurus +<div class="highlight-none"><div class="highlight"><pre><span></span>load --table Thesaurus [ {"_key": "popular", "synonym": ["popular", "n_likes:>=10"]} ] @@ -1995,7 +1995,7 @@ is equal to or more than <code class="docutils literal"><span class="pre">10</sp <p>Specifies output columns separated by <code class="docutils literal"><span class="pre">,</span></code>.</p> <p>Here is a simple <code class="docutils literal"><span class="pre">output_columns</span></code> usage example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --output_columns '_id, _key' --limit 1 +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --output_columns '_id, _key' --limit 1 # [ # [ # 0, @@ -2032,7 +2032,7 @@ values.</p> <a class="reference internal" href="../columns/pseudo.html"><em>Pseudo column</em></a>.</p> <p>Here is a <code class="docutils literal"><span class="pre">*</span></code> usage example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --output_columns '_key, *' --limit 1 +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --output_columns '_key, *' --limit 1 # [ # [ # 0, @@ -2085,7 +2085,7 @@ values except <code class="docutils literal"><span class="pre">_score</span></co name.</p> <p>Here is a simple <code class="docutils literal"><span class="pre">sortby</span></code> usage example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --sortby 'n_likes, _id' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --sortby 'n_likes, _id' # [ # [ # 0, @@ -2166,7 +2166,7 @@ are the case.</p> <p>If you want to sort in descending order, add <code class="docutils literal"><span class="pre">-</span></code> before column name.</p> <p>Here is a descending order <code class="docutils literal"><span class="pre">sortby</span></code> usage example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --sortby '-n_likes, _id' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --sortby '-n_likes, _id' # [ # [ # 0, @@ -2245,7 +2245,7 @@ order. But ascending order is used for sorting by <code class="docutils literal" <p>You can use <code class="docutils literal"><span class="pre">_score</span></code> pseudo column in <code class="docutils literal"><span class="pre">sortby</span></code> if you use <code class="docutils literal"><span class="pre">query</span></code> or <code class="docutils literal"><span class="pre">filter</span></code> parameter.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --match_columns content --query fast --sortby -_score --output_columns '_key, _score' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --match_columns content --query fast --sortby -_score --output_columns '_key, _score' # [ # [ # 0, @@ -2291,7 +2291,7 @@ it's just ignored but get a warning in log file.</p> zero-based. <code class="docutils literal"><span class="pre">--offset</span> <span class="pre">1</span></code> means output range is started from the 2nd record.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --sortby _id --offset 3 --output_columns _key +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --sortby _id --offset 3 --output_columns _key # [ # [ # 0, @@ -2327,7 +2327,7 @@ record.</p> means 2nd. Remember that offset is zero-based.) record to the 3rd record.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --sortby _id --offset -2 --output_columns _key +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --sortby _id --offset -2 --output_columns _key # [ # [ # 0, @@ -2366,7 +2366,7 @@ number of records is <code class="docutils literal"><span class="pre">5</span></ matched records is less than <code class="docutils literal"><span class="pre">limit</span></code>, all records are outputted.</p> <p>Here is a simple <code class="docutils literal"><span class="pre">limit</span></code> usage example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --sortby _id --offset 2 --limit 3 --output_columns _key +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --sortby _id --offset 2 --limit 3 --output_columns _key # [ # [ # 0, @@ -2404,7 +2404,7 @@ matched records is less than <code class="docutils literal"><span class="pre">li records. It's very useful value to show all records.</p> <p>Here is a simple negative <code class="docutils literal"><span class="pre">limit</span></code> value usage example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --limit -1 +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --limit -1 # [ # [ # 0, @@ -2500,7 +2500,7 @@ key. If you specify no search condition, all records are grouped by each key.</p> <p>Here is a simple <code class="docutils literal"><span class="pre">drilldown</span></code> example:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries \ +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries \ --output_columns _key,tag \ --drilldown tag # [ @@ -2586,7 +2586,7 @@ each key.</p> </div></blockquote> <p>Here is a <code class="docutils literal"><span class="pre">drilldown</span></code> with search condition example:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries \ +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries \ --output_columns _key,tag \ --filter 'n_likes >= 5' \ --drilldown tag @@ -2663,7 +2663,7 @@ each key.</p> </div></blockquote> <p>Here is a <code class="docutils literal"><span class="pre">drilldown</span></code> with multiple group keys example:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries \ +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries \ --limit 0 \ --output_column _id \ --drilldown tag,n_likes @@ -2789,7 +2789,7 @@ sort key is column name.</p> <a class="reference internal" href="../columns/pseudo.html"><em>Pseudo column</em></a>.</p> <p>Here is a simple <code class="docutils literal"><span class="pre">drilldown_sortby</span></code> example:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries \ +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries \ --limit 0 \ --output_column _id \ --drilldown 'tag, n_likes' \ @@ -2896,7 +2896,7 @@ the number of records in the group are the same, these grouped results are sorted by grouped key (= <code class="docutils literal"><span class="pre">_key</span></code> ) in ascending order.</p> <p>The sort keys are used in all group keys specified in <code class="docutils literal"><span class="pre">drilldown</span></code>:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries \ +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries \ --limit 0 \ --output_column _id \ --drilldown 'tag, n_likes' \ @@ -3007,7 +3007,7 @@ drilldown.</p> <p>Specifies output columns for drilldown separated by <code class="docutils literal"><span class="pre">,</span></code>.</p> <p>Here is a <code class="docutils literal"><span class="pre">drilldown_output_columns</span></code> example:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries \ +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries \ --limit 0 \ --output_column _id \ --drilldown tag \ @@ -3077,7 +3077,7 @@ referenced type column.</p> <p>Here are a schema definition and sample data to show drilldown against referenced type column:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Tags TABLE_HASH_KEY ShortText --normalizer NormalizerAuto +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Tags TABLE_HASH_KEY ShortText --normalizer NormalizerAuto # [[0, 1337566253.89858, 0.000355720520019531], true] column_create Tags label COLUMN_SCALAR ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -3107,7 +3107,7 @@ type column.</p> <p>You can refer <code class="docutils literal"><span class="pre">Tags.label</span></code> by <code class="docutils literal"><span class="pre">label</span></code> in <code class="docutils literal"><span class="pre">drilldown_output_columns</span></code>:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Items \ +<div class="highlight-none"><div class="highlight"><pre><span></span>select Items \ --limit 0 \ --output_column _id \ --drilldown tag \ @@ -3167,7 +3167,7 @@ type column.</p> </div> <p>You can use <code class="docutils literal"><span class="pre">*</span></code> to refer all columns in referenced table (= <code class="docutils literal"><span class="pre">Tags</span></code>):</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Items \ +<div class="highlight-none"><div class="highlight"><pre><span></span>select Items \ --limit 0 \ --output_column _id \ --drilldown tag \ @@ -3247,7 +3247,7 @@ records. Offset is zero-based. <code class="docutils literal"><span class="pre"> range is started from the 2nd record.</p> <p>Here is a <code class="docutils literal"><span class="pre">drilldown_offset</span></code> example:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries \ +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries \ --limit 0 \ --output_column _id \ --drilldown tag \ @@ -3321,7 +3321,7 @@ range is started from the 2nd record.</p> (<code class="docutils literal"><span class="pre">3</span> <span class="pre">+</span> <span class="pre">-2</span> <span class="pre">=</span> <span class="pre">1</span></code>. <code class="docutils literal"><span class="pre">1</span></code> means 2nd. Remember that offset is zero-based.) grouped result to the 3rd grouped result.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries \ +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries \ --limit 0 \ --output_column _id \ --drilldown tag \ @@ -3398,7 +3398,7 @@ total number of grouped results is <code class="docutils literal"><span class="p groups is less than <code class="docutils literal"><span class="pre">drilldown_limit</span></code>, all groups are outputted.</p> <p>Here is a <code class="docutils literal"><span class="pre">drilldown_limit</span></code> example:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries \ +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries \ --limit 0 \ --output_column _id \ --drilldown tag \ @@ -3472,7 +3472,7 @@ groups is less than <code class="docutils literal"><span class="pre">drilldown_l all groups. It's very useful value to show all groups.</p> <p>Here is a negative <code class="docutils literal"><span class="pre">drilldown_limit</span></code> value example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries \ +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries \ --limit 0 \ --output_column _id \ --drilldown tag \ @@ -3609,7 +3609,7 @@ grouped records.</td> </table> <p>Here is a <code class="docutils literal"><span class="pre">MAX</span></code> example:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries \ +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries \ --limit -1 \ --output_column _id,n_likes \ --drilldown tag \ @@ -3723,7 +3723,7 @@ for the group. It uses <code class="docutils literal"><span class="pre">_max</sp read the maximum <code class="docutils literal"><span class="pre">n_likes</span></code> column value.</p> <p>Here is a <code class="docutils literal"><span class="pre">MIN</span></code> example:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries \ +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries \ --limit -1 \ --output_column _id,n_likes \ --drilldown tag \ @@ -3837,7 +3837,7 @@ for the group. It uses <code class="docutils literal"><span class="pre">_min</sp read the minimum <code class="docutils literal"><span class="pre">n_likes</span></code> column value.</p> <p>Here is a <code class="docutils literal"><span class="pre">SUM</span></code> example:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries \ +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries \ --limit -1 \ --output_column _id,n_likes \ --drilldown tag \ @@ -3951,7 +3951,7 @@ group. It uses <code class="docutils literal"><span class="pre">_sum</span></cod summed <code class="docutils literal"><span class="pre">n_likes</span></code> column values.</p> <p>Here is a <code class="docutils literal"><span class="pre">AVG</span></code> example:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries \ +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries \ --limit -1 \ --output_column _id,n_likes \ --drilldown tag \ @@ -4065,7 +4065,7 @@ the group. It uses <code class="docutils literal"><span class="pre">_avg</span>< the averaged <code class="docutils literal"><span class="pre">n_likes</span></code> column values.</p> <p>Here is an example that uses all calculation types:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries \ +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries \ --limit -1 \ --output_column _id,n_likes \ --drilldown tag \ @@ -4308,7 +4308,7 @@ drilldowns. But it can specify multiple keys for one drilldown.</p> <p>Here is an example to group by multiple keys, <code class="docutils literal"><span class="pre">tag</span></code> and <code class="docutils literal"><span class="pre">n_likes</span></code> column values:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries \ +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries \ --limit -1 \ --output_column tag,n_likes \ --drilldown[tag.n_likes].keys tag,n_likes \ @@ -4450,7 +4450,7 @@ only one group key by <a class="reference internal" href="#select-drilldown-labe <p>Here is an example to refer single group key by <code class="docutils literal"><span class="pre">_key</span></code> <a class="reference internal" href="../columns/pseudo.html"><em>Pseudo column</em></a>:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries \ +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries \ --limit 0 \ --output_column _id \ --drilldown[tag.n_likes].keys tag,n_likes \ @@ -4534,7 +4534,7 @@ used for group key in <a class="reference internal" href="#select-drilldown-labe <p>Here is an example to refer each group key in multiple group keys by <code class="docutils literal"><span class="pre">_value.${KEY_NAME}</span></code> syntax:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries \ +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries \ --limit 0 \ --output_column _id \ --drilldown[tag.n_likes].keys tag,n_likes \ @@ -4635,7 +4635,7 @@ array to output multiple drilldown results. <a class="reference internal" href="#select-drilldown-label-keys"><span>drilldown[${LABEL}].keys</span></a> uses pairs of label and drilldown result.</p> <p><a class="reference internal" href="#select-drilldown"><span>drilldown</span></a> uses the following output format:</p> -<div class="highlight-none"><div class="highlight"><pre>[ +<div class="highlight-none"><div class="highlight"><pre><span></span>[ HEADER, [ SEARCH_RESULT, @@ -4647,7 +4647,7 @@ result.</p> </pre></div> </div> <p><a class="reference internal" href="#select-drilldown-label-keys"><span>drilldown[${LABEL}].keys</span></a> uses the following output format:</p> -<div class="highlight-none"><div class="highlight"><pre>[ +<div class="highlight-none"><div class="highlight"><pre><span></span>[ HEADER, [ SEARCH_RESULT, @@ -4693,7 +4693,7 @@ It's the default value.</td> </table> <p>Here is an example to disable caching the result of this query:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --cache no +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --cache no # [ # [ # 0, @@ -4783,11 +4783,11 @@ use <code class="docutils literal"><span class="pre">adjuster</span></code> to s <p>For example, you can use <code class="docutils literal"><span class="pre">adjuster</span></code> to increase score of records that have <code class="docutils literal"><span class="pre">groonga</span></code> tag.</p> <p>Here is the syntax:</p> -<div class="highlight-none"><div class="highlight"><pre>--adjuster "SCORE_ADJUST_EXPRESSION1 + SCORE_ADJUST_EXPRESSION2 + ..." +<div class="highlight-none"><div class="highlight"><pre><span></span>--adjuster "SCORE_ADJUST_EXPRESSION1 + SCORE_ADJUST_EXPRESSION2 + ..." </pre></div> </div> <p>Here is the <code class="docutils literal"><span class="pre">SCORE_ADJUST_EXPRESSION</span></code> syntax:</p> -<div class="highlight-none"><div class="highlight"><pre>COLUMN @ "KEYWORD" * FACTOR +<div class="highlight-none"><div class="highlight"><pre><span></span>COLUMN @ "KEYWORD" * FACTOR </pre></div> </div> <p>Note the following:</p> @@ -4801,7 +4801,7 @@ that have <code class="docutils literal"><span class="pre">groonga</span></code> <p>Here is a sample <code class="docutils literal"><span class="pre">adjuster</span></code> usage example that uses just one <code class="docutils literal"><span class="pre">SCORE_ADJUST_EXPRESSION</span></code>:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries \ +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries \ --filter true \ --adjuster 'content @ "groonga" * 5' \ --output_columns _key,content,_score @@ -4868,7 +4868,7 @@ record that its key is <code class="docutils literal"><span class="pre">"Gr <p>You can omit <code class="docutils literal"><span class="pre">FACTOR</span></code>. If you omit <code class="docutils literal"><span class="pre">FACTOR</span></code>, it is treated as 1.</p> <p>Here is a sample <code class="docutils literal"><span class="pre">adjuster</span></code> usage example that omits <code class="docutils literal"><span class="pre">FACTOR</span></code>:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries \ +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries \ --filter true \ --adjuster 'content @ "groonga"' \ --output_columns _key,content,_score @@ -4934,7 +4934,7 @@ key is <code class="docutils literal"><span class="pre">"Groonga"</spa <p>Here is a sample <code class="docutils literal"><span class="pre">adjuster</span></code> usage example that uses multiple <code class="docutils literal"><span class="pre">SCORE_ADJUST_EXPRESSION</span></code>:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries \ +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries \ --filter true \ --adjuster 'content @ "groonga" * 5 + content @ "started" * 3' \ --output_columns _key,content,_score @@ -5015,7 +5015,7 @@ the same <code class="docutils literal"><span class="pre">"KEYWORD"</s <div class="section" id="return-value"> <span id="select-return-value"></span><h2>7.3.51.5. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2> <p><code class="docutils literal"><span class="pre">select</span></code> returns response with the following format:</p> -<div class="highlight-none"><div class="highlight"><pre>[ +<div class="highlight-none"><div class="highlight"><pre><span></span>[ HEADER, [ SEARCH_RESULT, @@ -5032,7 +5032,7 @@ the same <code class="docutils literal"><span class="pre">"KEYWORD"</s <p>There are zero or more <code class="docutils literal"><span class="pre">DRILLDOWN_RESULT</span></code>. If no <code class="docutils literal"><span class="pre">drilldown</span></code> and <code class="docutils literal"><span class="pre">drilldown[${LABEL}].keys</span></code> are specified, they are omitted like the following:</p> -<div class="highlight-none"><div class="highlight"><pre>[ +<div class="highlight-none"><div class="highlight"><pre><span></span>[ HEADER, [ SEARCH_RESULT @@ -5042,7 +5042,7 @@ following:</p> </div> <p>If <code class="docutils literal"><span class="pre">drilldown</span></code> has two or more keys like <code class="docutils literal"><span class="pre">--drilldown</span> <span class="pre">"_key,</span> <span class="pre">column1,</span> <span class="pre">column2"</span></code>, multiple <code class="docutils literal"><span class="pre">DRILLDOWN_RESULT</span></code> exist:</p> -<div class="highlight-none"><div class="highlight"><pre>[ +<div class="highlight-none"><div class="highlight"><pre><span></span>[ HEADER, [ SEARCH_RESULT, @@ -5055,7 +5055,7 @@ following:</p> </div> <p>If <code class="docutils literal"><span class="pre">drilldown[${LABEL}].keys</span></code> is used, only one <code class="docutils literal"><span class="pre">DRILLDOWN_RESULT</span></code> exist:</p> -<div class="highlight-none"><div class="highlight"><pre>[ +<div class="highlight-none"><div class="highlight"><pre><span></span>[ HEADER, [ SEARCH_RESULT, @@ -5067,7 +5067,7 @@ exist:</p> <p><code class="docutils literal"><span class="pre">DRILLDOWN_RESULT</span></code> format is different between <code class="docutils literal"><span class="pre">drilldown</span></code> and <code class="docutils literal"><span class="pre">drilldown[${LABEL}].keys</span></code>. It's described later.</p> <p><code class="docutils literal"><span class="pre">SEARCH_RESULT</span></code> is the following format:</p> -<div class="highlight-none"><div class="highlight"><pre>[ +<div class="highlight-none"><div class="highlight"><pre><span></span>[ [N_HITS], COLUMNS, RECORDS @@ -5079,7 +5079,7 @@ exist:</p> is applied.</p> <p><code class="docutils literal"><span class="pre">COLUMNS</span></code> describes about output columns specified by <a class="reference internal" href="#select-output-columns"><span>output_columns</span></a>. It uses the following format:</p> -<div class="highlight-none"><div class="highlight"><pre>[ +<div class="highlight-none"><div class="highlight"><pre><span></span>[ [COLUMN_NAME_1, COLUMN_TYPE_1], [COLUMN_NAME_2, COLUMN_TYPE_2], ..., @@ -5105,7 +5105,7 @@ by whether real column value is array or not.</p> function call in <a class="reference internal" href="#select-output-columns"><span>output_columns</span></a> such as <code class="docutils literal"><span class="pre">--output_columns</span> <span class="pre">"snippet_html(content)"</span></code> uses <code class="docutils literal"><span class="pre">null</span></code>.</p> <p>Here is an example of <code class="docutils literal"><span class="pre">COLUMNS</span></code>:</p> -<div class="highlight-none"><div class="highlight"><pre>[ +<div class="highlight-none"><div class="highlight"><pre><span></span>[ ["_id", "UInt32"], ["_key", "ShortText"], ["n_likes", "UInt32"], @@ -5115,7 +5115,7 @@ function call in <a class="reference internal" href="#select-output-columns"><sp <p><code class="docutils literal"><span class="pre">RECORDS</span></code> includes column values for each matched record. Included records are selected by <a class="reference internal" href="#select-offset"><span>offset</span></a> and <a class="reference internal" href="#select-limit"><span>limit</span></a>. It uses the following format:</p> -<div class="highlight-none"><div class="highlight"><pre>[ +<div class="highlight-none"><div class="highlight"><pre><span></span>[ [ RECORD_1_COLUMN_1, RECORD_1_COLUMN_2, @@ -5139,7 +5139,7 @@ records are selected by <a class="reference internal" href="#select-offset"><spa </pre></div> </div> <p>Here is an example <code class="docutils literal"><span class="pre">RECORDS</span></code>:</p> -<div class="highlight-none"><div class="highlight"><pre>[ +<div class="highlight-none"><div class="highlight"><pre><span></span>[ [ 1, "The first post!", @@ -5161,7 +5161,7 @@ records are selected by <a class="reference internal" href="#select-offset"><spa <p><code class="docutils literal"><span class="pre">DRILLDOWN_RESULT</span></code> format is different between <code class="docutils literal"><span class="pre">drilldown</span></code> and <code class="docutils literal"><span class="pre">drilldown[${LABEL}].keys</span></code>.</p> <p><code class="docutils literal"><span class="pre">drilldown</span></code> uses the same format as <code class="docutils literal"><span class="pre">SEARCH_RESULT</span></code>:</p> -<div class="highlight-none"><div class="highlight"><pre>[ +<div class="highlight-none"><div class="highlight"><pre><span></span>[ [N_HITS], COLUMNS, RECORDS @@ -5173,7 +5173,7 @@ records are selected by <a class="reference internal" href="#select-offset"><spa <p><code class="docutils literal"><span class="pre">drilldown[${LABEL}].keys</span></code> uses the following format. Multiple <code class="docutils literal"><span class="pre">drilldown[${LABEL}].keys</span></code> are mapped to one object (key-value pairs):</p> -<div class="highlight-none"><div class="highlight"><pre>{ +<div class="highlight-none"><div class="highlight"><pre><span></span>{ "LABEL_1": [ [N_HITS], COLUMNS, @@ -5194,7 +5194,7 @@ pairs):</p> </pre></div> </div> <p>Each <code class="docutils literal"><span class="pre">drilldown[${LABEL}].keys</span></code> corresponds to the following:</p> -<div class="highlight-none"><div class="highlight"><pre>"LABEL": [ +<div class="highlight-none"><div class="highlight"><pre><span></span>"LABEL": [ [N_HITS], COLUMNS, RECORDS @@ -5202,7 +5202,7 @@ pairs):</p> </pre></div> </div> <p>The following value part is the same format as <code class="docutils literal"><span class="pre">SEARCH_RESULT</span></code>:</p> -<div class="highlight-none"><div class="highlight"><pre>[ +<div class="highlight-none"><div class="highlight"><pre><span></span>[ [N_HITS], COLUMNS, RECORDS @@ -5247,7 +5247,7 @@ pairs):</p> </ul> </li> <li><a class="reference internal" href="#parameters">7.3.51.4. Parameters</a><ul> -<li><a class="reference internal" href="#required-parameter">7.3.51.4.1. Required parameter</a><ul> +<li><a class="reference internal" href="#required-parameters">7.3.51.4.1. Required parameters</a><ul> <li><a class="reference internal" href="#table">7.3.51.4.1.1. <code class="docutils literal"><span class="pre">table</span></code></a></li> </ul> </li> Modified: docs/reference/commands/shutdown.html (+90 -9) =================================================================== --- docs/reference/commands/shutdown.html 2016-03-05 15:09:34 +0900 (6f2b2a1) +++ docs/reference/commands/shutdown.html 2016-03-17 12:56:59 +0900 (ce98527) @@ -88,30 +88,104 @@ <h1>7.3.52. <code class="docutils literal"><span class="pre">shutdown</span></code><a class="headerlink" href="#shutdown" title="Permalink to this headline">¶</a></h1> <div class="section" id="summary"> <h2>7.3.52.1. Summary<a class="headerlink" href="#summary" title="Permalink to this headline">¶</a></h2> -<p>shutdown - サーバプロセスの停止</p> -<p>Groonga組込コマンドの一つであるshutdownについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入 -力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。</p> -<p>shutdownは、接続しているgroongaサーバプロセスを停止します。</p> +<p><code class="docutils literal"><span class="pre">shutdown</span></code> stops the Groonga server process.</p> +<p><code class="docutils literal"><span class="pre">shutdown</span></code> uses graceful shutdown by default. If there are some +running commands, the Groonga server process stops after these running +commands are finished. New command requests aren't processed after +<code class="docutils literal"><span class="pre">shutdown</span></code> command is executed.</p> +<div class="versionadded"> +<p><span class="versionmodified">New in version 6.0.1: </span><code class="docutils literal"><span class="pre">shutdown</span></code> uses immediate shutdown by specifying <code class="docutils literal"><span class="pre">immediate</span></code> to +<code class="docutils literal"><span class="pre">mode</span></code> parameter. The Groonga server process stops immediately +even when there are some running commands.</p> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p class="last">You need to set <a class="reference internal" href="../command/request_id.html"><em>Request ID</em></a> to all +requests to use immediate shutdown.</p> +</div> +</div> </div> <div class="section" id="syntax"> <h2>7.3.52.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> -<div class="highlight-none"><div class="highlight"><pre>shutdown +<p>This command takes only one optional parameter:</p> +<div class="highlight-none"><div class="highlight"><pre><span></span>shutdown [mode=graceful] </pre></div> </div> </div> <div class="section" id="usage"> <h2>7.3.52.3. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2> -<div class="highlight-none"><div class="highlight"><pre>shutdown +<p><code class="docutils literal"><span class="pre">shutdown</span></code> use graceful shutdown by default:</p> +<p>Execution example:</p> +<div class="highlight-none"><div class="highlight"><pre><span></span>shutdown +# [[0, 1337566253.89858, 0.000355720520019531], true] +</pre></div> +</div> +<p>You can specify <code class="docutils literal"><span class="pre">graceful</span></code> to <code class="docutils literal"><span class="pre">mode</span></code> parameter explicitly:</p> +<p>Execution example:</p> +<div class="highlight-none"><div class="highlight"><pre><span></span>shutdown --mode graceful +# [[0, 1337566253.89858, 0.000355720520019531], true] </pre></div> </div> +<p>You can choose immediate shutdown by specifying <code class="docutils literal"><span class="pre">immediate</span></code> to +<code class="docutils literal"><span class="pre">mode</span></code> parameter:</p> +<p>Execution example:</p> +<div class="highlight-none"><div class="highlight"><pre><span></span>shutdown --mode immediate +# [[0, 1337566253.89858, 0.000355720520019531], true] +</pre></div> +</div> +<p>Immediate shutdown is useful when you don't have time for graceful +shutdown. For example, Windows kills service that takes long time to +stop on Windows shutdown.</p> </div> <div class="section" id="parameters"> <h2>7.3.52.4. Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></h2> -<p>ありません。</p> +<p>This section describes parameters of this command.</p> +<div class="section" id="required-parameters"> +<h3>7.3.52.4.1. Required parameters<a class="headerlink" href="#required-parameters" title="Permalink to this headline">¶</a></h3> +<p>There is no required parameter.</p> +</div> +<div class="section" id="optional-parameters"> +<h3>7.3.52.4.2. Optional parameters<a class="headerlink" href="#optional-parameters" title="Permalink to this headline">¶</a></h3> +<p>There are optional parameters.</p> +<div class="section" id="mode"> +<h4>7.3.52.4.2.1. <code class="docutils literal"><span class="pre">mode</span></code><a class="headerlink" href="#mode" title="Permalink to this headline">¶</a></h4> +<p>Specifies shutdown mode. Here are available shutdown modes:</p> +<table border="1" class="docutils"> +<colgroup> +<col width="50%" /> +<col width="50%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Value</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">graceful</span></code></td> +<td><p class="first">Stops after running commands are finished.</p> +<p class="last">This is the default.</p> +</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">immediate</span></code></td> +<td><div class="first last versionadded"> +<p><span class="versionmodified">New in version 6.0.1: </span>Stops immediately even if there are some running commands.</p> +</div> +</td> +</tr> +</tbody> +</table> +</div> +</div> </div> <div class="section" id="return-value"> <h2>7.3.52.5. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2> -<p>ありません。</p> +<p><code class="docutils literal"><span class="pre">shutdown</span></code> returns <code class="docutils literal"><span class="pre">true</span></code> as body when shutdown is +accepted:</p> +<div class="highlight-none"><div class="highlight"><pre><span></span>[HEADER, true] +</pre></div> +</div> +<p>If <code class="docutils literal"><span class="pre">shutdown</span></code> doesn't accept shutdown, error details are in +<code class="docutils literal"><span class="pre">HEADER</span></code>.</p> +<p>See <a class="reference internal" href="../command/output_format.html"><em>Output format</em></a> for <code class="docutils literal"><span class="pre">HEADER</span></code>.</p> </div> </div> @@ -127,7 +201,14 @@ <li><a class="reference internal" href="#summary">7.3.52.1. Summary</a></li> <li><a class="reference internal" href="#syntax">7.3.52.2. Syntax</a></li> <li><a class="reference internal" href="#usage">7.3.52.3. Usage</a></li> -<li><a class="reference internal" href="#parameters">7.3.52.4. Parameters</a></li> +<li><a class="reference internal" href="#parameters">7.3.52.4. Parameters</a><ul> +<li><a class="reference internal" href="#required-parameters">7.3.52.4.1. Required parameters</a></li> +<li><a class="reference internal" href="#optional-parameters">7.3.52.4.2. Optional parameters</a><ul> +<li><a class="reference internal" href="#mode">7.3.52.4.2.1. <code class="docutils literal"><span class="pre">mode</span></code></a></li> +</ul> +</li> +</ul> +</li> <li><a class="reference internal" href="#return-value">7.3.52.5. Return value</a></li> </ul> </li> Modified: docs/reference/commands/status.html (+5 -5) =================================================================== --- docs/reference/commands/status.html 2016-03-05 15:09:34 +0900 (501fc22) +++ docs/reference/commands/status.html 2016-03-17 12:56:59 +0900 (1362b12) @@ -96,7 +96,7 @@ created for each thread.</p> <div class="section" id="syntax"> <h2>7.3.53.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> <p>This command takes no parameters:</p> -<div class="highlight-none"><div class="highlight"><pre>status +<div class="highlight-none"><div class="highlight"><pre><span></span>status </pre></div> </div> </div> @@ -104,7 +104,7 @@ created for each thread.</p> <span id="status-usage"></span><h2>7.3.53.3. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2> <p>Here is a simple example:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>status +<div class="highlight-none"><div class="highlight"><pre><span></span>status # [ # [ # 0, @@ -134,17 +134,17 @@ request. See <a class="reference internal" href="#status-return-value"><span>Ret <p>This section describes all parameters.</p> <div class="section" id="required-parameters"> <h3>7.3.53.4.1. Required parameters<a class="headerlink" href="#required-parameters" title="Permalink to this headline">¶</a></h3> -<p>There is no required parameters.</p> +<p>There is no required parameter.</p> </div> <div class="section" id="optional-parameters"> <h3>7.3.53.4.2. Optional parameters<a class="headerlink" href="#optional-parameters" title="Permalink to this headline">¶</a></h3> -<p>There is no optional parameters.</p> +<p>There is no optional parameter.</p> </div> </div> <div class="section" id="return-value"> <span id="status-return-value"></span><h2>7.3.53.5. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2> <p>The command returns the current status as an object:</p> -<div class="highlight-none"><div class="highlight"><pre>[ +<div class="highlight-none"><div class="highlight"><pre><span></span>[ HEADER, { "alloc_count": ALLOC_COUNT, Modified: docs/reference/commands/suggest.html (+13 -13) =================================================================== --- docs/reference/commands/suggest.html 2016-03-05 15:09:34 +0900 (784091a) +++ docs/reference/commands/suggest.html 2016-03-17 12:56:59 +0900 (956b8d8) @@ -101,7 +101,7 @@ correction and suggestion.</p> </div> <div class="section" id="syntax"> <h2>7.3.54.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> -<div class="highlight-none"><div class="highlight"><pre>suggest types table column query [sortby [output_columns [offset [limit [frequency_threshold [conditional_probability_threshold [prefix_search]]]]]]] +<div class="highlight-none"><div class="highlight"><pre><span></span>suggest types table column query [sortby [output_columns [offset [limit [frequency_threshold [conditional_probability_threshold [prefix_search]]]]]]] </pre></div> </div> </div> @@ -109,7 +109,7 @@ correction and suggestion.</p> <h2>7.3.54.3. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2> <p>Here are learned data for completion.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>load --table event_query --each 'suggest_preparer(_id, type, item, sequence, time, pair_query)' +<div class="highlight-none"><div class="highlight"><pre><span></span>load --table event_query --each 'suggest_preparer(_id, type, item, sequence, time, pair_query)' [ {"sequence": "1", "time": 1312950803.86057, "item": "e"}, {"sequence": "1", "time": 1312950803.96857, "item": "en"}, @@ -123,7 +123,7 @@ correction and suggestion.</p> </div> <p>Here are learned data for correction.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>load --table event_query --each 'suggest_preparer(_id, type, item, sequence, time, pair_query)' +<div class="highlight-none"><div class="highlight"><pre><span></span>load --table event_query --each 'suggest_preparer(_id, type, item, sequence, time, pair_query)' [ {"sequence": "2", "time": 1312950803.86057, "item": "s"}, {"sequence": "2", "time": 1312950803.96857, "item": "sa"}, @@ -139,7 +139,7 @@ correction and suggestion.</p> </div> <p>Here are learned data for suggestion.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>load --table event_query --each 'suggest_preparer(_id, type, item, sequence, time, pair_query)' +<div class="highlight-none"><div class="highlight"><pre><span></span>load --table event_query --each 'suggest_preparer(_id, type, item, sequence, time, pair_query)' [ {"sequence": "3", "time": 1312950803.86057, "item": "search engine", "type": "submit"}, {"sequence": "3", "time": 1312950808.86057, "item": "web search realtime", "type": "submit"} @@ -149,7 +149,7 @@ correction and suggestion.</p> </div> <p>Here is a completion example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>suggest --table item_query --column kana --types complete --frequency_threshold 1 --query en +<div class="highlight-none"><div class="highlight"><pre><span></span>suggest --table item_query --column kana --types complete --frequency_threshold 1 --query en # [ # [ # 0, @@ -182,7 +182,7 @@ correction and suggestion.</p> </div> <p>Here is a correction example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>suggest --table item_query --column kana --types correct --frequency_threshold 1 --query saerch +<div class="highlight-none"><div class="highlight"><pre><span></span>suggest --table item_query --column kana --types correct --frequency_threshold 1 --query saerch # [ # [ # 0, @@ -215,7 +215,7 @@ correction and suggestion.</p> </div> <p>Here is a suggestion example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>suggest --table item_query --column kana --types suggest --frequency_threshold 1 --query search +<div class="highlight-none"><div class="highlight"><pre><span></span>suggest --table item_query --column kana --types suggest --frequency_threshold 1 --query search # [ # [ # 0, @@ -252,7 +252,7 @@ correction and suggestion.</p> </div> <p>Here is a mixed example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>suggest --table item_query --column kana --types complete|correct|suggest --frequency_threshold 1 --query search +<div class="highlight-none"><div class="highlight"><pre><span></span>suggest --table item_query --column kana --types complete|correct|suggest --frequency_threshold 1 --query search # [ # [ # 0, @@ -351,15 +351,15 @@ command.</p> Here are examples:</p> <blockquote class="last"> <div><p>It returns correction:</p> -<div class="highlight-none"><div class="highlight"><pre>correct +<div class="highlight-none"><div class="highlight"><pre><span></span>correct </pre></div> </div> <p>It returns correction and suggestion:</p> -<div class="highlight-none"><div class="highlight"><pre>correct|suggest +<div class="highlight-none"><div class="highlight"><pre><span></span>correct|suggest </pre></div> </div> <p>It returns complete, correction and suggestion:</p> -<div class="highlight-none"><div class="highlight"><pre>complete|correct|suggest +<div class="highlight-none"><div class="highlight"><pre><span></span>complete|correct|suggest </pre></div> </div> </div></blockquote> @@ -368,7 +368,7 @@ Here are examples:</p> <dd><p class="first">Specifies table name that has <code class="docutils literal"><span class="pre">item_${DATA_SET_NAME}</span></code> format. For example, <code class="docutils literal"><span class="pre">item_query</span></code> is a table name if you created dataset by the following command:</p> -<div class="last highlight-none"><div class="highlight"><pre>groonga-suggest-create-dataset /tmp/db-path query +<div class="last highlight-none"><div class="highlight"><pre><span></span>groonga-suggest-create-dataset /tmp/db-path query </pre></div> </div> </dd> @@ -474,7 +474,7 @@ find any records.</dd> <div class="section" id="return-value"> <h2>7.3.54.5. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2> <p>Here is a returned JSON format:</p> -<div class="highlight-none"><div class="highlight"><pre>{"type1": [["candidate1", score of candidate1], +<div class="highlight-none"><div class="highlight"><pre><span></span>{"type1": [["candidate1", score of candidate1], ["candidate2", score of candidate2], ...], "type2": [["candidate1", score of candidate1], Modified: docs/reference/commands/table_create.html (+48 -23) =================================================================== --- docs/reference/commands/table_create.html 2016-03-05 15:09:34 +0900 (3f09dd5) +++ docs/reference/commands/table_create.html 2016-03-17 12:56:59 +0900 (76fd72e) @@ -95,7 +95,7 @@ to create one or more tables to store and search data.</p> <h2>7.3.55.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> <p>This command takes many parameters.</p> <p>The required parameter is only <code class="docutils literal"><span class="pre">name</span></code> and otehrs are optional:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create name +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create name [flags=TABLE_HASH_KEY] [key_type=null] [value_type=null] @@ -116,7 +116,7 @@ to create one or more tables to store and search data.</p> <p>Table type is specified as <code class="docutils literal"><span class="pre">TABLE_${TYPE}</span></code> to <code class="docutils literal"><span class="pre">flags</span></code> parameter.</p> <p>Here is an example to create <code class="docutils literal"><span class="pre">TABLE_NO_KEY</span></code> table:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Logs TABLE_NO_KEY +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Logs TABLE_NO_KEY # [[0, 1337566253.89858, 0.000355720520019531], true] </pre></div> </div> @@ -129,14 +129,33 @@ and small table. Storing logs into Groonga database is the case.</p> columns, <code class="docutils literal"><span class="pre">TABLE_NO_KEY</span></code> type isn't suitable. Lexicon for fulltext search is the case.</p> </div> +<div class="section" id="create-large-data-store-table"> +<h3>7.3.55.3.2. Create large data store table<a class="headerlink" href="#create-large-data-store-table" title="Permalink to this headline">¶</a></h3> +<p>If you want to store many large keys, your table may not be able to +store them. If total key data is larger than 4GiB, you can't store all +key data into your table by default.</p> +<p>You can expand the maximum total key size to 1TiB from 4GiB by +<code class="docutils literal"><span class="pre">KEY_LARGE</span></code> flag. <code class="docutils literal"><span class="pre">KEY_LARGE</span></code> flag can be used with only +<code class="docutils literal"><span class="pre">TABLE_HASH_KEY</span></code>. You can't use <code class="docutils literal"><span class="pre">KEY_LARGE</span></code> flag with +<code class="docutils literal"><span class="pre">TABLE_NO_KEY</span></code>, <code class="docutils literal"><span class="pre">TABLE_PAT_KEY</span></code> nor <code class="docutils literal"><span class="pre">TABLE_DAT_KEY</span></code>.</p> +<p>Here is an example to create a table that can store many large keys:</p> +<p>Execution example:</p> +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Paths TABLE_HASH_KEY|KEY_LARGE ShortText +# [[0, 1337566253.89858, 0.000355720520019531], true] +</pre></div> +</div> +<p>The <code class="docutils literal"><span class="pre">table_create</span></code> command creates a table that is named <code class="docutils literal"><span class="pre">Paths</span></code> +and is <code class="docutils literal"><span class="pre">TABLE_HASH_KEY</span></code> type. The <code class="docutils literal"><span class="pre">Paths</span></code> table can store many +large keys.</p> +</div> <div class="section" id="create-lexicon-table"> -<h3>7.3.55.3.2. Create lexicon table<a class="headerlink" href="#create-lexicon-table" title="Permalink to this headline">¶</a></h3> +<h3>7.3.55.3.3. Create lexicon table<a class="headerlink" href="#create-lexicon-table" title="Permalink to this headline">¶</a></h3> <p>You can use all table types except <code class="docutils literal"><span class="pre">TABLE_NO_KEY</span></code> for lexicon table. Lexicon table needs key support but <code class="docutils literal"><span class="pre">TABLE_NO_KEY</span></code> doesn't support key.</p> <p>Here is an example to create <code class="docutils literal"><span class="pre">TABLE_PAT_KEY</span></code> table:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Lexicon TABLE_PAT_KEY ShortText --default_tokenizer TokenBigram --normalizer NormalizerAuto +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Lexicon TABLE_PAT_KEY ShortText --default_tokenizer TokenBigram --normalizer NormalizerAuto # [[0, 1337566253.89858, 0.000355720520019531], true] </pre></div> </div> @@ -164,13 +183,13 @@ that has many keys. <code class="docutils literal"><span class="pre">TABLE_PAT_K for lexicon table.</p> </div> <div class="section" id="create-tag-index-table"> -<h3>7.3.55.3.3. Create tag index table<a class="headerlink" href="#create-tag-index-table" title="Permalink to this headline">¶</a></h3> +<h3>7.3.55.3.4. Create tag index table<a class="headerlink" href="#create-tag-index-table" title="Permalink to this headline">¶</a></h3> <p>You can use all table types except <code class="docutils literal"><span class="pre">TABLE_NO_KEY</span></code> for tag index table. Tag index table needs key support but <code class="docutils literal"><span class="pre">TABLE_NO_KEY</span></code> doesn't support key.</p> <p>Here is an example to create <code class="docutils literal"><span class="pre">TABLE_HASH_KEY</span></code> table:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Tags TABLE_HASH_KEY ShortText +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Tags TABLE_HASH_KEY ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] </pre></div> </div> @@ -186,13 +205,13 @@ suitable. It is the common case.</p> the number of tags will not be large.</p> </div> <div class="section" id="create-range-index-table"> -<h3>7.3.55.3.4. Create range index table<a class="headerlink" href="#create-range-index-table" title="Permalink to this headline">¶</a></h3> +<h3>7.3.55.3.5. Create range index table<a class="headerlink" href="#create-range-index-table" title="Permalink to this headline">¶</a></h3> <p>You can use <code class="docutils literal"><span class="pre">TABLE_PAT_KEY</span></code> and <code class="docutils literal"><span class="pre">TABLE_DAT_KEY</span></code> table types for range index table. Range index table needs range search support but <code class="docutils literal"><span class="pre">TABLE_NO_KEY</span></code> and <code class="docutils literal"><span class="pre">TABLE_HASH_KEY</span></code> don't support it.</p> <p>Here is an example to create <code class="docutils literal"><span class="pre">TABLE_DAT_KEY</span></code> table:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Ages TABLE_DAT_KEY UInt32 +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Ages TABLE_DAT_KEY UInt32 # [[0, 1337566253.89858, 0.000355720520019531], true] </pre></div> </div> @@ -234,28 +253,33 @@ that you cannot use <code class="docutils literal"><span class="pre">_</span></c <p>Here are available flags:</p> <table border="1" class="docutils"> <colgroup> -<col width="40%" /> -<col width="60%" /> +<col width="50%" /> +<col width="50%" /> </colgroup> -<tbody valign="top"> -<tr class="row-odd"><td>flags</td> -<td>description</td> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Flag</th> +<th class="head">Description</th> </tr> +</thead> +<tbody valign="top"> <tr class="row-even"><td><code class="docutils literal"><span class="pre">TABLE_NO_KEY</span></code></td> -<td>Array table.</td> +<td>Array table. See also <a class="reference internal" href="../tables.html#table-no-key"><span>TABLE_NO_KEY</span></a>.</td> </tr> <tr class="row-odd"><td><code class="docutils literal"><span class="pre">TABLE_HASH_KEY</span></code></td> -<td>Hash table.</td> +<td>Hash table. See also <a class="reference internal" href="../tables.html#table-hash-key"><span>TABLE_HASH_KEY</span></a>.</td> </tr> <tr class="row-even"><td><code class="docutils literal"><span class="pre">TABLE_PAT_KEY</span></code></td> -<td>Patricia trie.</td> +<td>Patricia trie. See also <a class="reference internal" href="../tables.html#table-pat-key"><span>TABLE_PAT_KEY</span></a>.</td> </tr> <tr class="row-odd"><td><code class="docutils literal"><span class="pre">TABLE_DAT_KEY</span></code></td> -<td>Double Array trie.</td> +<td>Double array trie. See also <a class="reference internal" href="../tables.html#table-dat-key"><span>TABLE_DAT_KEY</span></a>.</td> </tr> <tr class="row-even"><td><code class="docutils literal"><span class="pre">KEY_WITH_SIS</span></code></td> -<td>Enable Semi Infinite String. -Require <code class="docutils literal"><span class="pre">TABLE_PAT_KEY</span></code>.</td> +<td>Enable Semi Infinite String. Require <code class="docutils literal"><span class="pre">TABLE_PAT_KEY</span></code>.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">KEY_LARGE</span></code></td> +<td>Expand the maximum total key size to 1TiB from 4GiB. Require +<code class="docutils literal"><span class="pre">TABLE_HASH_KEY</span></code>.</td> </tr> </tbody> </table> @@ -342,7 +366,7 @@ the table as a lexicon.</p> <div class="section" id="return-value"> <h2>7.3.55.5. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2> <p><code class="docutils literal"><span class="pre">table_create</span></code> returns <code class="docutils literal"><span class="pre">true</span></code> as body on success such as:</p> -<div class="highlight-none"><div class="highlight"><pre>[HEADER, true] +<div class="highlight-none"><div class="highlight"><pre><span></span>[HEADER, true] </pre></div> </div> <p>If <code class="docutils literal"><span class="pre">table_create</span></code> fails, error details are in <code class="docutils literal"><span class="pre">HEADER</span></code>.</p> @@ -373,9 +397,10 @@ the table as a lexicon.</p> <li><a class="reference internal" href="#syntax">7.3.55.2. Syntax</a></li> <li><a class="reference internal" href="#usage">7.3.55.3. Usage</a><ul> <li><a class="reference internal" href="#create-data-store-table">7.3.55.3.1. Create data store table</a></li> -<li><a class="reference internal" href="#create-lexicon-table">7.3.55.3.2. Create lexicon table</a></li> -<li><a class="reference internal" href="#create-tag-index-table">7.3.55.3.3. Create tag index table</a></li> -<li><a class="reference internal" href="#create-range-index-table">7.3.55.3.4. Create range index table</a></li> +<li><a class="reference internal" href="#create-large-data-store-table">7.3.55.3.2. Create large data store table</a></li> +<li><a class="reference internal" href="#create-lexicon-table">7.3.55.3.3. Create lexicon table</a></li> +<li><a class="reference internal" href="#create-tag-index-table">7.3.55.3.4. Create tag index table</a></li> +<li><a class="reference internal" href="#create-range-index-table">7.3.55.3.5. Create range index table</a></li> </ul> </li> <li><a class="reference internal" href="#parameters">7.3.55.4. Parameters</a><ul> Modified: docs/reference/commands/table_list.html (+3 -3) =================================================================== --- docs/reference/commands/table_list.html 2016-03-05 15:09:34 +0900 (0c5248b) +++ docs/reference/commands/table_list.html 2016-03-17 12:56:59 +0900 (61ac473) @@ -94,14 +94,14 @@ </div> <div class="section" id="syntax"> <h2>7.3.56.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> -<div class="highlight-none"><div class="highlight"><pre>table_list +<div class="highlight-none"><div class="highlight"><pre><span></span>table_list </pre></div> </div> </div> <div class="section" id="usage"> <h2>7.3.56.3. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_list +<div class="highlight-none"><div class="highlight"><pre><span></span>table_list # [ # [ # 0, @@ -195,7 +195,7 @@ <div class="section" id="return-value"> <h2>7.3.56.5. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2> <p>テーブル名一覧が以下の形式で返却されます。:</p> -<div class="highlight-none"><div class="highlight"><pre>[[[テーブル情報名1,テーブル情報型1],...], テーブル情報1,...] +<div class="highlight-none"><div class="highlight"><pre><span></span>[[[テーブル情報名1,テーブル情報型1],...], テーブル情報1,...] </pre></div> </div> <p><code class="docutils literal"><span class="pre">テーブル情報名n</span></code></p> Modified: docs/reference/commands/table_remove.html (+16 -16) =================================================================== --- docs/reference/commands/table_remove.html 2016-03-05 15:09:34 +0900 (82753a3) +++ docs/reference/commands/table_remove.html 2016-03-17 12:56:59 +0900 (437ba8d) @@ -95,7 +95,7 @@ removed.</p> <div class="section" id="syntax"> <h2>7.3.57.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> <p>This command takes only one required parameter:</p> -<div class="highlight-none"><div class="highlight"><pre>table_remove name +<div class="highlight-none"><div class="highlight"><pre><span></span>table_remove name </pre></div> </div> </div> @@ -126,7 +126,7 @@ removed.</p> </div></blockquote> <p>Here are commands that create <code class="docutils literal"><span class="pre">Entries</span></code> table:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Entries TABLE_HASH_KEY UInt32 +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Entries TABLE_HASH_KEY UInt32 # [[0, 1337566253.89858, 0.000355720520019531], true] column_create Entries title COLUMN_SCALAR ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -136,7 +136,7 @@ column_create Entries content COLUMN_SCALAR Text </div> <p>Here are commands that create an index for <code class="docutils literal"><span class="pre">Entries</span></code> table's key:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create EntryKeys TABLE_HASH_KEY UInt32 +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create EntryKeys TABLE_HASH_KEY UInt32 # [[0, 1337566253.89858, 0.000355720520019531], true] column_create EntryKeys key_index COLUMN_INDEX Entries _key # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -144,7 +144,7 @@ column_create EntryKeys key_index COLUMN_INDEX Entries _key </div> <p>Here are commands that create an index for <code class="docutils literal"><span class="pre">Entries</span></code> table's column:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Terms TABLE_PAT_KEY ShortText \ +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Terms TABLE_PAT_KEY ShortText \ --default_tokenizer TokenBigram \ --normalizer NormalizerAuto # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -154,7 +154,7 @@ column_create Terms content_index COLUMN_INDEX Entries content </div> <p>Let's confirm the current schema before running <code class="docutils literal"><span class="pre">table_remove</span></code>:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>dump +<div class="highlight-none"><div class="highlight"><pre><span></span>dump # table_create Entries TABLE_HASH_KEY UInt32 # column_create Entries content COLUMN_SCALAR Text # column_create Entries title COLUMN_SCALAR ShortText @@ -187,14 +187,14 @@ removed:</p> </div></blockquote> <p>Let's run <code class="docutils literal"><span class="pre">table_remove</span></code>:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_remove Entries +<div class="highlight-none"><div class="highlight"><pre><span></span>table_remove Entries # [[0, 1337566253.89858, 0.000355720520019531], true] </pre></div> </div> <p>Here is schema after <code class="docutils literal"><span class="pre">table_remove</span></code>. Only <code class="docutils literal"><span class="pre">EntryKeys</span></code> and <code class="docutils literal"><span class="pre">Terms</span></code> exist:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>dump +<div class="highlight-none"><div class="highlight"><pre><span></span>dump # table_create EntryKeys TABLE_HASH_KEY UInt32 # # table_create Terms TABLE_PAT_KEY ShortText --default_tokenizer TokenBigram --normalizer NormalizerAuto @@ -219,7 +219,7 @@ failed. The target table and its columns aren't removed.</p> <p>The following commands create a table to be removed and a table that uses the table to be removed as key type:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create ReferencedByTable TABLE_HASH_KEY ShortText +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create ReferencedByTable TABLE_HASH_KEY ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] table_create ReferenceTable TABLE_HASH_KEY ReferencedByTable # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -227,7 +227,7 @@ table_create ReferenceTable TABLE_HASH_KEY ReferencedByTable </div> <p><code class="docutils literal"><span class="pre">table_remove</span></code> against <code class="docutils literal"><span class="pre">ReferencedByTable</span></code> is failed:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_remove ReferencedByTable +<div class="highlight-none"><div class="highlight"><pre><span></span>table_remove ReferencedByTable # [ # [ # -2, @@ -249,7 +249,7 @@ table_create ReferenceTable TABLE_HASH_KEY ReferencedByTable <p>You need to remove <code class="docutils literal"><span class="pre">ReferenceTable</span></code> before you remove <code class="docutils literal"><span class="pre">ReferencedByTable</span></code>:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_remove ReferenceTable +<div class="highlight-none"><div class="highlight"><pre><span></span>table_remove ReferenceTable # [[0, 1337566253.89858, 0.000355720520019531], true] table_remove ReferencedByTable # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -259,7 +259,7 @@ table_remove ReferencedByTable <p>The following commands create a table to be removed and a column that uses the table to be removed as value type:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create ReferencedByColumn TABLE_HASH_KEY ShortText +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create ReferencedByColumn TABLE_HASH_KEY ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] table_create Table TABLE_NO_KEY # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -269,7 +269,7 @@ column_create Table reference_column COLUMN_SCALAR ReferencedByColumn </div> <p><code class="docutils literal"><span class="pre">table_remove</span></code> against <code class="docutils literal"><span class="pre">ReferencedByColumn</span></code> is failed:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_remove ReferencedByColumn +<div class="highlight-none"><div class="highlight"><pre><span></span>table_remove ReferencedByColumn # [ # [ # -2, @@ -291,7 +291,7 @@ column_create Table reference_column COLUMN_SCALAR ReferencedByColumn <p>You need to remove <code class="docutils literal"><span class="pre">Table.reference_column</span></code> before you remove <code class="docutils literal"><span class="pre">ReferencedByColumn</span></code>:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>column_remove Table reference_column +<div class="highlight-none"><div class="highlight"><pre><span></span>column_remove Table reference_column # [[0, 1337566253.89858, 0.000355720520019531], true] table_remove ReferencedByColumn # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -310,7 +310,7 @@ checking when the max number of threads is <code class="docutils literal"><span <a class="reference internal" href="thread_limit.html"><em>thread_limit</em></a>.</p> <p>The feature is used in the following case:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Entries TABLE_NO_KEY +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Entries TABLE_NO_KEY # [[0, 1337566253.89858, 0.000355720520019531], true] thread_limit 2 # [[0, 1337566253.89858, 0.000355720520019531], 1] @@ -320,7 +320,7 @@ table_remove Entries </div> <p>The feature isn't used in the following case:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Entries TABLE_NO_KEY +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Entries TABLE_NO_KEY # [[0, 1337566253.89858, 0.000355720520019531], true] thread_limit 2 # [[0, 1337566253.89858, 0.000355720520019531], 1] @@ -346,7 +346,7 @@ table_remove Entries <div class="section" id="return-value"> <h2>7.3.57.5. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2> <p>The command returns <code class="docutils literal"><span class="pre">true</span></code> as body on success such as:</p> -<div class="highlight-none"><div class="highlight"><pre>[HEADER, true] +<div class="highlight-none"><div class="highlight"><pre><span></span>[HEADER, true] </pre></div> </div> <p>If the command fails, error details are in <code class="docutils literal"><span class="pre">HEADER</span></code>.</p> Modified: docs/reference/commands/table_rename.html (+3 -3) =================================================================== --- docs/reference/commands/table_rename.html 2016-03-05 15:09:34 +0900 (a4126ae) +++ docs/reference/commands/table_rename.html 2016-03-17 12:56:59 +0900 (7de8326) @@ -112,7 +112,7 @@ crash the Groonga process.</li> <h2>7.3.58.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> <p>This command takes two parameters.</p> <p>All parameters are required:</p> -<div class="highlight-none"><div class="highlight"><pre>table_rename name new_name +<div class="highlight-none"><div class="highlight"><pre><span></span>table_rename name new_name </pre></div> </div> </div> @@ -120,7 +120,7 @@ crash the Groonga process.</li> <h2>7.3.58.3. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2> <p>Here is a simple example of <code class="docutils literal"><span class="pre">table_rename</span></code> command.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Users TABLE_PAT_KEY ShortText +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Users TABLE_PAT_KEY ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] column_create Users score COLUMN_SCALAR Int32 # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -253,7 +253,7 @@ select Players <div class="section" id="return-value"> <h2>7.3.58.5. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2> <p>The command returns <code class="docutils literal"><span class="pre">true</span></code> as body on success such as:</p> -<div class="highlight-none"><div class="highlight"><pre>[HEADER, true] +<div class="highlight-none"><div class="highlight"><pre><span></span>[HEADER, true] </pre></div> </div> <p>If the command fails, error details are in <code class="docutils literal"><span class="pre">HEADER</span></code>.</p> Modified: docs/reference/commands/table_tokenize.html (+2 -2) =================================================================== --- docs/reference/commands/table_tokenize.html 2016-03-05 15:09:34 +0900 (e68f56b) +++ docs/reference/commands/table_tokenize.html 2016-03-17 12:56:59 +0900 (424df9e) @@ -95,7 +95,7 @@ <p>This command takes many parameters.</p> <p><code class="docutils literal"><span class="pre">table</span></code> and <code class="docutils literal"><span class="pre">string</span></code> are required parameters. Others are optional:</p> -<div class="highlight-none"><div class="highlight"><pre>table_tokenize table +<div class="highlight-none"><div class="highlight"><pre><span></span>table_tokenize table string [flags=NONE] [mode=GET] @@ -106,7 +106,7 @@ optional:</p> <h2>7.3.59.3. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2> <p>Here is a simple example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>register token_filters/stop_word +<div class="highlight-none"><div class="highlight"><pre><span></span>register token_filters/stop_word # [[0,0.0,0.0],true] table_create Terms TABLE_PAT_KEY ShortText \ --default_tokenizer TokenBigram \ Modified: docs/reference/commands/thread_limit.html (+6 -6) =================================================================== --- docs/reference/commands/thread_limit.html 2016-03-05 15:09:34 +0900 (6a3abb4) +++ docs/reference/commands/thread_limit.html 2016-03-17 12:56:59 +0900 (46a69a4) @@ -117,7 +117,7 @@ max number of threads works.</p> <div class="section" id="syntax"> <h2>7.3.60.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> <p>This command takes only one optional parameter:</p> -<div class="highlight-none"><div class="highlight"><pre>thread_limit [max=null] +<div class="highlight-none"><div class="highlight"><pre><span></span>thread_limit [max=null] </pre></div> </div> </div> @@ -125,14 +125,14 @@ max number of threads works.</p> <h2>7.3.60.3. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2> <p>You can get the max number of threads by calling without any parameters:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>thread_limit +<div class="highlight-none"><div class="highlight"><pre><span></span>thread_limit # [[0, 1337566253.89858, 0.000355720520019531], 2] </pre></div> </div> <p>If it returns <code class="docutils literal"><span class="pre">0</span></code>, your Groonga server doesn't support the feature.</p> <p>You can set the max number of threads by calling <code class="docutils literal"><span class="pre">max</span></code> parameter:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>thread_limit --max 4 +<div class="highlight-none"><div class="highlight"><pre><span></span>thread_limit --max 4 # [[0, 1337566253.89858, 0.000355720520019531], 2] </pre></div> </div> @@ -144,7 +144,7 @@ max number of threads works.</p> <p>This section describes all parameters.</p> <div class="section" id="required-parameters"> <h3>7.3.60.4.1. Required parameters<a class="headerlink" href="#required-parameters" title="Permalink to this headline">¶</a></h3> -<p>There is no required parameters.</p> +<p>There is no required parameter.</p> </div> <div class="section" id="optional-parameters"> <h3>7.3.60.4.2. Optional parameters<a class="headerlink" href="#optional-parameters" title="Permalink to this headline">¶</a></h3> @@ -154,7 +154,7 @@ max number of threads works.</p> <p>Specifies the new max number of threads.</p> <p>You must specify positive integer:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>thread_limit --max 3 +<div class="highlight-none"><div class="highlight"><pre><span></span>thread_limit --max 3 # [[0, 1337566253.89858, 0.000355720520019531], 4] </pre></div> </div> @@ -166,7 +166,7 @@ max number of threads before <code class="docutils literal"><span class="pre">ma <div class="section" id="return-value"> <h2>7.3.60.5. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2> <p>The command returns the max number of threads as body:</p> -<div class="highlight-none"><div class="highlight"><pre>[HEADER, N_MAX_THREADS] +<div class="highlight-none"><div class="highlight"><pre><span></span>[HEADER, N_MAX_THREADS] </pre></div> </div> <p>If <code class="docutils literal"><span class="pre">max</span></code> is specified, <code class="docutils literal"><span class="pre">N_MAX_THREADS</span></code> is the max number of Modified: docs/reference/commands/tokenize.html (+11 -11) =================================================================== --- docs/reference/commands/tokenize.html 2016-03-05 15:09:34 +0900 (b20afe1) +++ docs/reference/commands/tokenize.html 2016-03-17 12:56:59 +0900 (efd7ec7) @@ -96,7 +96,7 @@ It is useful to debug tokenization.</p> <p>This command takes many parameters.</p> <p><code class="docutils literal"><span class="pre">tokenizer</span></code> and <code class="docutils literal"><span class="pre">string</span></code> are required parameters. Others are optional:</p> -<div class="highlight-none"><div class="highlight"><pre>tokenize tokenizer +<div class="highlight-none"><div class="highlight"><pre><span></span>tokenize tokenizer string [normalizer=null] [flags=NONE] @@ -109,7 +109,7 @@ optional:</p> <h2>7.3.61.3. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2> <p>Here is a simple example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>tokenize TokenBigram "Fulltext Search" +<div class="highlight-none"><div class="highlight"><pre><span></span>tokenize TokenBigram "Fulltext Search" # [ # [ # 0, @@ -214,7 +214,7 @@ tokenizer that is named <code class="docutils literal"><span class="pre">tokeniz <p>See <a class="reference internal" href="../tokenizers.html"><em>Tokenizers</em></a> about built-in tokenizers.</p> <p>Here is an example to use built-in <code class="docutils literal"><span class="pre">TokenTrigram</span></code> tokenizer.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>tokenize TokenTrigram "Fulltext Search" +<div class="highlight-none"><div class="highlight"><pre><span></span>tokenize TokenTrigram "Fulltext Search" # [ # [ # 0, @@ -313,7 +313,7 @@ registering <code class="docutils literal"><span class="pre">tokenizers/kytea</s <code class="docutils literal"><span class="pre">string</span></code> by single quotation (<code class="docutils literal"><span class="pre">'</span></code>) or double quotation (<code class="docutils literal"><span class="pre">"</span></code>).</p> <p>Here is an example to use spaces in <code class="docutils literal"><span class="pre">string</span></code>.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>tokenize TokenBigram "Groonga is a fast fulltext earch engine!" +<div class="highlight-none"><div class="highlight"><pre><span></span>tokenize TokenBigram "Groonga is a fast fulltext earch engine!" # [ # [ # 0, @@ -540,7 +540,7 @@ normalizing. N-gram family tokenizers use character types while tokenizing.</p> <p>Here is an example that doesn't use normalizer.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>tokenize TokenBigram "Fulltext Search" +<div class="highlight-none"><div class="highlight"><pre><span></span>tokenize TokenBigram "Fulltext Search" # [ # [ # 0, @@ -631,7 +631,7 @@ tokenizing.</p> a token.</p> <p>Here is an example that uses normalizer.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>tokenize TokenBigram "Fulltext Search" NormalizerAuto +<div class="highlight-none"><div class="highlight"><pre><span></span>tokenize TokenBigram "Fulltext Search" NormalizerAuto # [ # [ # 0, @@ -658,7 +658,7 @@ a token.</p> <p>If you want to tokenize by two characters with noramlizer, use <code class="docutils literal"><span class="pre">TokenBigramSplitSymbolAlpha</span></code>.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>tokenize TokenBigramSplitSymbolAlpha "Fulltext Search" NormalizerAuto +<div class="highlight-none"><div class="highlight"><pre><span></span>tokenize TokenBigramSplitSymbolAlpha "Fulltext Search" NormalizerAuto # [ # [ # 0, @@ -771,7 +771,7 @@ tokenized delimiter details.</td> </table> <p>Here is an example that uses <code class="docutils literal"><span class="pre">ENABLE_TOKENIZED_DELIMITER</span></code>.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>tokenize TokenDelimit "Fulltext Seacrch" NormalizerAuto ENABLE_TOKENIZED_DELIMITER +<div class="highlight-none"><div class="highlight"><pre><span></span>tokenize TokenDelimit "Fulltext Seacrch" NormalizerAuto ENABLE_TOKENIZED_DELIMITER # [ # [ # 0, @@ -817,7 +817,7 @@ the mode is omitted, the text is tokenized by the <code class="docutils literal" <p>The default mode is <code class="docutils literal"><span class="pre">ADD</span></code>.</p> <p>Here is an example to the <code class="docutils literal"><span class="pre">ADD</span></code> mode.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>tokenize TokenBigram "Fulltext Search" --mode ADD +<div class="highlight-none"><div class="highlight"><pre><span></span>tokenize TokenBigram "Fulltext Search" --mode ADD # [ # [ # 0, @@ -907,7 +907,7 @@ the mode is omitted, the text is tokenized by the <code class="docutils literal" <p>The last alphabet is tokenized by one character.</p> <p>Here is an example to the <code class="docutils literal"><span class="pre">GET</span></code> mode.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>tokenize TokenBigram "Fulltext Search" --mode GET +<div class="highlight-none"><div class="highlight"><pre><span></span>tokenize TokenBigram "Fulltext Search" --mode GET # [ # [ # 0, @@ -1004,7 +1004,7 @@ tokenizer that is named <code class="docutils literal"><span class="pre">token_f <p><code class="docutils literal"><span class="pre">tokenize</span></code> command returns tokenized tokens. Each token has some attributes except token itself. The attributes will be increased in the feature:</p> -<div class="highlight-none"><div class="highlight"><pre>[HEADER, tokens] +<div class="highlight-none"><div class="highlight"><pre><span></span>[HEADER, tokens] </pre></div> </div> <p><code class="docutils literal"><span class="pre">HEADER</span></code></p> Modified: docs/reference/commands/tokenizer_list.html (+3 -3) =================================================================== --- docs/reference/commands/tokenizer_list.html 2016-03-05 15:09:34 +0900 (0ec7932) +++ docs/reference/commands/tokenizer_list.html 2016-03-17 12:56:59 +0900 (12c214a) @@ -93,7 +93,7 @@ <div class="section" id="syntax"> <h2>7.3.62.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> <p>This command takes no parameters:</p> -<div class="highlight-none"><div class="highlight"><pre>tokenizer_list +<div class="highlight-none"><div class="highlight"><pre><span></span>tokenizer_list </pre></div> </div> </div> @@ -101,7 +101,7 @@ <h2>7.3.62.3. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2> <p>Here is a simple example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>tokenizer_list +<div class="highlight-none"><div class="highlight"><pre><span></span>tokenizer_list # [ # [ # 0, @@ -161,7 +161,7 @@ <h2>7.3.62.4. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2> <p><code class="docutils literal"><span class="pre">tokenizer_list</span></code> command returns tokenizers. Each tokenizers has an attribute that contains the name. The attribute will be increased in the feature:</p> -<div class="highlight-none"><div class="highlight"><pre>[HEADER, tokenizers] +<div class="highlight-none"><div class="highlight"><pre><span></span>[HEADER, tokenizers] </pre></div> </div> <p><code class="docutils literal"><span class="pre">HEADER</span></code></p> Modified: docs/reference/commands/truncate.html (+7 -7) =================================================================== --- docs/reference/commands/truncate.html 2016-03-05 15:09:34 +0900 (d37a261) +++ docs/reference/commands/truncate.html 2016-03-17 12:56:59 +0900 (f633eea) @@ -94,7 +94,7 @@ values from specified column.</p> <div class="section" id="syntax"> <h2>7.3.63.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> <p>This command takes only one required parameter:</p> -<div class="highlight-none"><div class="highlight"><pre>truncate target_name +<div class="highlight-none"><div class="highlight"><pre><span></span>truncate target_name </pre></div> </div> <div class="versionadded"> @@ -108,7 +108,7 @@ parameter. But it should not be used for newly written code.</p> <h2>7.3.63.3. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2> <p>Here is a simple example of <code class="docutils literal"><span class="pre">truncate</span></code> command against a table.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Users TABLE_PAT_KEY ShortText +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Users TABLE_PAT_KEY ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] column_create Users score COLUMN_SCALAR Int32 # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -198,7 +198,7 @@ select Users </div> <p>Here is a simple example of <code class="docutils literal"><span class="pre">truncate</span></code> command against a column.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Users TABLE_PAT_KEY ShortText +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Users TABLE_PAT_KEY ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] column_create Users score COLUMN_SCALAR Int32 # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -305,8 +305,8 @@ select Users <div class="section" id="parameters"> <h2>7.3.63.4. Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></h2> <p>This section describes parameters of <code class="docutils literal"><span class="pre">truncate</span></code>.</p> -<div class="section" id="required-parameter"> -<h3>7.3.63.4.1. Required parameter<a class="headerlink" href="#required-parameter" title="Permalink to this headline">¶</a></h3> +<div class="section" id="required-parameters"> +<h3>7.3.63.4.1. Required parameters<a class="headerlink" href="#required-parameters" title="Permalink to this headline">¶</a></h3> <p>There is required parameter, <code class="docutils literal"><span class="pre">target_name</span></code>.</p> <div class="section" id="target-name"> <h4>7.3.63.4.1.1. <code class="docutils literal"><span class="pre">target_name</span></code><a class="headerlink" href="#target-name" title="Permalink to this headline">¶</a></h4> @@ -317,7 +317,7 @@ select Users <div class="section" id="return-value"> <h2>7.3.63.5. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2> <p><code class="docutils literal"><span class="pre">truncate</span></code> command returns whether truncation is succeeded or not:</p> -<div class="highlight-none"><div class="highlight"><pre>[HEADER, SUCCEEDED_OR_NOT] +<div class="highlight-none"><div class="highlight"><pre><span></span>[HEADER, SUCCEEDED_OR_NOT] </pre></div> </div> <p><code class="docutils literal"><span class="pre">HEADER</span></code></p> @@ -342,7 +342,7 @@ select Users <li><a class="reference internal" href="#syntax">7.3.63.2. Syntax</a></li> <li><a class="reference internal" href="#usage">7.3.63.3. Usage</a></li> <li><a class="reference internal" href="#parameters">7.3.63.4. Parameters</a><ul> -<li><a class="reference internal" href="#required-parameter">7.3.63.4.1. Required parameter</a><ul> +<li><a class="reference internal" href="#required-parameters">7.3.63.4.1. Required parameters</a><ul> <li><a class="reference internal" href="#target-name">7.3.63.4.1.1. <code class="docutils literal"><span class="pre">target_name</span></code></a></li> </ul> </li> Modified: docs/reference/configuration.html (+5 -5) =================================================================== --- docs/reference/configuration.html 2016-03-05 15:09:34 +0900 (adff1d3) +++ docs/reference/configuration.html 2016-03-17 12:56:59 +0900 (9049015) @@ -26,7 +26,7 @@ <link rel="shortcut icon" href="../static/favicon.ico"/> <link rel="top" title="Groonga v6.0.0 documentation" href="../index.html" /> <link rel="up" title="7. Reference manual" href="../reference.html" /> - <link rel="next" title="7.3.14. config_delete" href="commands/config_delete.html" /> + <link rel="next" title="7.17. Alias" href="alias.html" /> <link rel="prev" title="7.15.2. Prefix RK search" href="operations/prefix_rk_search.html" /> <meta property="fb:page_id" content="201193596592346" /><!-- groonga --> <meta property="fb:admins" content="664204556" /><!-- kouhei.sutou --> @@ -68,7 +68,7 @@ <a href="../genindex.html" title="General Index" accesskey="I">index</a></li> <li class="right" > - <a href="commands/config_delete.html" title="7.3.14. config_delete" + <a href="alias.html" title="7.17. Alias" accesskey="N">next</a> |</li> <li class="right" > <a href="operations/prefix_rk_search.html" title="7.15.2. Prefix RK search" @@ -142,8 +142,8 @@ are string. The max key size is 4KiB. The max value size is 4091B (= <p class="topless"><a href="operations/prefix_rk_search.html" title="previous chapter">7.15.2. Prefix RK search</a></p> <h4>Next topic</h4> - <p class="topless"><a href="commands/config_delete.html" - title="next chapter">7.3.14. <code class="docutils literal"><span class="pre">config_delete</span></code></a></p> + <p class="topless"><a href="alias.html" + title="next chapter">7.17. Alias</a></p> <div role="note" aria-label="source link"> <h3>This Page</h3> <ul class="this-page-menu"> @@ -175,7 +175,7 @@ are string. The max key size is 4KiB. The max value size is 4091B (= <a href="../genindex.html" title="General Index" >index</a></li> <li class="right" > - <a href="commands/config_delete.html" title="7.3.14. config_delete" + <a href="alias.html" title="7.17. Alias" >next</a> |</li> <li class="right" > <a href="operations/prefix_rk_search.html" title="7.15.2. Prefix RK search" Modified: docs/reference/executables/grndb.html (+5 -5) =================================================================== --- docs/reference/executables/grndb.html 2016-03-05 15:09:34 +0900 (951a7f7) +++ docs/reference/executables/grndb.html 2016-03-17 12:56:59 +0900 (ca6f2d4) @@ -108,7 +108,7 @@ recoverable.</li> <div class="section" id="syntax"> <h2>7.1.1.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> <p><code class="docutils literal"><span class="pre">grndb</span></code> requires command and database path:</p> -<div class="highlight-none"><div class="highlight"><pre>grndb COMMAND [OPTIONS] DATABASE_PATH +<div class="highlight-none"><div class="highlight"><pre><span></span>grndb COMMAND [OPTIONS] DATABASE_PATH </pre></div> </div> <p>Here are available commands:</p> @@ -122,11 +122,11 @@ recoverable.</li> <div class="section" id="usage"> <h2>7.1.1.3. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2> <p>Here is an example to check the database at <code class="docutils literal"><span class="pre">/var/lib/groonga/db/db</span></code>:</p> -<div class="highlight-none"><div class="highlight"><pre>% grndb check /var/lib/groonga/db/db +<div class="highlight-none"><div class="highlight"><pre><span></span>% grndb check /var/lib/groonga/db/db </pre></div> </div> <p>Here is an example to recover the database at <code class="docutils literal"><span class="pre">/var/lib/groonga/db/db</span></code>:</p> -<div class="highlight-none"><div class="highlight"><pre>% grndb recover /var/lib/groonga/db/db +<div class="highlight-none"><div class="highlight"><pre><span></span>% grndb recover /var/lib/groonga/db/db </pre></div> </div> </div> @@ -164,11 +164,11 @@ table is also checked recursive.</p> type and all sources are also checked recursive.</p> <p>Here is an example that checks only <code class="docutils literal"><span class="pre">Entries</span></code> table and its columns:</p> -<div class="highlight-none"><div class="highlight"><pre>% grndb check --target Entries /var/lib/groonga/db/db +<div class="highlight-none"><div class="highlight"><pre><span></span>% grndb check --target Entries /var/lib/groonga/db/db </pre></div> </div> <p>Here is an example that checks only <code class="docutils literal"><span class="pre">Entries.name</span></code> column:</p> -<div class="highlight-none"><div class="highlight"><pre>% grndb check --target Entries.name /var/lib/groonga/db/db +<div class="highlight-none"><div class="highlight"><pre><span></span>% grndb check --target Entries.name /var/lib/groonga/db/db </pre></div> </div> </div> Modified: docs/reference/executables/grnslap.html (+2 -2) =================================================================== --- docs/reference/executables/grnslap.html 2016-03-05 15:09:34 +0900 (08529a9) +++ docs/reference/executables/grnslap.html 2016-03-17 12:56:59 +0900 (ff5911c) @@ -92,7 +92,7 @@ </div> <div class="section" id="id2"> <h2>7.1.2.2. 書式<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h2> -<div class="highlight-none"><div class="highlight"><pre>grnslap [options] [dest] +<div class="highlight-none"><div class="highlight"><pre><span></span>grnslap [options] [dest] </pre></div> </div> </div> @@ -136,7 +136,7 @@ <div class="section" id="id6"> <h2>7.1.2.6. サンプル<a class="headerlink" href="#id6" title="Permalink to this headline">¶</a></h2> <p><a class="reference external" href="http://localhost:10041/d/status">http://localhost:10041/d/status</a> に、多重度100でリクエストを行う。</p> -<div class="highlight-none"><div class="highlight"><pre>> yes /d/status | head -n 100 | grnslap -P http -m 100 localhost:10041 +<div class="highlight-none"><div class="highlight"><pre><span></span>> yes /d/status | head -n 100 | grnslap -P http -m 100 localhost:10041 2009-11-12 19:34:09.998696|begin: max_concurrency=100 max_tp=10000 2009-11-12 19:34:10.011208|end : n=100 min=46 max=382 avg=0 qps=7992.966190 etime=0.012511 </pre></div> Modified: docs/reference/executables/groonga-benchmark.html (+8 -8) =================================================================== --- docs/reference/executables/groonga-benchmark.html 2016-03-05 15:09:34 +0900 (2fbabfa) +++ docs/reference/executables/groonga-benchmark.html 2016-03-17 12:56:59 +0900 (b2ed61e) @@ -92,7 +92,7 @@ </div> <div class="section" id="id2"> <h2>7.1.4.2. 書式<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h2> -<div class="highlight-none"><div class="highlight"><pre>groonga-benchmark [options...] [script] [db] +<div class="highlight-none"><div class="highlight"><pre><span></span>groonga-benchmark [options...] [script] [db] </pre></div> </div> </div> @@ -166,11 +166,11 @@ <div class="section" id="id6"> <h2>7.1.4.6. 使い方<a class="headerlink" href="#id6" title="Permalink to this headline">¶</a></h2> <p>まず、シェル上(Windowsならコマンドプロンプト上)で:</p> -<div class="highlight-none"><div class="highlight"><pre>groonga-benchmark test.scr 任意のDB名 +<div class="highlight-none"><div class="highlight"><pre><span></span>groonga-benchmark test.scr 任意のDB名 </pre></div> </div> <p>とタイプしてください。もしgroonga-benchmarkが正常に動作すれば、:</p> -<div class="highlight-none"><div class="highlight"><pre>test-ユーザ名-数字.log +<div class="highlight-none"><div class="highlight"><pre><span></span>test-ユーザ名-数字.log </pre></div> </div> <p>というファイルが作成されるはずです。作成されない場合、このドキュメントの「トラブルシューティング」の章を参照してください。</p> @@ -205,7 +205,7 @@ <p>out_local コマンドファイル 入力ファイル名</p> <blockquote> <div><p>コマンドファイルをgroonga-benchmark単体で実行し、各コマンドの実行結果をすべて”出力ファイル"に書きだします。この結果は、test_local, test_gqtp命令で利用します。なおこの命令の「出力ファイル」とは、groonga-benchmark実行時に自動的に作成されるログとは別のものです。groonga-benchmarkではコメントが利用できる以外、:</p> -<div class="highlight-none"><div class="highlight"><pre>groonga < コマンドファイル > 出力ファイル +<div class="highlight-none"><div class="highlight"><pre><span></span>groonga < コマンドファイル > 出力ファイル </pre></div> </div> <p>とした場合と同じです。</p> @@ -229,7 +229,7 @@ <div class="section" id="id10"> <h3>7.1.4.7.3. サンプル<a class="headerlink" href="#id10" title="Permalink to this headline">¶</a></h3> <p>スクリプトファイルのサンプルです。:</p> -<div class="highlight-none"><div class="highlight"><pre># sample script +<div class="highlight-none"><div class="highlight"><pre><span></span># sample script rep_local test.ddl do_local test.load; do_gqtp test.select 10 10; do_local test.status 10 @@ -262,11 +262,11 @@ do_gqtp test.select 10 10; do_local test.status 10 </div></blockquote> <p>特殊命令はスクリプトファイルの任意の場所に書き込むことができます。同一ファイル内に複数回特殊命令を記述した場合、「最後の」特殊命令が有効となります。</p> <p>例えば、</p> -<div class="highlight-none"><div class="highlight"><pre>$ ./groonga-benchmark --port 20010 test.scr testdb +<div class="highlight-none"><div class="highlight"><pre><span></span>$ ./groonga-benchmark --port 20010 test.scr testdb </pre></div> </div> <p>とコマンド上でポートを指定した場合でも、もしtest.scrの中身が</p> -<div class="highlight-none"><div class="highlight"><pre>#SET_PORT 10900 +<div class="highlight-none"><div class="highlight"><pre><span></span>#SET_PORT 10900 rep_local test.ddl do_local test.load; rep_gqtp test.select 10 10; rep_local test.status 10 @@ -280,7 +280,7 @@ rep_gqtp test.select 10 10; rep_local test.status 10 <h2>7.1.4.8. groonga-benchmark実行結果<a class="headerlink" href="#id12" title="Permalink to this headline">¶</a></h2> <p>groonga-benchmarkが正常に終了すると、(拡張子を除いた)スクリプト名-ユーザ名-実行開始時刻.logという形式のログファイルがカレントディレクトリに作られます。ログファイルは自動的にftp.groonga.org に送信されます。ログファイルは以下のようなjson形式のテキストです。</p> -<div class="highlight-none"><div class="highlight"><pre>[{"script": "test.scr", +<div class="highlight-none"><div class="highlight"><pre><span></span>[{"script": "test.scr", "user": "homepage", "date": "2010-04-14 22:47:04", "CPU": Intel(R) Pentium(R) 4 CPU 2.80GHz", Modified: docs/reference/executables/groonga-httpd.html (+28 -28) =================================================================== --- docs/reference/executables/groonga-httpd.html 2016-03-05 15:09:34 +0900 (968c575) +++ docs/reference/executables/groonga-httpd.html 2016-03-17 12:56:59 +0900 (72c6282) @@ -99,7 +99,7 @@ JavaScript. You can access to it from <a class="reference external" href="http:/ </div> <div class="section" id="synopsis"> <h2>7.1.5.2. Synopsis<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2> -<div class="highlight-none"><div class="highlight"><pre>groonga-httpd [nginx options] +<div class="highlight-none"><div class="highlight"><pre><span></span>groonga-httpd [nginx options] </pre></div> </div> </div> @@ -110,7 +110,7 @@ JavaScript. You can access to it from <a class="reference external" href="http:/ <p>First, you'll need to edit the groonga-httpd configuration file to specify a database. Edit /etc/groonga/httpd/groonga-httpd.conf to enable the <code class="docutils literal"><span class="pre">groonga_database</span></code> directive like this:</p> -<div class="highlight-none"><div class="highlight"><pre># Match this to the file owner of groonga database files if groonga-httpd is +<div class="highlight-none"><div class="highlight"><pre><span></span># Match this to the file owner of groonga database files if groonga-httpd is # run as root. #user groonga; ... @@ -129,7 +129,7 @@ http { </div> <p>Then, run groonga-httpd. Note that the control immediately returns back to the console because groonga-httpd runs as a daemon process by default.:</p> -<div class="highlight-none"><div class="highlight"><pre>% groonga-httpd +<div class="highlight-none"><div class="highlight"><pre><span></span>% groonga-httpd </pre></div> </div> </div> @@ -137,7 +137,7 @@ console because groonga-httpd runs as a daemon process by default.:</p> <h3>7.1.5.3.2. Request queries<a class="headerlink" href="#request-queries" title="Permalink to this headline">¶</a></h3> <p>To check, request a simple query (<a class="reference internal" href="../commands/status.html"><em>status</em></a>).</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>% curl http://localhost:10041/d/status +<div class="highlight-none"><div class="highlight"><pre><span></span>% curl http://localhost:10041/d/status [ [ 0, @@ -164,18 +164,18 @@ console because groonga-httpd runs as a daemon process by default.:</p> <p>You can load data by POST JSON data.</p> <p>Here is an example <code class="docutils literal"><span class="pre">curl</span></code> command line that loads two users <code class="docutils literal"><span class="pre">alice</span></code> and <code class="docutils literal"><span class="pre">bob</span></code> to <code class="docutils literal"><span class="pre">Users</span></code> table:</p> -<div class="highlight-none"><div class="highlight"><pre>% curl --data-binary '[{"_key": "alice"}, {"_key": "bob"}]' -H "Content-Type: application/json" "http://localhost:10041/d/load?table=Users" +<div class="highlight-none"><div class="highlight"><pre><span></span>% curl --data-binary '[{"_key": "alice"}, {"_key": "bob"}]' -H "Content-Type: application/json" "http://localhost:10041/d/load?table=Users" </pre></div> </div> <p>If you loads users from JSON file, prepare JSON file like this:</p> -<div class="highlight-none"><div class="highlight"><pre>[ +<div class="highlight-none"><div class="highlight"><pre><span></span>[ {"_key": "alice"}, {"_key": "bob"} ] </pre></div> </div> <p>Then specify JSON file in <code class="docutils literal"><span class="pre">curl</span></code> command line:</p> -<div class="highlight-none"><div class="highlight"><pre>% curl -X POST 'http://localhost:10041/d/load?table=Users' -H 'Content-Type: application/json' -d****@users***** +<div class="highlight-none"><div class="highlight"><pre><span></span>% curl -X POST 'http://localhost:10041/d/load?table=Users' -H 'Content-Type: application/json' -d****@users***** </pre></div> </div> </div> @@ -186,7 +186,7 @@ and <code class="docutils literal"><span class="pre">bob</span></code> to <code <div class="section" id="shut-down"> <h3>7.1.5.3.5. Shut down<a class="headerlink" href="#shut-down" title="Permalink to this headline">¶</a></h3> <p>Finally, to terminate the running groonga-httpd daemon, run this:</p> -<div class="highlight-none"><div class="highlight"><pre>% groonga-httpd -s stop +<div class="highlight-none"><div class="highlight"><pre><span></span>% groonga-httpd -s stop </pre></div> </div> </div> @@ -204,7 +204,7 @@ by groonga-httpd to configure groonga-httpd specific configurations.</p> <div class="section" id="groonga"> <h4>7.1.5.4.1.1. <code class="docutils literal"><span class="pre">groonga</span></code><a class="headerlink" href="#groonga" title="Permalink to this headline">¶</a></h4> <p>Synopsis:</p> -<div class="highlight-none"><div class="highlight"><pre>groonga on | off; +<div class="highlight-none"><div class="highlight"><pre><span></span>groonga on | off; </pre></div> </div> <dl class="docutils"> @@ -216,7 +216,7 @@ by groonga-httpd to configure groonga-httpd specific configurations.</p> <p>Specifies whether Groonga is enabled in the <code class="docutils literal"><span class="pre">location</span></code> block. The default is <code class="docutils literal"><span class="pre">off</span></code>. You need to specify <code class="docutils literal"><span class="pre">on</span></code> to enable groonga.</p> <p>Examples:</p> -<div class="highlight-none"><div class="highlight"><pre>location /d/ { +<div class="highlight-none"><div class="highlight"><pre><span></span>location /d/ { groonga on; # Enables groonga under /d/... path } @@ -229,7 +229,7 @@ location /d/ { <div class="section" id="groonga-database"> <span id="id1"></span><h4>7.1.5.4.1.2. <code class="docutils literal"><span class="pre">groonga_database</span></code><a class="headerlink" href="#groonga-database" title="Permalink to this headline">¶</a></h4> <p>Synopsis:</p> -<div class="highlight-none"><div class="highlight"><pre>groonga_database /path/to/groonga/database; +<div class="highlight-none"><div class="highlight"><pre><span></span>groonga_database /path/to/groonga/database; </pre></div> </div> <dl class="docutils"> @@ -244,7 +244,7 @@ directive.</p> <div class="section" id="groonga-database-auto-create"> <span id="id2"></span><h4>7.1.5.4.1.3. <code class="docutils literal"><span class="pre">groonga_database_auto_create</span></code><a class="headerlink" href="#groonga-database-auto-create" title="Permalink to this headline">¶</a></h4> <p>Synopsis:</p> -<div class="highlight-none"><div class="highlight"><pre>groonga_database_auto_create on | off; +<div class="highlight-none"><div class="highlight"><pre><span></span>groonga_database_auto_create on | off; </pre></div> </div> <dl class="docutils"> @@ -266,7 +266,7 @@ changed.</p> <div class="section" id="groonga-base-path"> <h4>7.1.5.4.1.4. <code class="docutils literal"><span class="pre">groonga_base_path</span></code><a class="headerlink" href="#groonga-base-path" title="Permalink to this headline">¶</a></h4> <p>Synopsis:</p> -<div class="highlight-none"><div class="highlight"><pre>groonga_base_path /d/; +<div class="highlight-none"><div class="highlight"><pre><span></span>groonga_base_path /d/; </pre></div> </div> <dl class="docutils"> @@ -287,7 +287,7 @@ uses <code class="docutils literal"><span class="pre">/d/command?parameter1=valu configuration.</p> <p>Here is an example configuration to add authorization to <a class="reference internal" href="../commands/shutdown.html"><em>shutdown</em></a> command:</p> -<div class="highlight-none"><div class="highlight"><pre>groonga_database /var/lib/groonga/db/db; +<div class="highlight-none"><div class="highlight"><pre><span></span>groonga_database /var/lib/groonga/db/db; location /d/shutdown { groonga on; @@ -311,7 +311,7 @@ location /d/ { <div class="section" id="groonga-log-path"> <span id="id3"></span><h4>7.1.5.4.1.5. <code class="docutils literal"><span class="pre">groonga_log_path</span></code><a class="headerlink" href="#groonga-log-path" title="Permalink to this headline">¶</a></h4> <p>Synopsis:</p> -<div class="highlight-none"><div class="highlight"><pre>groonga_log_path path | off; +<div class="highlight-none"><div class="highlight"><pre><span></span>groonga_log_path path | off; </pre></div> </div> <dl class="docutils"> @@ -324,7 +324,7 @@ location /d/ { default is <code class="docutils literal"><span class="pre">/var/log/groonga/httpd/groonga.log</span></code>. You can disable logging to specify <code class="docutils literal"><span class="pre">off</span></code>.</p> <p>Examples:</p> -<div class="highlight-none"><div class="highlight"><pre>location /d/ { +<div class="highlight-none"><div class="highlight"><pre><span></span>location /d/ { groonga on; # You can disable log for groonga. groonga_log_path off; @@ -335,7 +335,7 @@ You can disable logging to specify <code class="docutils literal"><span class="p <div class="section" id="groonga-log-level"> <span id="id4"></span><h4>7.1.5.4.1.6. <code class="docutils literal"><span class="pre">groonga_log_level</span></code><a class="headerlink" href="#groonga-log-level" title="Permalink to this headline">¶</a></h4> <p>Synopsis:</p> -<div class="highlight-none"><div class="highlight"><pre>groonga_log_level none | emergency | alert | ciritical | error | warning | notice | info | debug | dump; +<div class="highlight-none"><div class="highlight"><pre><span></span>groonga_log_level none | emergency | alert | ciritical | error | warning | notice | info | debug | dump; </pre></div> </div> <dl class="docutils"> @@ -347,7 +347,7 @@ You can disable logging to specify <code class="docutils literal"><span class="p <p>Specifies Groonga log level in the <code class="docutils literal"><span class="pre">http</span></code>, <code class="docutils literal"><span class="pre">server</span></code> or <code class="docutils literal"><span class="pre">location</span></code> block. The default is <code class="docutils literal"><span class="pre">notice</span></code>. You can disable logging by specifying <code class="docutils literal"><span class="pre">none</span></code> as log level.</p> <p>Examples:</p> -<div class="highlight-none"><div class="highlight"><pre>location /d/ { +<div class="highlight-none"><div class="highlight"><pre><span></span>location /d/ { groonga on; # You can customize log level for groonga. groonga_log_level notice; @@ -358,7 +358,7 @@ default is <code class="docutils literal"><span class="pre">notice</span></code> <div class="section" id="groonga-query-log-path"> <span id="id5"></span><h4>7.1.5.4.1.7. <code class="docutils literal"><span class="pre">groonga_query_log_path</span></code><a class="headerlink" href="#groonga-query-log-path" title="Permalink to this headline">¶</a></h4> <p>Synopsis:</p> -<div class="highlight-none"><div class="highlight"><pre>groonga_query_log_path path | off; +<div class="highlight-none"><div class="highlight"><pre><span></span>groonga_query_log_path path | off; </pre></div> </div> <dl class="docutils"> @@ -372,7 +372,7 @@ default is <code class="docutils literal"><span class="pre">notice</span></code> <code class="docutils literal"><span class="pre">/var/log/groonga/httpd/groonga-query.log</span></code>. You can disable logging to specify <code class="docutils literal"><span class="pre">off</span></code>.</p> <p>Examples:</p> -<div class="highlight-none"><div class="highlight"><pre>location /d/ { +<div class="highlight-none"><div class="highlight"><pre><span></span>location /d/ { groonga on; # You can disable query log for groonga. groonga_query_log_path off; @@ -410,7 +410,7 @@ see <a class="reference external" href="http://wiki.nginx.org/CoreModule#worker_ <span id="id6"></span><h4>7.1.5.4.2.2. <code class="docutils literal"><span class="pre">groonga_cache_limit</span></code><a class="headerlink" href="#groonga-cache-limit" title="Permalink to this headline">¶</a></h4> <p>This directive is introduced to customize cache limit for each worker process.</p> <p>Synopsis:</p> -<div class="highlight-none"><div class="highlight"><pre>groonga_cache_limit CACHE_LIMIT; +<div class="highlight-none"><div class="highlight"><pre><span></span>groonga_cache_limit CACHE_LIMIT; </pre></div> </div> <dl class="docutils"> @@ -423,7 +423,7 @@ see <a class="reference external" href="http://wiki.nginx.org/CoreModule#worker_ <code class="docutils literal"><span class="pre">location</span></code> block. The default value is 100. You can disable query cache to specify 0 to <code class="docutils literal"><span class="pre">groonga_cache_limit</span></code> explicitly.</p> <p>Examples:</p> -<div class="highlight-none"><div class="highlight"><pre>location /d/ { +<div class="highlight-none"><div class="highlight"><pre><span></span>location /d/ { groonga on; # You can customize query cache limit for groonga. groonga_cache_limit 100; @@ -451,21 +451,21 @@ isn't a big problem. If you want to change cache size by <a class="reference internal" href="../commands/cache_limit.html"><em>cache_limit</em></a> command, there is a problem.</p> <p>There is no portable ways to change cache size for all workers.</p> <p>For example, there are 3 workers:</p> -<div class="highlight-none"><div class="highlight"><pre> +-- worker 1 +<div class="highlight-none"><div class="highlight"><pre><span></span> +-- worker 1 client -- groonga-httpd (master) --+-- worker 2 +-- worker 3 </pre></div> </div> <p>The client requests <a class="reference internal" href="../commands/cache_limit.html"><em>cache_limit</em></a> command and the worker 1 receives it:</p> -<div class="highlight-none"><div class="highlight"><pre> +-> worker 1 (changed!) +<div class="highlight-none"><div class="highlight"><pre><span></span> +-> worker 1 (changed!) client -> groonga-httpd (master) --+-- worker 2 +-- worker 3 </pre></div> </div> <p>The client requests <a class="reference internal" href="../commands/cache_limit.html"><em>cache_limit</em></a> command again and the worker 1 receives it again:</p> -<div class="highlight-none"><div class="highlight"><pre> +-> worker 1 (changed again!!!) +<div class="highlight-none"><div class="highlight"><pre><span></span> +-> worker 1 (changed again!!!) client -> groonga-httpd (master) --+-- worker 2 +-- worker 3 </pre></div> @@ -478,7 +478,7 @@ workers by <a class="reference internal" href="../commands/cache_limit.html"><em <div class="section" id="reverse-proxy-and-cache"> <h5>7.1.5.4.2.3.2. Reverse proxy and cache<a class="headerlink" href="#reverse-proxy-and-cache" title="Permalink to this headline">¶</a></h5> <p>You can use nginx's reverse proxy and cache feature for query cache:</p> -<div class="highlight-none"><div class="highlight"><pre> +-- worker 1 +<div class="highlight-none"><div class="highlight"><pre><span></span> +-- worker 1 client -- groonga-httpd (master) -- reverse proxy + cache --+-- worker 2 +-- worker 3 </pre></div> @@ -486,7 +486,7 @@ client -- groonga-httpd (master) -- reverse proxy + cache --+-- worker 2 <p>You can use the same cache configuration for all workers but you can't change cache configuration dynamically by HTTP.</p> <p>Here is a sample configuration:</p> -<div class="highlight-none"><div class="highlight"><pre>... +<div class="highlight-none"><div class="highlight"><pre><span></span>... http { proxy_cache_path /var/cache/groonga-httpd levels=1:2 keys_zone=groonga:10m; proxy_cache_valid 10m; @@ -532,7 +532,7 @@ http { <p>Note that you need to remove cache files created by nginx by hand after you load new data to Groonga. For the above sample configuration, run the following command to remove cache files:</p> -<div class="highlight-none"><div class="highlight"><pre>% groonga DB_PATH < load.grn +<div class="highlight-none"><div class="highlight"><pre><span></span>% groonga DB_PATH < load.grn % rm -rf /var/cache/groonga-httpd/* </pre></div> </div> Modified: docs/reference/executables/groonga-server-http.html (+2 -2) =================================================================== --- docs/reference/executables/groonga-server-http.html 2016-03-05 15:09:34 +0900 (31a4856) +++ docs/reference/executables/groonga-server-http.html 2016-03-17 12:56:59 +0900 (61c7108) @@ -92,7 +92,7 @@ </div> <div class="section" id="synopsis"> <h2>7.1.6.2. Synopsis<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2> -<div class="highlight-none"><div class="highlight"><pre>groonga -d --protocol http DB_PATH +<div class="highlight-none"><div class="highlight"><pre><span></span>groonga -d --protocol http DB_PATH </pre></div> </div> </div> @@ -112,7 +112,7 @@ </div></blockquote> <p>Format 1 and Format 2 are possible to mix. Output type is specified by <code class="docutils literal"><span class="pre">output_type</span></code> in the formats.</p> <p>In HTTP server mode, the following formats to specify command:</p> -<div class="highlight-none"><div class="highlight"><pre>Format: /d/COMMAND_NAME.OUTPUT_TYPE?ARGUMENT_NAME1=VALUE1&ARGUMENT_NAME2=VALUE2&... +<div class="highlight-none"><div class="highlight"><pre><span></span>Format: /d/COMMAND_NAME.OUTPUT_TYPE?ARGUMENT_NAME1=VALUE1&ARGUMENT_NAME2=VALUE2&... </pre></div> </div> <p>But, they need URL encode for command names, arguments names and values.</p> Modified: docs/reference/executables/groonga-suggest-create-dataset.html (+1 -1) =================================================================== --- docs/reference/executables/groonga-suggest-create-dataset.html 2016-03-05 15:09:34 +0900 (be245cc) +++ docs/reference/executables/groonga-suggest-create-dataset.html 2016-03-17 12:56:59 +0900 (e048599) @@ -92,7 +92,7 @@ </div> <div class="section" id="synopstis"> <h2>7.1.7.2. SYNOPSTIS<a class="headerlink" href="#synopstis" title="Permalink to this headline">¶</a></h2> -<div class="highlight-none"><div class="highlight"><pre>groonga-suggest-create-dataset [options] DATABASE DATASET +<div class="highlight-none"><div class="highlight"><pre><span></span>groonga-suggest-create-dataset [options] DATABASE DATASET </pre></div> </div> </div> Modified: docs/reference/executables/groonga-suggest-httpd.html (+7 -7) =================================================================== --- docs/reference/executables/groonga-suggest-httpd.html 2016-03-05 15:09:34 +0900 (7ae2ff1) +++ docs/reference/executables/groonga-suggest-httpd.html 2016-03-17 12:56:59 +0900 (d4fe211) @@ -93,7 +93,7 @@ groonga-suggest-httpd behaves similar in point of view of suggestion functionali </div> <div class="section" id="synopsis"> <h2>7.1.8.2. Synopsis<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2> -<div class="highlight-none"><div class="highlight"><pre>groonga-suggest-httpd [options] database_path +<div class="highlight-none"><div class="highlight"><pre><span></span>groonga-suggest-httpd [options] database_path </pre></div> </div> </div> @@ -103,7 +103,7 @@ groonga-suggest-httpd behaves similar in point of view of suggestion functionali <h3>7.1.8.3.1. Set up<a class="headerlink" href="#set-up" title="Permalink to this headline">¶</a></h3> <p>First you need to set up database for suggestion.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>% groonga-suggest-create-dataset /tmp/groonga-databases/groonga-suggest-httpd query +<div class="highlight-none"><div class="highlight"><pre><span></span>% groonga-suggest-create-dataset /tmp/groonga-databases/groonga-suggest-httpd query </pre></div> </div> </div> @@ -111,13 +111,13 @@ groonga-suggest-httpd behaves similar in point of view of suggestion functionali <h3>7.1.8.3.2. Launch groonga-suggest-httpd<a class="headerlink" href="#launch-groonga-suggest-httpd" title="Permalink to this headline">¶</a></h3> <p>Execute groonga-suggest-httpd command:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>% groonga-suggest-httpd /tmp/groonga-databases/groonga-suggest-httpd +<div class="highlight-none"><div class="highlight"><pre><span></span>% groonga-suggest-httpd /tmp/groonga-databases/groonga-suggest-httpd </pre></div> </div> <p>After executing above command, groonga-suggest-httpd accepts HTTP request on 8080 port.</p> <p>If you just want to save requests into log file, use <code class="docutils literal"><span class="pre">-l</span></code> option.</p> <p>Here is the example to save log files under <code class="docutils literal"><span class="pre">logs</span></code> directory with <code class="docutils literal"><span class="pre">log</span></code> prefix for each file.:</p> -<div class="highlight-none"><div class="highlight"><pre>% groonga-suggest-httpd -l logs/log /tmp/groonga-databases/groonga-suggest-httpd +<div class="highlight-none"><div class="highlight"><pre><span></span>% groonga-suggest-httpd -l logs/log /tmp/groonga-databases/groonga-suggest-httpd </pre></div> </div> <p>Under <code class="docutils literal"><span class="pre">logs</span></code> directory, log files such as <code class="docutils literal"><span class="pre">logYYYYmmddHHMMSS-00</span></code> are created.</p> @@ -125,7 +125,7 @@ groonga-suggest-httpd behaves similar in point of view of suggestion functionali <div class="section" id="request-to-groonga-suggest-httpd"> <h3>7.1.8.3.3. Request to groonga-suggest-httpd<a class="headerlink" href="#request-to-groonga-suggest-httpd" title="Permalink to this headline">¶</a></h3> <p>Here is the sample requests to learn <code class="docutils literal"><span class="pre">groonga</span></code> for <code class="docutils literal"><span class="pre">query</span></code> dataset:</p> -<div class="highlight-none"><div class="highlight"><pre>% curl 'http://localhost:8080/?i=127.0.0.1&l=query&s=92619&t=complete&q=g' +<div class="highlight-none"><div class="highlight"><pre><span></span>% curl 'http://localhost:8080/?i=127.0.0.1&l=query&s=92619&t=complete&q=g' % curl 'http://localhost:8080/?i=127.0.0.1&l=query&s=93850&t=complete&q=gr' % curl 'http://localhost:8080/?i=127.0.0.1&l=query&s=94293&t=complete&q=gro' % curl 'http://localhost:8080/?i=127.0.0.1&l=query&s=94734&t=complete&q=groo' @@ -306,11 +306,11 @@ performance.</p> <h2>7.1.8.7. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2> <p><code class="docutils literal"><span class="pre">groonga-suggest-httpd</span></code> command returns following response in JSON or JSONP format.</p> <p>In JSON format:</p> -<div class="highlight-none"><div class="highlight"><pre>{TYPE: [[CANDIDATE_1, SCORE_1], [CANDIDATE_2, SCORE_2], ... [CANDIDATE_N, SCORE_N]]} +<div class="highlight-none"><div class="highlight"><pre><span></span>{TYPE: [[CANDIDATE_1, SCORE_1], [CANDIDATE_2, SCORE_2], ... [CANDIDATE_N, SCORE_N]]} </pre></div> </div> <p>In JSONP format:</p> -<div class="highlight-none"><div class="highlight"><pre>FUNCTION({TYPE: [[CANDIDATE_1, SCORE_1], [CANDIDATE_2, SCORE_2], ... [CANDIDATE_N, SCORE_N]]}) +<div class="highlight-none"><div class="highlight"><pre><span></span>FUNCTION({TYPE: [[CANDIDATE_1, SCORE_1], [CANDIDATE_2, SCORE_2], ... [CANDIDATE_N, SCORE_N]]}) </pre></div> </div> <p><code class="docutils literal"><span class="pre">TYPE</span></code></p> Modified: docs/reference/executables/groonga-suggest-learner.html (+3 -3) =================================================================== --- docs/reference/executables/groonga-suggest-learner.html 2016-03-05 15:09:34 +0900 (6f58693) +++ docs/reference/executables/groonga-suggest-learner.html 2016-03-17 12:56:59 +0900 (f520e34) @@ -94,7 +94,7 @@ In such a case, groonga-suggest-learner loads data from log directory.</p> </div> <div class="section" id="synopsis"> <h2>7.1.9.2. Synopsis<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2> -<div class="highlight-none"><div class="highlight"><pre>groonga-suggest-learner [options] database_path +<div class="highlight-none"><div class="highlight"><pre><span></span>groonga-suggest-learner [options] database_path </pre></div> </div> </div> @@ -106,7 +106,7 @@ learning data from already existing log files.</p> <div class="section" id="learning-data-from-groonga-suggest-httpd"> <h3>7.1.9.3.1. Learning data from groonga-suggest-httpd<a class="headerlink" href="#learning-data-from-groonga-suggest-httpd" title="Permalink to this headline">¶</a></h3> <p>Execute groonga-suggest-learner.:</p> -<div class="highlight-none"><div class="highlight"><pre>groonga-suggest-learner testdb/db +<div class="highlight-none"><div class="highlight"><pre><span></span>groonga-suggest-learner testdb/db </pre></div> </div> </div> @@ -114,7 +114,7 @@ learning data from already existing log files.</p> <h3>7.1.9.3.2. Learning data from log files<a class="headerlink" href="#learning-data-from-log-files" title="Permalink to this headline">¶</a></h3> <p>Execute groonga-suggest-learner with <code class="docutils literal"><span class="pre">-l</span></code> option.</p> <p>Here is the sample to load log data under <code class="docutils literal"><span class="pre">logs</span></code> directory:</p> -<div class="highlight-none"><div class="highlight"><pre>groonga-suggest-learner -l logs testdb/db +<div class="highlight-none"><div class="highlight"><pre><span></span>groonga-suggest-learner -l logs testdb/db </pre></div> </div> </div> Modified: docs/reference/executables/groonga.html (+21 -21) =================================================================== --- docs/reference/executables/groonga.html 2016-03-05 15:09:34 +0900 (8b2bf5f) +++ docs/reference/executables/groonga.html 2016-03-17 12:56:59 +0900 (c1ea0cd) @@ -105,7 +105,7 @@ feature.</p> <p>If you want to try Groonga, fulltext search shell usage is useful. You don't need any server and client. You just need one terminal. You can try Groonga like the following:</p> -<div class="highlight-none"><div class="highlight"><pre>% groonga -n db +<div class="highlight-none"><div class="highlight"><pre><span></span>% groonga -n db > status [[0,1429687763.70845,0.000115633010864258],{"alloc_count":195,...}] > quit @@ -137,22 +137,22 @@ described later section.</p> Groonga <a class="reference internal" href="../command.html"><em>Command</em></a> against a local Groonga database.</p> <p>Here is the syntax to run shell that executes Groonga command against temporary database:</p> -<div class="highlight-none"><div class="highlight"><pre>groonga [options] +<div class="highlight-none"><div class="highlight"><pre><span></span>groonga [options] </pre></div> </div> <p>Here is the syntax to create a new database and run shell that executes Groonga command against the new database:</p> -<div class="highlight-none"><div class="highlight"><pre>groonga [options] -n DB_PATH +<div class="highlight-none"><div class="highlight"><pre><span></span>groonga [options] -n DB_PATH </pre></div> </div> <p>Here is the syntax to run shell that executes Groonga command against existing database:</p> -<div class="highlight-none"><div class="highlight"><pre>groonga [options] DB_PATH +<div class="highlight-none"><div class="highlight"><pre><span></span>groonga [options] DB_PATH </pre></div> </div> <p>Here is the syntax to run Groonga command against existing database and exit:</p> -<div class="highlight-none"><div class="highlight"><pre>groonga [options] DB_PATH COMMAND [command arguments] +<div class="highlight-none"><div class="highlight"><pre><span></span>groonga [options] DB_PATH COMMAND [command arguments] </pre></div> </div> </div> @@ -170,16 +170,16 @@ usage.</p> you want to run Groonga server in the background, see <a class="reference internal" href="#groonga-executable-file-daemon-mode"><span>Daemon mode</span></a>.</p> <p>Here is the syntax to run Groonga server with temporary database:</p> -<div class="highlight-none"><div class="highlight"><pre>groonga [options] --protocol http -s +<div class="highlight-none"><div class="highlight"><pre><span></span>groonga [options] --protocol http -s </pre></div> </div> <p>Here is the syntax to create a new database and run Groonga server with the new database:</p> -<div class="highlight-none"><div class="highlight"><pre>groonga [options] --protocol http -s -n DB_PATH +<div class="highlight-none"><div class="highlight"><pre><span></span>groonga [options] --protocol http -s -n DB_PATH </pre></div> </div> <p>Here is the syntax to run Groonga server with existing database:</p> -<div class="highlight-none"><div class="highlight"><pre>groonga [options] --protocol http -s DB_PATH +<div class="highlight-none"><div class="highlight"><pre><span></span>groonga [options] --protocol http -s DB_PATH </pre></div> </div> </div> @@ -189,16 +189,16 @@ with the new database:</p> is similar to server but it runs in the background. See <a class="reference internal" href="#groonga-executable-file-server-mode"><span>Server mode</span></a> about server.</p> <p>Here is the syntax to run Groonga daemon with temporary database:</p> -<div class="highlight-none"><div class="highlight"><pre>groonga [options] --protocol http -d +<div class="highlight-none"><div class="highlight"><pre><span></span>groonga [options] --protocol http -d </pre></div> </div> <p>Here is the syntax to create a new database and run Groonga daemon with the new database:</p> -<div class="highlight-none"><div class="highlight"><pre>groonga [options] --protocol http -d -n DB_PATH +<div class="highlight-none"><div class="highlight"><pre><span></span>groonga [options] --protocol http -d -n DB_PATH </pre></div> </div> <p>Here is the syntax to run Groonga daemon with existing database:</p> -<div class="highlight-none"><div class="highlight"><pre>groonga [options] --protocol http -d DB_PATH +<div class="highlight-none"><div class="highlight"><pre><span></span>groonga [options] --protocol http -d DB_PATH </pre></div> </div> <p><a class="reference internal" href="#cmdoption--pid-path"><code class="xref std std-option docutils literal"><span class="pre">--pid-path</span></code></a> option will be useful for daemon mode.</p> @@ -214,12 +214,12 @@ local database.</p> protocol Groonga server.</p> <p>Here is the syntax to run shell that executes Groonga command against Groonga server that is running at <code class="docutils literal"><span class="pre">192.168.0.1:10043</span></code>:</p> -<div class="highlight-none"><div class="highlight"><pre>groonga [options] -c --host 192.168.0.1 --port 10043 +<div class="highlight-none"><div class="highlight"><pre><span></span>groonga [options] -c --host 192.168.0.1 --port 10043 </pre></div> </div> <p>Here is the syntax to run Groonga command against Groonga server that is running at <code class="docutils literal"><span class="pre">192.168.0.1:10043</span></code> and exit:</p> -<div class="highlight-none"><div class="highlight"><pre>groonga [options] -c --host 192.168.0.1 --port 10043 COMMAND [command arguments] +<div class="highlight-none"><div class="highlight"><pre><span></span>groonga [options] -c --host 192.168.0.1 --port 10043 COMMAND [command arguments] </pre></div> </div> </div> @@ -397,7 +397,7 @@ is running at <code class="docutils literal"><span class="pre">192.168.0.1:10043 <dt id="cmdoption--config-path"> <code class="descname">--config-path</code><code class="descclassname"> <path></code><a class="headerlink" href="#cmdoption--config-path" title="Permalink to this definition">¶</a></dt> <dd><p>設定ファイルのパスを指定します。設定ファイルは以下のようなフォーマットになります。:</p> -<div class="highlight-none"><div class="highlight"><pre># '#'以降はコメント。 +<div class="highlight-none"><div class="highlight"><pre><span></span># '#'以降はコメント。 ; ';'以降もコメント。 # 'キー = 値'でオプションを指定。 @@ -447,7 +447,7 @@ pid-path=/var/run/groonga.pid <p>groongaコマンドを通してデータベースを操作する命令をコマンドと呼びます。コマンドは主にC言語で記述され、groongaプロセスにロードすることによって使用できるようになります。 それぞれのコマンドは一意な名前と、0個以上の引数を持ちます。</p> <p>引数は以下の2種類の方法のいずれかで指定することができます。:</p> -<div class="highlight-none"><div class="highlight"><pre>形式1: コマンド名 値1 値2,.. +<div class="highlight-none"><div class="highlight"><pre><span></span>形式1: コマンド名 値1 値2,.. 形式2: コマンド名 --引数名1 値1 --引数名2 値2,.. </pre></div> @@ -455,7 +455,7 @@ pid-path=/var/run/groonga.pid <p>形式1でコマンドを実行する場合は、定義された順番で値を指定しなければならず、途中の引数の値を省略することはできません。形式2でコマンドを実行する場合は、「--引数名」のように引数の名前を明示しなければならない代わりに、任意の順番で引数を指定することが可能で、途中の引数の指定を省略することもできます。</p> <p>標準入力からコマンド文字列を与える場合は、コマンド名と引数名と値は、空白( )で区切ります。空白や、記号「"'()」のうちいずれかを含む値を指定したい場合は、シングルクォート(')かダブルクォート(")で値を囲みます。値として指定する文字列の中では、改行文字は'n'に置き換えて指定します。また、引用符に使用した文字を値の中で指定する場合には、その文字の前にバックスラッシュ('') を指定します。バックスラッシュ文字自身を値として指定する場合には、その前にバックスラッシュを指定します。</p> <p>You can write command list with continuous line which is represented by '\' character.:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create --name Terms \ +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create --name Terms \ --flags TABLE_PAT_KEY \ --key_type ShortText \ --default_tokenizer TokenBigram @@ -503,28 +503,28 @@ pid-path=/var/run/groonga.pid <div class="section" id="usage"> <h2>7.1.3.7. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2> <p>新しいデータベースを作成します。:</p> -<div class="highlight-none"><div class="highlight"><pre>% groonga -n /tmp/hoge.db quit +<div class="highlight-none"><div class="highlight"><pre><span></span>% groonga -n /tmp/hoge.db quit % </pre></div> </div> <p>作成済みのデータベースにテーブルを定義します。:</p> -<div class="highlight-none"><div class="highlight"><pre>% groonga /tmp/hoge.db table_create Table 0 ShortText +<div class="highlight-none"><div class="highlight"><pre><span></span>% groonga /tmp/hoge.db table_create Table 0 ShortText [[0]] % </pre></div> </div> <p>サーバを起動します。:</p> -<div class="highlight-none"><div class="highlight"><pre>% groonga -d /tmp/hoge.db +<div class="highlight-none"><div class="highlight"><pre><span></span>% groonga -d /tmp/hoge.db % </pre></div> </div> <p>httpサーバとして起動します。:</p> -<div class="highlight-none"><div class="highlight"><pre>% groonga -d -p 80 --protocol http --document-root /usr/share/groonga/admin_html /tmp/hoge.db +<div class="highlight-none"><div class="highlight"><pre><span></span>% groonga -d -p 80 --protocol http --document-root /usr/share/groonga/admin_html /tmp/hoge.db % </pre></div> </div> <p>サーバに接続し、テーブル一覧を表示します。:</p> -<div class="highlight-none"><div class="highlight"><pre>% groonga -c localhost table_list +<div class="highlight-none"><div class="highlight"><pre><span></span>% groonga -c localhost table_list [[0],[["id","name","path","flags","domain"],[256,"Table","/tmp/hoge.db.0000100",49152,14]]] % </pre></div> Modified: docs/reference/functions/between.html (+4 -4) =================================================================== --- docs/reference/functions/between.html 2016-03-05 15:09:34 +0900 (1014b37) +++ docs/reference/functions/between.html 2016-03-17 12:56:59 +0900 (0519cee) @@ -94,7 +94,7 @@ It is often used for combination with <a class="reference internal" href="../com <div class="section" id="syntax"> <h2>7.14.1.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> <p><code class="docutils literal"><span class="pre">between</span></code> has five parameters:</p> -<div class="highlight-none"><div class="highlight"><pre>between(column_or_value, min, min_border, max, max_border) +<div class="highlight-none"><div class="highlight"><pre><span></span>between(column_or_value, min, min_border, max, max_border) </pre></div> </div> </div> @@ -102,7 +102,7 @@ It is often used for combination with <a class="reference internal" href="../com <h2>7.14.1.3. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2> <p>Here are a schema definition and sample data to show usage:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Users TABLE_HASH_KEY ShortText +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Users TABLE_HASH_KEY ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] column_create Users age COLUMN_SCALAR Int32 # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -124,7 +124,7 @@ load --table Users </div> <p>Here is the query to show the persons to match PG-13 rating (MPAA).</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Users --filter 'between(age, 13, "include", 16, "include")' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Users --filter 'between(age, 13, "include", 16, "include")' # [ # [ # 0, @@ -175,7 +175,7 @@ load --table Users <p>If you specify the value as 1st parameter, it is checked whether the value is included or not. if it matches to the specified range, it returns the all records because <code class="docutils literal"><span class="pre">between</span></code> function returns true.</p> <p>If it doesn't match to the specified range, it returns no records because <code class="docutils literal"><span class="pre">between</span></code> function returns false.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Users --filter 'between(14, 13, "include", 16, "include")' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Users --filter 'between(14, 13, "include", 16, "include")' # [ # [ # 0, Modified: docs/reference/functions/edit_distance.html (+2 -2) =================================================================== --- docs/reference/functions/edit_distance.html 2016-03-05 15:09:34 +0900 (116a853) +++ docs/reference/functions/edit_distance.html 2016-03-17 12:56:59 +0900 (0820c7a) @@ -92,7 +92,7 @@ </div> <div class="section" id="id2"> <h2>7.14.2.2. 書式<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h2> -<div class="highlight-none"><div class="highlight"><pre>edit_distance(string1, string2) +<div class="highlight-none"><div class="highlight"><pre><span></span>edit_distance(string1, string2) </pre></div> </div> </div> @@ -116,7 +116,7 @@ </div> <div class="section" id="id6"> <h2>7.14.2.6. 例<a class="headerlink" href="#id6" title="Permalink to this headline">¶</a></h2> -<div class="highlight-none"><div class="highlight"><pre>edit_distance(title, "hoge") +<div class="highlight-none"><div class="highlight"><pre><span></span>edit_distance(title, "hoge") 1 </pre></div> </div> Modified: docs/reference/functions/geo_distance.html (+17 -17) =================================================================== --- docs/reference/functions/geo_distance.html 2016-03-05 15:09:34 +0900 (01d7499) +++ docs/reference/functions/geo_distance.html 2016-03-17 12:56:59 +0900 (2312f00) @@ -94,7 +94,7 @@ <h2>7.14.3.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> <p><code class="docutils literal"><span class="pre">geo_distance</span></code> requires two point. The parameter <code class="docutils literal"><span class="pre">approximate_type</span></code> is optional:</p> -<div class="highlight-none"><div class="highlight"><pre>geo_distance(point1, point2) +<div class="highlight-none"><div class="highlight"><pre><span></span>geo_distance(point1, point2) geo_distance(point1, point2, approximate_type) </pre></div> </div> @@ -128,7 +128,7 @@ Those samples show how to calculate the value of distance between New York City <div class="section" id="using-the-column-value-of-location"> <h3>7.14.3.3.1. Using the column value of location<a class="headerlink" href="#using-the-column-value-of-location" title="Permalink to this headline">¶</a></h3> <p>Here are a schema definition of <code class="docutils literal"><span class="pre">Cities</span></code> table and sample data to show usage.</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Cities TABLE_HASH_KEY ShortText +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Cities TABLE_HASH_KEY ShortText column_create Cities location COLUMN_SCALAR WGS84GeoPoint load --table Cities [ @@ -142,7 +142,7 @@ load --table Cities </pre></div> </div> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Cities TABLE_HASH_KEY ShortText +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Cities TABLE_HASH_KEY ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] column_create Cities location COLUMN_SCALAR WGS84GeoPoint # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -162,7 +162,7 @@ load --table Cities <code class="docutils literal"><span class="pre">location</span></code> column stores the value of coordinate. The coordinate of Tokyo is stored as sample data.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Cities --output_columns _score --filter 1 --scorer '_score = geo_distance(location, "185428000x-461000", "rectangle")' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Cities --output_columns _score --filter 1 --scorer '_score = geo_distance(location, "185428000x-461000", "rectangle")' # [ # [ # 0, @@ -196,7 +196,7 @@ the coordinate of London.</p> <div class="section" id="using-the-explicitly-specified-value-of-location"> <h3>7.14.3.3.2. Using the explicitly specified value of location<a class="headerlink" href="#using-the-explicitly-specified-value-of-location" title="Permalink to this headline">¶</a></h3> <p>Here are a schema definition of <code class="docutils literal"><span class="pre">Geo</span></code> table and sample data to show usage.</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Geo TABLE_HASH_KEY ShortText +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Geo TABLE_HASH_KEY ShortText column_create Geo distance COLUMN_SCALAR Int32 load --table Geo [ @@ -207,7 +207,7 @@ load --table Geo </pre></div> </div> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Geo TABLE_HASH_KEY ShortText +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Geo TABLE_HASH_KEY ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] column_create Geo distance COLUMN_SCALAR Int32 # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -223,7 +223,7 @@ load --table Geo <p>This execution example creates a table named <code class="docutils literal"><span class="pre">Geo</span></code> which has one column named <code class="docutils literal"><span class="pre">distance</span></code>. <code class="docutils literal"><span class="pre">distance</span></code> column stores the value of distance.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Geo --output_columns distance --scorer 'distance = geo_distance("146566000x-266422000", "185428000x-461000", "rectangle")' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Geo --output_columns distance --scorer 'distance = geo_distance("146566000x-266422000", "185428000x-461000", "rectangle")' # [ # [ # 0, @@ -255,8 +255,8 @@ and the coordinate of New York to calculate distance.</p> </div> <div class="section" id="parameters"> <h2>7.14.3.4. Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></h2> -<div class="section" id="required-parameter"> -<h3>7.14.3.4.1. Required parameter<a class="headerlink" href="#required-parameter" title="Permalink to this headline">¶</a></h3> +<div class="section" id="required-parameters"> +<h3>7.14.3.4.1. Required parameters<a class="headerlink" href="#required-parameters" title="Permalink to this headline">¶</a></h3> <p>There are two required parameter, <code class="docutils literal"><span class="pre">point1</span></code> and <code class="docutils literal"><span class="pre">point2</span></code>.</p> <div class="section" id="point1"> <h4>7.14.3.4.1.1. <code class="docutils literal"><span class="pre">point1</span></code><a class="headerlink" href="#point1" title="Permalink to this headline">¶</a></h4> @@ -308,7 +308,7 @@ But, the error of distance increases as it approaches the pole.</p> <p>You can also specify <code class="docutils literal"><span class="pre">rect</span></code> as abbrev expression.</p> <p>Here is a sample about calculating the value of distance with column value.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Cities --output_columns _score --filter 1 --scorer '_score = geo_distance(location, "185428000x-461000", "rectangle")' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Cities --output_columns _score --filter 1 --scorer '_score = geo_distance(location, "185428000x-461000", "rectangle")' # [ # [ # 0, @@ -336,7 +336,7 @@ But, the error of distance increases as it approaches the pole.</p> </div> <p>Here is a sample about calculating the value of distance with explicitly specified point.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Geo --output_columns distance --scorer 'distance = geo_distance("146566000x-266422000", "185428000x-461000", "rectangle")' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Geo --output_columns distance --scorer 'distance = geo_distance("146566000x-266422000", "185428000x-461000", "rectangle")' # [ # [ # 0, @@ -364,7 +364,7 @@ But, the error of distance increases as it approaches the pole.</p> </div> <p>Here are samples about calculating the value of distance with explicitly specified point across meridian, equator, the date line.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Geo --output_columns distance --scorer 'distance = geo_distance("175904000x8464000", "145508000x-13291000", "rectangle")' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Geo --output_columns distance --scorer 'distance = geo_distance("175904000x8464000", "145508000x-13291000", "rectangle")' # [ # [ # 0, @@ -393,7 +393,7 @@ But, the error of distance increases as it approaches the pole.</p> <p>This sample shows the value of distance across meridian. The return value of <code class="docutils literal"><span class="pre">geo_distance("175904000x8464000",</span> <span class="pre">"145508000x-13291000",</span> <span class="pre">"rectangle")</span></code> is the value of distance from Paris, Flance to Madrid, Spain.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Geo --output_columns distance --scorer 'distance = geo_distance("146566000x-266422000", "-56880000x-172310000", "rectangle")' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Geo --output_columns distance --scorer 'distance = geo_distance("146566000x-266422000", "-56880000x-172310000", "rectangle")' # [ # [ # 0, @@ -422,7 +422,7 @@ The return value of <code class="docutils literal"><span class="pre">geo_distanc <p>This sample shows the value of distance across equator. The return value of <code class="docutils literal"><span class="pre">geo_distance("146566000x-266422000",</span> <span class="pre">"-56880000x-172310000",</span> <span class="pre">"rectangle")</span></code> is the value of distance from New York, The United Status to Brasillia, Brasil.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Geo --output_columns distance --scorer 'distance = geo_distance("143660000x419009000", "135960000x-440760000", "rectangle")' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Geo --output_columns distance --scorer 'distance = geo_distance("143660000x419009000", "135960000x-440760000", "rectangle")' # [ # [ # 0, @@ -473,7 +473,7 @@ smaller than <code class="docutils literal"><span class="pre">rectangle</span></ <p>You can also specify <code class="docutils literal"><span class="pre">sphr</span></code> as abbrev expression.</p> <p>Here is a sample about calculating the value of distance with column value.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Cities --output_columns _score --filter 1 --scorer '_score = geo_distance(location, "185428000x-461000", "sphere")' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Cities --output_columns _score --filter 1 --scorer '_score = geo_distance(location, "185428000x-461000", "sphere")' # [ # [ # 0, @@ -510,7 +510,7 @@ smaller than <code class="docutils literal"><span class="pre">sphere</span></cod <p>You can also specify <code class="docutils literal"><span class="pre">ellip</span></code> as abbrev expression.</p> <p>Here is a sample about calculating the value of distance with column value.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Cities --output_columns _score --filter 1 --scorer '_score = geo_distance(location, "185428000x-461000", "ellipsoid")' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Cities --output_columns _score --filter 1 --scorer '_score = geo_distance(location, "185428000x-461000", "ellipsoid")' # [ # [ # 0, @@ -571,7 +571,7 @@ The unit of return value is meter.</p> </ul> </li> <li><a class="reference internal" href="#parameters">7.14.3.4. Parameters</a><ul> -<li><a class="reference internal" href="#required-parameter">7.14.3.4.1. Required parameter</a><ul> +<li><a class="reference internal" href="#required-parameters">7.14.3.4.1. Required parameters</a><ul> <li><a class="reference internal" href="#point1">7.14.3.4.1.1. <code class="docutils literal"><span class="pre">point1</span></code></a></li> <li><a class="reference internal" href="#point2">7.14.3.4.1.2. <code class="docutils literal"><span class="pre">point2</span></code></a></li> </ul> Modified: docs/reference/functions/geo_in_circle.html (+2 -2) =================================================================== --- docs/reference/functions/geo_in_circle.html 2016-03-05 15:09:34 +0900 (ad97505) +++ docs/reference/functions/geo_in_circle.html 2016-03-17 12:56:59 +0900 (afe682d) @@ -92,7 +92,7 @@ </div> <div class="section" id="id2"> <h2>7.14.4.2. 書式<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h2> -<div class="highlight-none"><div class="highlight"><pre>geo_in_circle(point, center, radious_or_point[, approximate_type]) +<div class="highlight-none"><div class="highlight"><pre><span></span>geo_in_circle(point, center, radious_or_point[, approximate_type]) </pre></div> </div> </div> @@ -140,7 +140,7 @@ Point型の値、あるいは座標を示す文字列を指定した場合は、 </div> <div class="section" id="id7"> <h2>7.14.4.6. 例<a class="headerlink" href="#id7" title="Permalink to this headline">¶</a></h2> -<div class="highlight-none"><div class="highlight"><pre>geo_in_circle(pos, "100x100", 100) +<div class="highlight-none"><div class="highlight"><pre><span></span>geo_in_circle(pos, "100x100", 100) true </pre></div> </div> Modified: docs/reference/functions/geo_in_rectangle.html (+2 -2) =================================================================== --- docs/reference/functions/geo_in_rectangle.html 2016-03-05 15:09:34 +0900 (79a26eb) +++ docs/reference/functions/geo_in_rectangle.html 2016-03-17 12:56:59 +0900 (10743f9) @@ -92,7 +92,7 @@ </div> <div class="section" id="id2"> <h2>7.14.5.2. 書式<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h2> -<div class="highlight-none"><div class="highlight"><pre>geo_in_rectangle(point, top_left, bottom_right) +<div class="highlight-none"><div class="highlight"><pre><span></span>geo_in_rectangle(point, top_left, bottom_right) </pre></div> </div> </div> @@ -119,7 +119,7 @@ </div> <div class="section" id="id7"> <h2>7.14.5.6. 例<a class="headerlink" href="#id7" title="Permalink to this headline">¶</a></h2> -<div class="highlight-none"><div class="highlight"><pre>geo_in_rectangle(pos, "150x100", "100x150") +<div class="highlight-none"><div class="highlight"><pre><span></span>geo_in_rectangle(pos, "150x100", "100x150") true </pre></div> </div> Modified: docs/reference/functions/highlight_full.html (+4 -4) =================================================================== --- docs/reference/functions/highlight_full.html 2016-03-05 15:09:34 +0900 (c93e6fc) +++ docs/reference/functions/highlight_full.html 2016-03-17 12:56:59 +0900 (4f30d66) @@ -99,7 +99,7 @@ change the tag for each keyword.</p> <div class="section" id="syntax"> <h2>7.14.6.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> <p><code class="docutils literal"><span class="pre">highlight_full</span></code> has required parameter and optional parameter:</p> -<div class="highlight-none"><div class="highlight"><pre>highlight_full(column, normalizer_name, use_html_escape, +<div class="highlight-none"><div class="highlight"><pre><span></span>highlight_full(column, normalizer_name, use_html_escape, keyword1, open_tag1, close_tag1, ... [keywordN, open_tagN, close_tagN]) @@ -110,7 +110,7 @@ change the tag for each keyword.</p> <h2>7.14.6.3. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2> <p>Here are a schema definition and sample data to show usage.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Entries TABLE_NO_KEY +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Entries TABLE_NO_KEY # [[0, 1337566253.89858, 0.000355720520019531], true] column_create Entries body COLUMN_SCALAR ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -135,7 +135,7 @@ It specifies the tags <code class="docutils literal"><span class="pre"><span< keyword <code class="docutils literal"><span class="pre">groonga</span></code>, and the tags <code class="docutils literal"><span class="pre"><span</span> <span class="pre">class="keyword2"></span></code> and <code class="docutils literal"><span class="pre"></span></span></code> of the keyword <code class="docutils literal"><span class="pre">mysql</span></code>.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --output_columns 'highlight_full(body, "NormalizerAuto", true, "Groonga", "<span class=\\"keyword1\\">", "</span>", "mysql", "<span class=\\"keyword2\\">", "</span>")' --command_version 2 +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --output_columns 'highlight_full(body, "NormalizerAuto", true, "Groonga", "<span class=\\"keyword1\\">", "</span>", "mysql", "<span class=\\"keyword2\\">", "</span>")' --command_version 2 # [ # [ # 0, @@ -171,7 +171,7 @@ contained in the text with with <code class="docutils literal"><span class="pre" <code class="docutils literal"><span class="pre">&gt;</span></code>.</p> <p>You can specify string literal instead of column.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --output_columns 'highlight_full("Groonga is very fast fulltext search engine.", "NormalizerAuto", true, "Groonga", "<span class=\\"keyword1\\">", "</span>", "mysql", "<span class=\\"keyword2\\">", "</span>")' --command_version 2 --match_columns body --query "groonga" +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --output_columns 'highlight_full("Groonga is very fast fulltext search engine.", "NormalizerAuto", true, "Groonga", "<span class=\\"keyword1\\">", "</span>", "mysql", "<span class=\\"keyword2\\">", "</span>")' --command_version 2 --match_columns body --query "groonga" # [ # [ # 0, Modified: docs/reference/functions/highlight_html.html (+5 -5) =================================================================== --- docs/reference/functions/highlight_html.html 2016-03-05 15:09:34 +0900 (10b93ba) +++ docs/reference/functions/highlight_html.html 2016-03-17 12:56:59 +0900 (b47c60a) @@ -105,7 +105,7 @@ For example, a tagged text of <code class="docutils literal"><span class="pre">I <div class="section" id="syntax"> <h2>7.14.7.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> <p>This function has only one parameter:</p> -<div class="highlight-none"><div class="highlight"><pre>highlight_html(text) +<div class="highlight-none"><div class="highlight"><pre><span></span>highlight_html(text) </pre></div> </div> </div> @@ -113,7 +113,7 @@ For example, a tagged text of <code class="docutils literal"><span class="pre">I <h2>7.14.7.3. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2> <p>Here are a schema definition and sample data to show usage.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Entries TABLE_NO_KEY +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Entries TABLE_NO_KEY # [[0, 1337566253.89858, 0.000355720520019531], true] column_create Entries body COLUMN_SCALAR ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -137,7 +137,7 @@ extracted from <code class="docutils literal"><span class="pre">--query</span></ <p>The following example uses <code class="docutils literal"><span class="pre">--query</span> <span class="pre">"groonga</span> <span class="pre">mysql"</span></code>. In this case, <code class="docutils literal"><span class="pre">groonga</span></code> and <code class="docutils literal"><span class="pre">mysql</span></code> are used as keywords.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --output_columns --match_columns body --query 'groonga mysql' --output_columns 'highlight_html(body)' --command_version 2 +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --output_columns --match_columns body --query 'groonga mysql' --output_columns 'highlight_html(body)' --command_version 2 # [ # [ # 0, @@ -170,7 +170,7 @@ by <code class="docutils literal"><span class="pre">NormalizerAuto</span></code> contained in the text with <code class="docutils literal"><span class="pre"><span</span> <span class="pre">class="keyword"></span></code> and <code class="docutils literal"><span class="pre"></span></span></code>.</p> <p>You can specify string literal instead of column.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --output_columns 'highlight_html("Groonga is very fast fulltext search engine.")' --command_version 2 --match_columns body --query "groonga" +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --output_columns 'highlight_html("Groonga is very fast fulltext search engine.")' --command_version 2 --match_columns body --query "groonga" # [ # [ # 0, @@ -210,7 +210,7 @@ contained in the text with <code class="docutils literal"><span class="pre">< </div> <div class="section" id="optional-parameters"> <h3>7.14.7.4.2. Optional parameters<a class="headerlink" href="#optional-parameters" title="Permalink to this headline">¶</a></h3> -<p>There is no optional parameters.</p> +<p>There is no optional parameter.</p> </div> </div> <div class="section" id="return-value"> Modified: docs/reference/functions/html_untag.html (+4 -4) =================================================================== --- docs/reference/functions/html_untag.html 2016-03-05 15:09:34 +0900 (5ed4f7e) +++ docs/reference/functions/html_untag.html 2016-03-17 12:56:59 +0900 (0f716d0) @@ -95,7 +95,7 @@ <div class="section" id="syntax"> <h2>7.14.8.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> <p><code class="docutils literal"><span class="pre">html_untag</span></code> requires only one argument. It is <code class="docutils literal"><span class="pre">html</span></code>.</p> -<div class="highlight-none"><div class="highlight"><pre>html_untag(html) +<div class="highlight-none"><div class="highlight"><pre><span></span>html_untag(html) </pre></div> </div> </div> @@ -110,7 +110,7 @@ later.</p> <p>Here are a schema definition and sample data to show usage.</p> <p>Sample schema:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create WebClips TABLE_HASH_KEY ShortText +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create WebClips TABLE_HASH_KEY ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] column_create WebClips content COLUMN_SCALAR ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -118,7 +118,7 @@ column_create WebClips content COLUMN_SCALAR ShortText </div> <p>Sample data:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>load --table WebClips +<div class="highlight-none"><div class="highlight"><pre><span></span>load --table WebClips [ {"_key": "http://groonga.org", "content": "groonga is <span class='emphasize'>fast</span>"}, {"_key": "http://mroonga.org", "content": "mroonga is <span class=\"emphasize\">fast</span>"}, @@ -128,7 +128,7 @@ column_create WebClips content COLUMN_SCALAR ShortText </div> <p>Here is the simple usage of <code class="docutils literal"><span class="pre">html_untag</span></code> function which strips HTML tags from content of column.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select WebClips --output_columns "html_untag(content)" --command_version 2 +<div class="highlight-none"><div class="highlight"><pre><span></span>select WebClips --output_columns "html_untag(content)" --command_version 2 # [ # [ # 0, Modified: docs/reference/functions/in_values.html (+4 -4) =================================================================== --- docs/reference/functions/in_values.html 2016-03-05 15:09:34 +0900 (ab63000) +++ docs/reference/functions/in_values.html 2016-03-17 12:56:59 +0900 (28be882) @@ -96,7 +96,7 @@ <div class="section" id="syntax"> <h2>7.14.9.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> <p><code class="docutils literal"><span class="pre">in_values</span></code> requires two or more arguments - <code class="docutils literal"><span class="pre">target_value</span></code> and multiple <code class="docutils literal"><span class="pre">value</span></code>.</p> -<div class="highlight-none"><div class="highlight"><pre>in_values(target_value, value1, ..., valueN) +<div class="highlight-none"><div class="highlight"><pre><span></span>in_values(target_value, value1, ..., valueN) </pre></div> </div> </div> @@ -105,7 +105,7 @@ <p>Here is a schema definition and sample data.</p> <p>Sample schema:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Tags TABLE_PAT_KEY ShortText +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Tags TABLE_PAT_KEY ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] table_create Memos TABLE_HASH_KEY ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -117,7 +117,7 @@ column_create Tags memos_tag COLUMN_INDEX Memos tag </div> <p>Sample data:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>load --table Memos +<div class="highlight-none"><div class="highlight"><pre><span></span>load --table Memos [ {"_key": "Groonga is fast", "tag": "groonga"}, {"_key": "Mroonga is fast", "tag": "mroonga"}, @@ -130,7 +130,7 @@ column_create Tags memos_tag COLUMN_INDEX Memos tag </div> <p>Here is the simple usage of <code class="docutils literal"><span class="pre">in_values</span></code> function which selects the records - the value of <code class="docutils literal"><span class="pre">tag</span></code> column is "groonga" or "mroonga" or "droonga".</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Memos --output_columns _key,tag --filter 'in_values(tag, "groonga", "mroonga", "droonga")' --sortby _id +<div class="highlight-none"><div class="highlight"><pre><span></span>select Memos --output_columns _key,tag --filter 'in_values(tag, "groonga", "mroonga", "droonga")' --sortby _id # [ # [ # 0, Modified: docs/reference/functions/now.html (+2 -2) =================================================================== --- docs/reference/functions/now.html 2016-03-05 15:09:34 +0900 (93682c7) +++ docs/reference/functions/now.html 2016-03-17 12:56:59 +0900 (23d072c) @@ -92,7 +92,7 @@ </div> <div class="section" id="id2"> <h2>7.14.10.2. 書式<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h2> -<div class="highlight-none"><div class="highlight"><pre>now() +<div class="highlight-none"><div class="highlight"><pre><span></span>now() </pre></div> </div> </div> @@ -107,7 +107,7 @@ </div> <div class="section" id="id5"> <h2>7.14.10.5. 例<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h2> -<div class="highlight-none"><div class="highlight"><pre>now() +<div class="highlight-none"><div class="highlight"><pre><span></span>now() 1256791194.55541 </pre></div> </div> Modified: docs/reference/functions/prefix_rk_search.html (+9 -9) =================================================================== --- docs/reference/functions/prefix_rk_search.html 2016-03-05 15:09:34 +0900 (82654a5) +++ docs/reference/functions/prefix_rk_search.html 2016-03-17 12:56:59 +0900 (143a045) @@ -98,7 +98,7 @@ selector only procedure.</p> <h2>7.14.11.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> <p><code class="docutils literal"><span class="pre">prefix_rk_search()</span></code> requires two arguments. They are <code class="docutils literal"><span class="pre">column</span></code> and <code class="docutils literal"><span class="pre">query</span></code>:</p> -<div class="highlight-none"><div class="highlight"><pre>prefix_rk_search(column, query) +<div class="highlight-none"><div class="highlight"><pre><span></span>prefix_rk_search(column, query) </pre></div> </div> <p><code class="docutils literal"><span class="pre">column</span></code> must be <code class="docutils literal"><span class="pre">_key</span></code> for now.</p> @@ -108,7 +108,7 @@ selector only procedure.</p> <h2>7.14.11.3. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2> <p>Here are a schema definition and sample data to show usage:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Readings TABLE_PAT_KEY ShortText --normalizer NormalizerAuto +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Readings TABLE_PAT_KEY ShortText --normalizer NormalizerAuto # [[0, 1337566253.89858, 0.000355720520019531], true] load --table Readings [ @@ -122,7 +122,7 @@ load --table Readings <p>Here is the simple usage of <code class="docutils literal"><span class="pre">prefix_rk_search()</span></code> function which selects <code class="docutils literal"><span class="pre">ニホン</span></code> and <code class="docutils literal"><span class="pre">ニッポン</span></code> by <code class="docutils literal"><span class="pre">ni</span></code>:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Readings --filter 'prefix_rk_search(_key, "ni")' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Readings --filter 'prefix_rk_search(_key, "ni")' # [ # [ # 0, @@ -164,7 +164,7 @@ records have zero or more readings. They are stored into <code class="docutils l table. Don't forget define an index column for <code class="docutils literal"><span class="pre">Items.readings</span></code> in <code class="docutils literal"><span class="pre">Readings</span></code> table. The index column is needed for <a class="reference internal" href="sub_filter.html"><em>sub_filter</em></a>:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Items TABLE_HASH_KEY ShortText +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Items TABLE_HASH_KEY ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] column_create Items readings COLUMN_VECTOR Readings # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -183,7 +183,7 @@ load --table Items prefix RK search with <code class="docutils literal"><span class="pre">niho</span></code> selects <code class="docutils literal"><span class="pre">ニホン</span></code> reading and <code class="docutils literal"><span class="pre">ニホン</span></code> reading is one of readings of <code class="docutils literal"><span class="pre">日本</span></code> record:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Items \ +<div class="highlight-none"><div class="highlight"><pre><span></span>select Items \ --filter 'sub_filter(readings, "prefix_rk_search(_key, \\"niho\\")")' # [ # [ @@ -227,7 +227,7 @@ reading is one of readings of <code class="docutils literal"><span class="pre"> support no reading completion targets.</p> <p>Add one no reading completion target:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>load --table Items +<div class="highlight-none"><div class="highlight"><pre><span></span>load --table Items [ {"_key": "nihon", "readings": []} ] @@ -237,7 +237,7 @@ support no reading completion targets.</p> <p>Combine <a class="reference internal" href="../grn_expr/script_syntax.html#script-syntax-prefix-search-operator"><span>Prefix search operator</span></a> to support no reading completion targets:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Items \ +<div class="highlight-none"><div class="highlight"><pre><span></span>select Items \ --filter 'sub_filter(readings, "prefix_rk_search(_key, \\"niho\\")") || \ _key @^ "niho"' # [ @@ -286,7 +286,7 @@ support no reading completion targets:</p> <p>Normally, you want to use case insensitive search for completion. Use <code class="docutils literal"><span class="pre">--normalizer</span> <span class="pre">NormalizerAuto</span></code> and <code class="docutils literal"><span class="pre">label</span></code> column for the case:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create LooseItems TABLE_HASH_KEY ShortText --normalizer NormalizerAuto +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create LooseItems TABLE_HASH_KEY ShortText --normalizer NormalizerAuto # [[0, 1337566253.89858, 0.000355720520019531], true] column_create LooseItems label COLUMN_SCALAR ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -306,7 +306,7 @@ load --table LooseItems </div> <p>Use <code class="docutils literal"><span class="pre">LooseItems.label</span></code> for display:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select LooseItems \ +<div class="highlight-none"><div class="highlight"><pre><span></span>select LooseItems \ --filter 'sub_filter(readings, "prefix_rk_search(_key, \\"nIhO\\")") || \ _key @^ "nIhO"' \ --output_columns '_key,label' Modified: docs/reference/functions/query.html (+9 -9) =================================================================== --- docs/reference/functions/query.html 2016-03-05 15:09:34 +0900 (c6527a7) +++ docs/reference/functions/query.html 2016-03-17 12:56:59 +0900 (170f87f) @@ -101,7 +101,7 @@ by combination of multiple <code class="docutils literal"><span class="pre">quer <h2>7.14.12.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> <p><code class="docutils literal"><span class="pre">query</span></code> requires two arguments - <code class="docutils literal"><span class="pre">match_columns</span></code> and <code class="docutils literal"><span class="pre">query_string</span></code>.</p> <p>The parameter <code class="docutils literal"><span class="pre">query_expander</span></code> or <code class="docutils literal"><span class="pre">substitution_table</span></code> is optional.</p> -<div class="highlight-none"><div class="highlight"><pre>query(match_columns, query_string) +<div class="highlight-none"><div class="highlight"><pre><span></span>query(match_columns, query_string) query(match_columns, query_string, query_expander) query(match_columns, query_string, substitution_table) </pre></div> @@ -112,7 +112,7 @@ query(match_columns, query_string, substitution_table) <p>Here are a schema definition and sample data to show usage.</p> <p>Sample schema:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Documents TABLE_NO_KEY +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Documents TABLE_NO_KEY # [[0, 1337566253.89858, 0.000355720520019531], true] column_create Documents content COLUMN_SCALAR Text # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -138,7 +138,7 @@ column_create Lexicon users_memo COLUMN_INDEX|WITH_POSITION Users memo </div> <p>Sample data:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>load --table Users +<div class="highlight-none"><div class="highlight"><pre><span></span>load --table Users [ {"name": "Alice", "memo": "groonga user"}, {"name": "Alisa", "memo": "mroonga user"}, @@ -153,7 +153,7 @@ column_create Lexicon users_memo COLUMN_INDEX|WITH_POSITION Users memo search by keyword 'alice' without using <code class="docutils literal"><span class="pre">--match_columns</span></code> and <code class="docutils literal"><span class="pre">--query</span></code> arguments in <code class="docutils literal"><span class="pre">--filter</span></code>.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Users --output_columns name,_score --filter 'query("name * 10", "alice")' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Users --output_columns name,_score --filter 'query("name * 10", "alice")' # [ # [ # 0, @@ -188,7 +188,7 @@ search by keyword 'alice' without using <code class="docutils literal"><span cla '10'.</p> <p>Here are the contrasting examples with/without <code class="docutils literal"><span class="pre">query</span></code>.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Users --output_columns name,memo,_score --match_columns "memo * 10" --query "memo:@groonga OR memo:@mroonga OR memo:@user" --sortby -_score +<div class="highlight-none"><div class="highlight"><pre><span></span>select Users --output_columns name,memo,_score --match_columns "memo * 10" --query "memo:@groonga OR memo:@mroonga OR memo:@user" --sortby -_score # [ # [ # 0, @@ -248,7 +248,7 @@ search by keyword 'alice' without using <code class="docutils literal"><span cla given same weight value. You can't pass different weight value to each keyword in this way.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Users --output_columns name,memo,_score --filter 'query("memo * 10", "groonga") || query("memo * 20", "mroonga") || query("memo * 1", "user")' --sortby -_score +<div class="highlight-none"><div class="highlight"><pre><span></span>select Users --output_columns name,memo,_score --filter 'query("memo * 10", "groonga") || query("memo * 20", "mroonga") || query("memo * 1", "user")' --sortby -_score # [ # [ # 0, @@ -311,8 +311,8 @@ keywords on your purpose.</p> </div> <div class="section" id="parameters"> <h2>7.14.12.4. Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></h2> -<div class="section" id="required-parameter"> -<h3>7.14.12.4.1. Required parameter<a class="headerlink" href="#required-parameter" title="Permalink to this headline">¶</a></h3> +<div class="section" id="required-parameters"> +<h3>7.14.12.4.1. Required parameters<a class="headerlink" href="#required-parameters" title="Permalink to this headline">¶</a></h3> <p>There are two required parameter, <code class="docutils literal"><span class="pre">match_columns</span></code> and <code class="docutils literal"><span class="pre">query_string</span></code>.</p> <div class="section" id="match-columns"> <h4>7.14.12.4.1.1. <code class="docutils literal"><span class="pre">match_columns</span></code><a class="headerlink" href="#match-columns" title="Permalink to this headline">¶</a></h4> @@ -379,7 +379,7 @@ records are matched, it returns <code class="docutils literal"><span class="pre" <li><a class="reference internal" href="#syntax">7.14.12.2. Syntax</a></li> <li><a class="reference internal" href="#usage">7.14.12.3. Usage</a></li> <li><a class="reference internal" href="#parameters">7.14.12.4. Parameters</a><ul> -<li><a class="reference internal" href="#required-parameter">7.14.12.4.1. Required parameter</a><ul> +<li><a class="reference internal" href="#required-parameters">7.14.12.4.1. Required parameters</a><ul> <li><a class="reference internal" href="#match-columns">7.14.12.4.1.1. <code class="docutils literal"><span class="pre">match_columns</span></code></a></li> <li><a class="reference internal" href="#query-string">7.14.12.4.1.2. <code class="docutils literal"><span class="pre">query_string</span></code></a></li> </ul> Modified: docs/reference/functions/rand.html (+2 -2) =================================================================== --- docs/reference/functions/rand.html 2016-03-05 15:09:34 +0900 (2302a01) +++ docs/reference/functions/rand.html 2016-03-17 12:56:59 +0900 (a61c17c) @@ -92,7 +92,7 @@ </div> <div class="section" id="id2"> <h2>7.14.13.2. 書式<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h2> -<div class="highlight-none"><div class="highlight"><pre>rand([max]) +<div class="highlight-none"><div class="highlight"><pre><span></span>rand([max]) </pre></div> </div> </div> @@ -113,7 +113,7 @@ </div> <div class="section" id="id6"> <h2>7.14.13.6. 例<a class="headerlink" href="#id6" title="Permalink to this headline">¶</a></h2> -<div class="highlight-none"><div class="highlight"><pre>rand(10) +<div class="highlight-none"><div class="highlight"><pre><span></span>rand(10) 3 </pre></div> </div> Modified: docs/reference/functions/snippet_html.html (+5 -5) =================================================================== --- docs/reference/functions/snippet_html.html 2016-03-05 15:09:34 +0900 (f3ede6a) +++ docs/reference/functions/snippet_html.html 2016-03-17 12:56:59 +0900 (7fc3572) @@ -103,7 +103,7 @@ escapsed as <code class="docutils literal"><span class="pre">&lt;</span></co <div class="section" id="syntax"> <h2>7.14.14.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> <p><code class="docutils literal"><span class="pre">snippet_html</span></code> has only one parameter:</p> -<div class="highlight-none"><div class="highlight"><pre>snippet_html(column) +<div class="highlight-none"><div class="highlight"><pre><span></span>snippet_html(column) </pre></div> </div> <p><code class="docutils literal"><span class="pre">snippet_html</span></code> has many parameters internally but they can't be @@ -113,7 +113,7 @@ specified for now. You will be able to custom those parameters soon.</p> <h2>7.14.14.3. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2> <p>Here are a schema definition and sample data to show usage.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Documents TABLE_NO_KEY +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Documents TABLE_NO_KEY # [[0, 1337566253.89858, 0.000355720520019531], true] column_create Documents content COLUMN_SCALAR Text # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -140,7 +140,7 @@ extracted from <code class="docutils literal"><span class="pre">--query</span></ <p>The following example uses <code class="docutils literal"><span class="pre">--query</span> <span class="pre">"fast</span> <span class="pre">performance"</span></code>. In this case, <code class="docutils literal"><span class="pre">fast</span></code> and <code class="docutils literal"><span class="pre">performance</span></code> are used as keywords.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Documents --output_columns "snippet_html(content)" --command_version 2 --match_columns content --query "fast performance" +<div class="highlight-none"><div class="highlight"><pre><span></span>select Documents --output_columns "snippet_html(content)" --command_version 2 --match_columns content --query "fast performance" # [ # [ # 0, @@ -182,7 +182,7 @@ and <code class="docutils literal"><span class="pre"></span></span></code> aren't customizable.</p> <p>You can specify string literal instead of column.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Documents --output_columns 'snippet_html("Groonga is very fast fulltext search engine.")' --command_version 2 --match_columns content --query "fast performance" +<div class="highlight-none"><div class="highlight"><pre><span></span>select Documents --output_columns 'snippet_html("Groonga is very fast fulltext search engine.")' --command_version 2 --match_columns content --query "fast performance" # [ # [ # 0, @@ -216,7 +216,7 @@ aren't customizable.</p> <p><code class="docutils literal"><span class="pre">snippet_html</span></code> returns an array of string or <code class="docutils literal"><span class="pre">null</span></code>. If <code class="docutils literal"><span class="pre">snippet_html</span></code> can't find any snippets, it returns <code class="docutils literal"><span class="pre">null</span></code>.</p> <p>An element of array is a snippet:</p> -<div class="highlight-none"><div class="highlight"><pre>[SNIPPET1, SNIPPET2, SNIPPET3] +<div class="highlight-none"><div class="highlight"><pre><span></span>[SNIPPET1, SNIPPET2, SNIPPET3] </pre></div> </div> <p>A snippet includes one or more keywords. The max byte size of a Modified: docs/reference/functions/sub_filter.html (+5 -5) =================================================================== --- docs/reference/functions/sub_filter.html 2016-03-05 15:09:34 +0900 (8ed20a8) +++ docs/reference/functions/sub_filter.html 2016-03-17 12:56:59 +0900 (05643c3) @@ -96,7 +96,7 @@ <h2>7.14.15.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> <p><code class="docutils literal"><span class="pre">sub_filter</span></code> requires two arguments. They are <code class="docutils literal"><span class="pre">scope</span></code> and <code class="docutils literal"><span class="pre">filter_string</span></code>.</p> -<div class="highlight-none"><div class="highlight"><pre>sub_filter(scope, filter_string) +<div class="highlight-none"><div class="highlight"><pre><span></span>sub_filter(scope, filter_string) </pre></div> </div> </div> @@ -105,7 +105,7 @@ <p>Here are a schema definition and sample data to show usage.</p> <p>Sample schema:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Comment TABLE_PAT_KEY UInt32 +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Comment TABLE_PAT_KEY UInt32 # [[0, 1337566253.89858, 0.000355720520019531], true] column_create Comment name COLUMN_SCALAR ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -133,7 +133,7 @@ column_create Lexicon blog_content COLUMN_INDEX|WITH_POSITION Blog content </div> <p>Sample data:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>load --table Comment +<div class="highlight-none"><div class="highlight"><pre><span></span>load --table Comment [ {"_key": 1, "name": "A", "content": "groonga"}, {"_key": 2, "name": "B", "content": "groonga"}, @@ -153,7 +153,7 @@ load --table Blog <p>Here is the simple usage of <code class="docutils literal"><span class="pre">sub_filter</span></code> function which extracts the blog entry commented by user 'A'.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Blog --output_columns _key --filter "comments.name @ \"A\" && comments.content @ \"groonga\"" +<div class="highlight-none"><div class="highlight"><pre><span></span>select Blog --output_columns _key --filter "comments.name @ \"A\" && comments.content @ \"groonga\"" # [ # [ # 0, @@ -190,7 +190,7 @@ This is not what you want because user "A" does not mention "groo <li>There is at least one record that mentioned about "groonga".</li> </ul> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Blog --output_columns _key --filter 'sub_filter(comments, "name @ \\"A\\" && content @ \\"groonga\\"")' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Blog --output_columns _key --filter 'sub_filter(comments, "name @ \\"A\\" && content @ \\"groonga\\"")' # [ # [ # 0, Modified: docs/reference/functions/vector_size.html (+5 -5) =================================================================== --- docs/reference/functions/vector_size.html 2016-03-05 15:09:34 +0900 (c8157f5) +++ docs/reference/functions/vector_size.html 2016-03-17 12:56:59 +0900 (83930bb) @@ -93,7 +93,7 @@ </div> <p><code class="docutils literal"><span class="pre">vector_size</span></code> returns the value of vector column size.</p> <p>To enable this function, register <code class="docutils literal"><span class="pre">functions/vector</span></code> plugin by following the command:</p> -<div class="highlight-none"><div class="highlight"><pre>plugin_register functions/vector +<div class="highlight-none"><div class="highlight"><pre><span></span>plugin_register functions/vector </pre></div> </div> <p>Then, use <code class="docutils literal"><span class="pre">vector_size</span></code> function with <code class="docutils literal"><span class="pre">--command_version</span> <span class="pre">2</span></code> option. Note that you must specify <code class="docutils literal"><span class="pre">--command_version</span> <span class="pre">2</span></code> to use <code class="docutils literal"><span class="pre">vector_size</span></code> function."</p> @@ -101,7 +101,7 @@ <div class="section" id="syntax"> <h2>7.14.16.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> <p><code class="docutils literal"><span class="pre">vector_size</span></code> requires one argument - <code class="docutils literal"><span class="pre">target</span></code>.</p> -<div class="highlight-none"><div class="highlight"><pre>vector_size(target) +<div class="highlight-none"><div class="highlight"><pre><span></span>vector_size(target) </pre></div> </div> </div> @@ -110,7 +110,7 @@ <p>Here is a schema definition and sample data.</p> <p>Sample schema:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Memos TABLE_HASH_KEY ShortText +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Memos TABLE_HASH_KEY ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] column_create Memos tags COLUMN_VECTOR ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -118,7 +118,7 @@ column_create Memos tags COLUMN_VECTOR ShortText </div> <p>Sample data:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>load --table Memos +<div class="highlight-none"><div class="highlight"><pre><span></span>load --table Memos [ {"_key": "Groonga", "tags": ["Groonga"]}, {"_key": "Rroonga", "tags": ["Groonga", "Ruby"]}, @@ -129,7 +129,7 @@ column_create Memos tags COLUMN_VECTOR ShortText </div> <p>Here is the simple usage of <code class="docutils literal"><span class="pre">vector_size</span></code> function which returns tags and size - the value of <code class="docutils literal"><span class="pre">tags</span></code> column and size of it.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Memos --output_columns 'tags, vector_size(tags)' --command_version 2 +<div class="highlight-none"><div class="highlight"><pre><span></span>select Memos --output_columns 'tags, vector_size(tags)' --command_version 2 # [ # [ # 0, Modified: docs/reference/grn_expr/query_syntax.html (+18 -18) =================================================================== --- docs/reference/grn_expr/query_syntax.html 2016-03-05 15:09:34 +0900 (219da16) +++ docs/reference/grn_expr/query_syntax.html 2016-03-17 12:56:59 +0900 (4bc001b) @@ -105,7 +105,7 @@ options.</p> <h2>7.12.1.1. Sample data<a class="headerlink" href="#sample-data" title="Permalink to this headline">¶</a></h2> <p>Here are a schema definition and sample data to show usage.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Entries TABLE_PAT_KEY ShortText +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Entries TABLE_PAT_KEY ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] column_create Entries content COLUMN_SCALAR Text # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -205,7 +205,7 @@ specifies a keyword that contains one or more spaces, you can use <code class="docutils literal"><span class="pre">phrase</span> <span class="pre">search</span> <span class="pre">condition</span></code> that is described below.</p> <p>Here is a simple example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --match_columns content --query fast +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --match_columns content --query fast # [ # [ # 0, @@ -273,7 +273,7 @@ adjacent. Thus, <code class="docutils literal"><span class="pre">Put</span> <spa aren't matched.</p> <p>Here is a simple example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --match_columns content --query '"I started"' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --match_columns content --query '"I started"' # [ # [ # 0, @@ -348,7 +348,7 @@ the following features:</p> <a class="reference internal" href="../commands/select.html"><em>select</em></a> about them.</p> <p>Here is a simple example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --query content:@fast +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --query content:@fast # [ # [ # 0, @@ -414,7 +414,7 @@ advanced match columns but <code class="docutils literal"><span class="pre">phra <span class="pre">condition</span> <span class="pre">(with</span> <span class="pre">explicit</span> <span class="pre">match</span> <span class="pre">column)</span></code> about advanced match columns.</p> <p>Here is a simple example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --query 'content:@"I started"' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --query 'content:@"I started"' # [ # [ # 0, @@ -477,7 +477,7 @@ time for large records.</p> <span class="pre">search</span> <span class="pre">condition</span></code> and <code class="docutils literal"><span class="pre">phrase</span> <span class="pre">search</span> <span class="pre">condition</span></code>.</p> <p>Here is a simple example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --query '_key:^Goo' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --query '_key:^Goo' # [ # [ # 0, @@ -558,7 +558,7 @@ large records.</p> <p>Here is a simple example. It uses fast suffix search for hiragana in Japanese that is one of non-ASCII characters.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Titles TABLE_NO_KEY +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Titles TABLE_NO_KEY # [[0, 1337566253.89858, 0.000355720520019531], true] column_create Titles content COLUMN_SCALAR ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -621,7 +621,7 @@ with the expression.</p> <span class="pre">search</span> <span class="pre">condition</span></code> and <code class="docutils literal"><span class="pre">phrase</span> <span class="pre">search</span> <span class="pre">condition</span></code>.</p> <p>Here is a simple example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --query _key:Groonga +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --query _key:Groonga # [ # [ # 0, @@ -673,7 +673,7 @@ equal to <code class="docutils literal"><span class="pre">Groonga</span></code>. <span class="pre">search</span> <span class="pre">condition</span></code> and <code class="docutils literal"><span class="pre">phrase</span> <span class="pre">search</span> <span class="pre">condition</span></code>.</p> <p>Here is a simple example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --query _key:!Groonga +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --query _key:!Groonga # [ # [ # 0, @@ -747,7 +747,7 @@ compared as bit sequence.</p> <span class="pre">search</span> <span class="pre">condition</span></code> and <code class="docutils literal"><span class="pre">phrase</span> <span class="pre">search</span> <span class="pre">condition</span></code>.</p> <p>Here is a simple example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --query n_likes:<10 +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --query n_likes:<10 # [ # [ # 0, @@ -815,7 +815,7 @@ compared as bit sequence.</p> <span class="pre">search</span> <span class="pre">condition</span></code> and <code class="docutils literal"><span class="pre">phrase</span> <span class="pre">search</span> <span class="pre">condition</span></code>.</p> <p>Here is a simple example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --query n_likes:>10 +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --query n_likes:>10 # [ # [ # 0, @@ -872,7 +872,7 @@ compared as bit sequence.</p> <span class="pre">search</span> <span class="pre">condition</span></code> and <code class="docutils literal"><span class="pre">phrase</span> <span class="pre">search</span> <span class="pre">condition</span></code>.</p> <p>Here is a simple example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --query n_likes:<=10 +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --query n_likes:<=10 # [ # [ # 0, @@ -947,7 +947,7 @@ compared as bit sequence.</p> <span class="pre">search</span> <span class="pre">condition</span></code> and <code class="docutils literal"><span class="pre">phrase</span> <span class="pre">search</span> <span class="pre">condition</span></code>.</p> <p>Here is a simple example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --query n_likes:>=10 +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --query n_likes:>=10 # [ # [ # 0, @@ -1009,7 +1009,7 @@ greater than or equal to <code class="docutils literal"><span class="pre">10</sp <p>The following example uses <code class="docutils literal"><span class="pre">.roonga</span></code> as pattern. It matches <code class="docutils literal"><span class="pre">Groonga</span></code>, <code class="docutils literal"><span class="pre">Mroonga</span></code> and so on.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --query content:~.roonga +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --query content:~.roonga # [ # [ # 0, @@ -1073,7 +1073,7 @@ assignment expressions.</p> <p>If at least one of <code class="docutils literal"><span class="pre">a</span></code> and <code class="docutils literal"><span class="pre">b</span></code> are matched, <code class="docutils literal"><span class="pre">a</span> <span class="pre">OR</span> <span class="pre">b</span></code> is matched.</p> <p>Here is a simple example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --query 'n_likes:>10 OR content:@senna' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --query 'n_likes:>10 OR content:@senna' # [ # [ # 0, @@ -1134,7 +1134,7 @@ assignment expressions.</p> is just ignored.</p> <p>Here is a simple example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --query 'n_likes:>=10 + content:@groonga' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --query 'n_likes:>=10 + content:@groonga' # [ # [ # 0, @@ -1189,7 +1189,7 @@ assignment expressions.</p> syntax error.</p> <p>Here is a simple example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --query 'n_likes:>=10 - content:@groonga' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --query 'n_likes:>=10 - content:@groonga' # [ # [ # 0, @@ -1243,7 +1243,7 @@ are matched or <code class="docutils literal"><span class="pre">c</span></code> one of <code class="docutils literal"><span class="pre">b</span></code> and <code class="docutils literal"><span class="pre">c</span></code> are matched.</p> <p>Here is a simple example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --query 'n_likes:<5 content:@senna OR content:@fast' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --query 'n_likes:<5 content:@senna OR content:@fast' # [ # [ # 0, Modified: docs/reference/grn_expr/script_syntax.html (+50 -50) =================================================================== --- docs/reference/grn_expr/script_syntax.html 2016-03-05 15:09:34 +0900 (7bd47fd) +++ docs/reference/grn_expr/script_syntax.html 2016-03-17 12:56:59 +0900 (3b26522) @@ -106,7 +106,7 @@ that retrieves records that should not be shown to the user.</p> <p>Think about the following case.</p> <p>A Groonga application constructs a Groonga request by the following program:</p> -<div class="highlight-none"><div class="highlight"><pre>filter = "column @ \"#{user_input}\"" +<div class="highlight-none"><div class="highlight"><pre><span></span>filter = "column @ \"#{user_input}\"" select_options = { # ... :filter => filter, @@ -116,12 +116,12 @@ groonga_client.select(select_options) </div> <p><code class="docutils literal"><span class="pre">user_input</span></code> is an input from user. If the input is <code class="docutils literal"><span class="pre">query</span></code>, here is the constructed <a class="reference internal" href="../commands/select.html#select-filter"><span>filter</span></a> parameter:</p> -<div class="highlight-none"><div class="highlight"><pre>column @ "query" +<div class="highlight-none"><div class="highlight"><pre><span></span>column @ "query" </pre></div> </div> <p>If the input is <code class="docutils literal"><span class="pre">x"</span> <span class="pre">||</span> <span class="pre">true</span> <span class="pre">||</span> <span class="pre">"</span></code>, here is the constructed <a class="reference internal" href="../commands/select.html#select-filter"><span>filter</span></a> parameter:</p> -<div class="highlight-none"><div class="highlight"><pre>column @ "x" || true || "" +<div class="highlight-none"><div class="highlight"><pre><span></span>column @ "x" || true || "" </pre></div> </div> <p>This query matches to all records. The user will get all records from @@ -149,7 +149,7 @@ converted to <code class="docutils literal"><span class="pre">"double</span <h2>7.12.2.2. Sample data<a class="headerlink" href="#sample-data" title="Permalink to this headline">¶</a></h2> <p>Here are a schema definition and sample data to show usage.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Entries TABLE_PAT_KEY ShortText +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Entries TABLE_PAT_KEY ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] column_create Entries content COLUMN_SCALAR Text # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -290,7 +290,7 @@ control syntax.</p> <p><code class="docutils literal"><span class="pre">A</span> <span class="pre">?</span> <span class="pre">B</span> <span class="pre">:</span> <span class="pre">C</span></code> returns <code class="docutils literal"><span class="pre">B</span></code> if <code class="docutils literal"><span class="pre">A</span></code> is true, <code class="docutils literal"><span class="pre">C</span></code> otherwise.</p> <p>Here is a simple example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --filter 'n_likes == (_id == 1 ? 5 : 3)' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --filter 'n_likes == (_id == 1 ? 5 : 3)' # [ # [ # 0, @@ -356,7 +356,7 @@ or <code class="docutils literal"><span class="pre">c</span></code> is matched. <code class="docutils literal"><span class="pre">b</span></code> and <code class="docutils literal"><span class="pre">c</span></code> are matched.</p> <p>Here is a simple example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --filter 'n_likes < 5 && content @ "senna" || content @ "fast"' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --filter 'n_likes < 5 && content @ "senna" || content @ "fast"' # [ # [ # 0, @@ -463,7 +463,7 @@ matched.</p> <p>See <a class="reference internal" href="../function.html"><em>Function</em></a> for available functin list.</p> <p>Here is a simple example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --filter 'edit_distance(_key, "Groonga") <= 1' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --filter 'edit_distance(_key, "Groonga") <= 1' # [ # [ # 0, @@ -529,7 +529,7 @@ treated as similar.</p> <p>The operator adds <code class="docutils literal"><span class="pre">number1</span></code> and <code class="docutils literal"><span class="pre">number2</span></code> and returns the result.</p> <p>Here is a simple example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --filter 'n_likes == 10 + 5' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --filter 'n_likes == 10 + 5' # [ # [ # 0, @@ -579,7 +579,7 @@ to <code class="docutils literal"><span class="pre">15</span></code> (= <code cl <p>The operator subtracts <code class="docutils literal"><span class="pre">number2</span></code> from <code class="docutils literal"><span class="pre">number1</span></code> and returns the result.</p> <p>Here is a simple example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --filter 'n_likes == 20 - 5' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --filter 'n_likes == 20 - 5' # [ # [ # 0, @@ -629,7 +629,7 @@ to <code class="docutils literal"><span class="pre">15</span></code> (= <code cl <p>The operator multiplies <code class="docutils literal"><span class="pre">number1</span></code> and <code class="docutils literal"><span class="pre">number2</span></code> and returns the result.</p> <p>Here is a simple example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --filter 'n_likes == 3 * 5' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --filter 'n_likes == 3 * 5' # [ # [ # 0, @@ -680,7 +680,7 @@ to <code class="docutils literal"><span class="pre">15</span></code> (= <code cl quotient of result. <code class="docutils literal"><span class="pre">%</span></code> returns the remainder of result.</p> <p>Here is simple examples.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --filter 'n_likes == 26 / 7' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --filter 'n_likes == 26 / 7' # [ # [ # 0, @@ -730,7 +730,7 @@ quotient of result. <code class="docutils literal"><span class="pre">%</span></c <p>The expression matches records that <code class="docutils literal"><span class="pre">n_likes</span></code> column value is equal to <code class="docutils literal"><span class="pre">3</span></code> (= <code class="docutils literal"><span class="pre">26</span> <span class="pre">/</span> <span class="pre">7</span></code>).</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --filter 'n_likes == 26 % 7' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --filter 'n_likes == 26 % 7' # [ # [ # 0, @@ -784,7 +784,7 @@ to <code class="docutils literal"><span class="pre">5</span></code> (= <code cla <p>The operator inverts boolean value of <code class="docutils literal"><span class="pre">condition</span></code>.</p> <p>Here is a simple example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --filter '!(n_likes == 5)' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --filter '!(n_likes == 5)' # [ # [ # 0, @@ -853,7 +853,7 @@ equal to <code class="docutils literal"><span class="pre">5</span></code>.</p> <code class="docutils literal"><span class="pre">condition2</span></code> are true, false otherwise.</p> <p>Here is a simple example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --filter 'content @ "fast" && n_likes >= 10' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --filter 'content @ "fast" && n_likes >= 10' # [ # [ # 0, @@ -911,7 +911,7 @@ word <code class="docutils literal"><span class="pre">fast</span></code> and <co true, false otherwise.</p> <p>Here is a simple example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --filter 'n_likes == 5 || n_likes == 10' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --filter 'n_likes == 5 || n_likes == 10' # [ # [ # 0, @@ -968,7 +968,7 @@ to <code class="docutils literal"><span class="pre">5</span></code> or <code cla is false, false otherwise. It returns difference set.</p> <p>Here is a simple example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --filter 'content @ "fast" &! content @ "mroonga"' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --filter 'content @ "fast" &! content @ "mroonga"' # [ # [ # 0, @@ -1022,7 +1022,7 @@ word <code class="docutils literal"><span class="pre">fast</span></code> but doe <p>The operator returns bitwise NOT of <code class="docutils literal"><span class="pre">number</span></code>.</p> <p>Here is a simple example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --filter '~n_likes == -6' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --filter '~n_likes == -6' # [ # [ # 0, @@ -1072,7 +1072,7 @@ to <code class="docutils literal"><span class="pre">5</span></code> because bitw <p>The operator returns bitwise AND between <code class="docutils literal"><span class="pre">number1</span></code> and <code class="docutils literal"><span class="pre">number2</span></code>.</p> <p>Here is a simple example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --filter '(n_likes & 1) == 1' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --filter '(n_likes & 1) == 1' # [ # [ # 0, @@ -1143,7 +1143,7 @@ to <code class="docutils literal"><span class="pre">1</span></code> and bitwise <p>The operator returns bitwise OR between <code class="docutils literal"><span class="pre">number1</span></code> and <code class="docutils literal"><span class="pre">number2</span></code>.</p> <p>Here is a simple example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --filter 'n_likes == (1 | 4)' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --filter 'n_likes == (1 | 4)' # [ # [ # 0, @@ -1193,7 +1193,7 @@ to <code class="docutils literal"><span class="pre">5</span></code> (= <code cla <p>The operator returns bitwise XOR between <code class="docutils literal"><span class="pre">number1</span></code> and <code class="docutils literal"><span class="pre">number2</span></code>.</p> <p>Here is a simple example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --filter 'n_likes == (10 ^ 15)' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --filter 'n_likes == (10 ^ 15)' # [ # [ # 0, @@ -1247,7 +1247,7 @@ to <code class="docutils literal"><span class="pre">5</span></code> (= <code cla <code class="docutils literal"><span class="pre">number2</span></code>.</p> <p>Here is a simple example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --filter 'n_likes == (5 << 1)' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --filter 'n_likes == (5 << 1)' # [ # [ # 0, @@ -1298,7 +1298,7 @@ to <code class="docutils literal"><span class="pre">10</span></code> (= <code cl of the result is the same as <code class="docutils literal"><span class="pre">number1</span></code>.</p> <p>Here is a simple example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --filter 'n_likes == -(-10 >> 1)' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --filter 'n_likes == -(-10 >> 1)' # [ # [ # 0, @@ -1349,7 +1349,7 @@ to <code class="docutils literal"><span class="pre">5</span></code> (= <code cla leftmost <code class="docutils literal"><span class="pre">number2</span></code> bits are filled by <code class="docutils literal"><span class="pre">0</span></code>.</p> <p>Here is a simple example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --filter 'n_likes == (2147483648 - (-10 >>> 1))' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --filter 'n_likes == (2147483648 - (-10 >>> 1))' # [ # [ # 0, @@ -1404,7 +1404,7 @@ to <code class="docutils literal"><span class="pre">5</span></code> (= <code cla otherwise.</p> <p>Here is a simple example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --filter 'n_likes == 5' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --filter 'n_likes == 5' # [ # [ # 0, @@ -1455,7 +1455,7 @@ to <code class="docutils literal"><span class="pre">5</span></code>.</p> <code class="docutils literal"><span class="pre">object2</span></code>, false otherwise.</p> <p>Here is a simple example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --filter 'n_likes != 5' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --filter 'n_likes != 5' # [ # [ # 0, @@ -1540,9 +1540,9 @@ equal to <code class="docutils literal"><span class="pre">5</span></code>.</p> <div class="section" id="addition-assignment-operator"> <h3>7.12.2.8.1. Addition assignment operator<a class="headerlink" href="#addition-assignment-operator" title="Permalink to this headline">¶</a></h3> <p>Its syntax is <code class="docutils literal"><span class="pre">column1</span> <span class="pre">+=</span> <span class="pre">column2</span></code>.</p> -<p>The operator performs addition assginment operation on column1 by column2.</p> +<p>The operator performs addition assignment operation on column1 by column2.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --output_columns _key,n_likes,_score --filter true --scorer '_score += n_likes' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --output_columns _key,n_likes,_score --filter true --scorer '_score += n_likes' # [ # [ # 0, @@ -1607,9 +1607,9 @@ is 3.</p> <div class="section" id="subtraction-assignment-operator"> <h3>7.12.2.8.2. Subtraction assignment operator<a class="headerlink" href="#subtraction-assignment-operator" title="Permalink to this headline">¶</a></h3> <p>Its syntax is <code class="docutils literal"><span class="pre">column1</span> <span class="pre">-=</span> <span class="pre">column2</span></code>.</p> -<p>The operator performs subtraction assginment operation on column1 by column2.</p> +<p>The operator performs subtraction assignment operation on column1 by column2.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --output_columns _key,n_likes,_score --filter true --scorer '_score -= n_likes' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --output_columns _key,n_likes,_score --filter true --scorer '_score -= n_likes' # [ # [ # 0, @@ -1674,9 +1674,9 @@ is 3.</p> <div class="section" id="multiplication-assignment-operator"> <h3>7.12.2.8.3. Multiplication assignment operator<a class="headerlink" href="#multiplication-assignment-operator" title="Permalink to this headline">¶</a></h3> <p>Its syntax is <code class="docutils literal"><span class="pre">column1</span> <span class="pre">*=</span> <span class="pre">column2</span></code>.</p> -<p>The operator performs multiplication assginment operation on column1 by column2.</p> +<p>The operator performs multiplication assignment operation on column1 by column2.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --output_columns _key,n_likes,_score --filter true --scorer '_score *= n_likes' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --output_columns _key,n_likes,_score --filter true --scorer '_score *= n_likes' # [ # [ # 0, @@ -1741,9 +1741,9 @@ is 3.</p> <div class="section" id="division-assignment-operator"> <h3>7.12.2.8.4. Division assignment operator<a class="headerlink" href="#division-assignment-operator" title="Permalink to this headline">¶</a></h3> <p>Its syntax is <code class="docutils literal"><span class="pre">column1</span> <span class="pre">/=</span> <span class="pre">column2</span></code>.</p> -<p>The operator performs division assginment operation on column1 by column2.</p> +<p>The operator performs division assignment operation on column1 by column2.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --output_columns _key,n_likes,_score --filter true --scorer '_score /= n_likes' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --output_columns _key,n_likes,_score --filter true --scorer '_score /= n_likes' # [ # [ # 0, @@ -1808,9 +1808,9 @@ is 3.</p> <div class="section" id="modulo-assignment-operator"> <h3>7.12.2.8.5. Modulo assignment operator<a class="headerlink" href="#modulo-assignment-operator" title="Permalink to this headline">¶</a></h3> <p>Its syntax is <code class="docutils literal"><span class="pre">column1</span> <span class="pre">%=</span> <span class="pre">column2</span></code>.</p> -<p>The operator performs modulo assginment operation on column1 by column2.</p> +<p>The operator performs modulo assignment operation on column1 by column2.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --output_columns _key,n_likes,_score --filter true --scorer '_score %= n_likes' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --output_columns _key,n_likes,_score --filter true --scorer '_score %= n_likes' # [ # [ # 0, @@ -1875,9 +1875,9 @@ is 3.</p> <div class="section" id="bitwise-left-shift-assignment-operator"> <h3>7.12.2.8.6. Bitwise left shift assignment operator<a class="headerlink" href="#bitwise-left-shift-assignment-operator" title="Permalink to this headline">¶</a></h3> <p>Its syntax is <code class="docutils literal"><span class="pre">column1</span> <span class="pre"><<=</span> <span class="pre">column2</span></code>.</p> -<p>The operator performs left shift assginment operation on column1 by column2.</p> +<p>The operator performs left shift assignment operation on column1 by column2.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --output_columns _key,n_likes,_score --filter true --scorer '_score <<= n_likes' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --output_columns _key,n_likes,_score --filter true --scorer '_score <<= n_likes' # [ # [ # 0, @@ -1942,19 +1942,19 @@ is 3.</p> <div class="section" id="bitwise-signed-right-shift-assignment-operator"> <h3>7.12.2.8.7. Bitwise signed right shift assignment operator<a class="headerlink" href="#bitwise-signed-right-shift-assignment-operator" title="Permalink to this headline">¶</a></h3> <p>Its syntax is <code class="docutils literal"><span class="pre">column2</span> <span class="pre">>>=</span> <span class="pre">column2</span></code>.</p> -<p>The operator performs signed right shift assginment operation on column1 by column2.</p> +<p>The operator performs signed right shift assignment operation on column1 by column2.</p> </div> <div class="section" id="bitwise-unsigned-right-shift-assignment-operator"> <h3>7.12.2.8.8. Bitwise unsigned right shift assignment operator<a class="headerlink" href="#bitwise-unsigned-right-shift-assignment-operator" title="Permalink to this headline">¶</a></h3> <p>Its syntax is <code class="docutils literal"><span class="pre">column1</span> <span class="pre">>>>=</span> <span class="pre">column2</span></code>.</p> -<p>The operator performs unsigned right shift assginment operation on column1 by column2.</p> +<p>The operator performs unsigned right shift assignment operation on column1 by column2.</p> </div> <div class="section" id="bitwise-and-assignment-operator"> <h3>7.12.2.8.9. Bitwise AND assignment operator<a class="headerlink" href="#bitwise-and-assignment-operator" title="Permalink to this headline">¶</a></h3> <p>Its syntax is <code class="docutils literal"><span class="pre">column1</span> <span class="pre">&=</span> <span class="pre">column2</span></code>.</p> <p>The operator performs bitwise AND assignment operation on column1 by column2.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --output_columns _key,n_likes,_score --filter true --scorer '_score &= n_likes' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --output_columns _key,n_likes,_score --filter true --scorer '_score &= n_likes' # [ # [ # 0, @@ -2021,7 +2021,7 @@ is 10.</p> <p>Its syntax is <code class="docutils literal"><span class="pre">column1</span> <span class="pre">|=</span> <span class="pre">column2</span></code>.</p> <p>The operator performs bitwise OR assignment operation on column1 by column2.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --output_columns _key,n_likes,_score --filter true --scorer '_score |= n_likes' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --output_columns _key,n_likes,_score --filter true --scorer '_score |= n_likes' # [ # [ # 0, @@ -2086,9 +2086,9 @@ is 10.</p> <div class="section" id="bitwise-xor-assignment-operator"> <h3>7.12.2.8.11. Bitwise XOR assignment operator<a class="headerlink" href="#bitwise-xor-assignment-operator" title="Permalink to this headline">¶</a></h3> <p>Its syntax is <code class="docutils literal"><span class="pre">column1</span> <span class="pre">^=</span> <span class="pre">column2</span></code>.</p> -<p>The operator performs bitwise XOR assginment operation on column1 by column2.</p> +<p>The operator performs bitwise XOR assignment operation on column1 by column2.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --output_columns _key,n_likes,_score --filter true --scorer '_score ^= n_likes' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --output_columns _key,n_likes,_score --filter true --scorer '_score ^= n_likes' # [ # [ # 0, @@ -2165,7 +2165,7 @@ Because tag search is also implemented by inverted index.</p> <p><a class="reference internal" href="query_syntax.html"><em>Query syntax</em></a> uses this operator by default.</p> <p>Here is a simple example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --filter 'content @ "fast"' --output_columns content +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --filter 'content @ "fast"' --output_columns content # [ # [ # 0, @@ -2213,7 +2213,7 @@ records scan. It's not problem for small records but it spends more time for large records.</p> <p>Here is a simple example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --filter '_key @^ "Goo"' --output_columns _key +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --filter '_key @^ "Goo"' --output_columns _key # [ # [ # 0, @@ -2274,7 +2274,7 @@ large records.</p> <p>Here is a simple example. It uses fast suffix search for hiragana in Japanese that is one of non-ASCII characters.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Titles TABLE_NO_KEY +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Titles TABLE_NO_KEY # [[0, 1337566253.89858, 0.000355720520019531], true] column_create Titles content COLUMN_SCALAR ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -2346,7 +2346,7 @@ N-gram family tokenizer.)</p> <code class="docutils literal"><span class="pre">column</span></code>.</p> <p>Here is a simple example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --filter 'content *N "I fast"' --output_columns content +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --filter 'content *N "I fast"' --output_columns content # [ # [ # 0, @@ -2424,7 +2424,7 @@ search searches records that have similar content to <code class="docutils literal"><span class="pre">column</span></code>.</p> <p>Here is a simple example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --filter 'content *S "I migrated all Solr system!"' --output_columns content +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --filter 'content *S "I migrated all Solr system!"' --output_columns content # [ # [ # 0, @@ -2469,7 +2469,7 @@ support longest common prefix search. Longest common prefix search is used to implement the operator.</p> <p>Here is a simple example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Words TABLE_PAT_KEY ShortText --normalizer NormalizerAuto +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Words TABLE_PAT_KEY ShortText --normalizer NormalizerAuto # [[0, 1337566253.89858, 0.000355720520019531], true] load --table Words [ @@ -2529,7 +2529,7 @@ details.</p> <p>The following example uses <code class="docutils literal"><span class="pre">.roonga</span></code> as pattern. It matches <code class="docutils literal"><span class="pre">Groonga</span></code>, <code class="docutils literal"><span class="pre">Mroonga</span></code> and so on.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Entries --filter 'content @~ ".roonga"' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Entries --filter 'content @~ ".roonga"' # [ # [ # 0, Modified: docs/reference/indexing.html (+7 -7) =================================================================== --- docs/reference/indexing.html 2016-03-05 15:09:34 +0900 (fca8317) +++ docs/reference/indexing.html 2016-03-17 12:56:59 +0900 (570f6f7) @@ -122,7 +122,7 @@ register a document, we can search it quickly.</p> to a column that already has data.</p> <p>We define a schema:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Tweets TABLE_NO_KEY +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Tweets TABLE_NO_KEY # [[0, 1337566253.89858, 0.000355720520019531], true] column_create Tweets content COLUMN_SCALAR ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -132,7 +132,7 @@ table_create Lexicon TABLE_HASH_KEY ShortText --default_tokenizer TokenBigram -- </div> <p>We register data:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>load --table Tweets +<div class="highlight-none"><div class="highlight"><pre><span></span>load --table Tweets [ {"content":"Hello!"}, {"content":"I just start it!"}, @@ -143,7 +143,7 @@ table_create Lexicon TABLE_HASH_KEY ShortText --default_tokenizer TokenBigram -- </div> <p>We can search with sequential search when we don't have index:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Tweets --match_columns content --query 'good nice' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Tweets --match_columns content --query 'good nice' # [ # [ # 0, @@ -178,13 +178,13 @@ table_create Lexicon TABLE_HASH_KEY ShortText --default_tokenizer TokenBigram -- data in <code class="docutils literal"><span class="pre">Tweets.content</span></code> are indexed by offline index construction:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>column_create Lexicon tweet COLUMN_INDEX|WITH_POSITION Tweets content +<div class="highlight-none"><div class="highlight"><pre><span></span>column_create Lexicon tweet COLUMN_INDEX|WITH_POSITION Tweets content # [[0, 1337566253.89858, 0.000355720520019531], true] </pre></div> </div> <p>We search with index. We get a matched record:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Tweets --match_columns content --query 'good nice' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Tweets --match_columns content --query 'good nice' # [ # [ # 0, @@ -218,7 +218,7 @@ construction:</p> <p>We register data again. They are indexed by online index construction:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>load --table Tweets +<div class="highlight-none"><div class="highlight"><pre><span></span>load --table Tweets [ {"content":"Good morning! Nice day."}, {"content":"Let's go shopping."} @@ -228,7 +228,7 @@ construction:</p> </div> <p>We can also get newly registered records by searching:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Tweets --match_columns content --query 'good nice' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Tweets --match_columns content --query 'good nice' # [ # [ # 0, Modified: docs/reference/log.html (+21 -21) =================================================================== --- docs/reference/log.html 2016-03-05 15:09:34 +0900 (110a11b) +++ docs/reference/log.html 2016-03-17 12:56:59 +0900 (5af5b5e) @@ -27,7 +27,7 @@ <link rel="top" title="Groonga v6.0.0 documentation" href="../index.html" /> <link rel="up" title="7. Reference manual" href="../reference.html" /> <link rel="next" title="7.22. Tuning" href="tuning.html" /> - <link rel="prev" title="7.3.35. logical_table_remove" href="commands/logical_table_remove.html" /> + <link rel="prev" title="7.20. Sharding" href="sharding.html" /> <meta property="fb:page_id" content="201193596592346" /><!-- groonga --> <meta property="fb:admins" content="664204556" /><!-- kouhei.sutou --> <meta property="og:type" content="product" /> @@ -71,7 +71,7 @@ <a href="tuning.html" title="7.22. Tuning" accesskey="N">next</a> |</li> <li class="right" > - <a href="commands/logical_table_remove.html" title="7.3.35. logical_table_remove" + <a href="sharding.html" title="7.20. Sharding" accesskey="P">previous</a> |</li> <li class="nav-item nav-item-0"><a href="../index.html">Groonga v6.0.0 documentation</a> »</li> <li class="nav-item nav-item-1"><a href="../reference.html" accesskey="U">7. Reference manual</a> »</li> @@ -98,13 +98,13 @@ level, it's not logged. Log level can be customized by <div class="section" id="format"> <h3>7.21.1.1. Format<a class="headerlink" href="#format" title="Permalink to this headline">¶</a></h3> <p>Process log uses the following format:</p> -<div class="highlight-none"><div class="highlight"><pre>#{TIME_STAMP}|#{L}| #{MESSAGE} +<div class="highlight-none"><div class="highlight"><pre><span></span>#{TIME_STAMP}|#{L}| #{MESSAGE} </pre></div> </div> <dl class="docutils"> <dt>TIME_STAMP</dt> <dd><p class="first">It's time stamp uses the following format:</p> -<div class="highlight-none"><div class="highlight"><pre>YYYY-MM-DD hh:mm:ss.SSSSSS +<div class="highlight-none"><div class="highlight"><pre><span></span>YYYY-MM-DD hh:mm:ss.SSSSSS </pre></div> </div> <dl class="docutils"> @@ -124,7 +124,7 @@ level, it's not logged. Log level can be customized by <dd>Microsecond with six digits.</dd> </dl> <p>Example:</p> -<div class="last highlight-none"><div class="highlight"><pre>2011-07-05 06:25:18.345734 +<div class="last highlight-none"><div class="highlight"><pre><span></span>2011-07-05 06:25:18.345734 </pre></div> </div> </dd> @@ -152,20 +152,20 @@ level map.</p> <dd>Dump</dd> </dl> <p>Example:</p> -<div class="last highlight-none"><div class="highlight"><pre>E +<div class="last highlight-none"><div class="highlight"><pre><span></span>E </pre></div> </div> </dd> <dt>MESSAGE</dt> <dd><p class="first">Details about the log with free format.</p> <p>Example:</p> -<div class="last highlight-none"><div class="highlight"><pre>log opened. +<div class="last highlight-none"><div class="highlight"><pre><span></span>log opened. </pre></div> </div> </dd> </dl> <p>Example:</p> -<div class="highlight-none"><div class="highlight"><pre>2011-07-05 08:35:09.276421|n| grn_init +<div class="highlight-none"><div class="highlight"><pre><span></span>2011-07-05 08:35:09.276421|n| grn_init 2011-07-05 08:35:09.276553|n| RLIMIT_NOFILE(4096,4096) </pre></div> </div> @@ -178,7 +178,7 @@ level map.</p> <div class="section" id="id3"> <h3>7.21.2.1. Format<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h3> <p>Query log uses the following formats:</p> -<div class="highlight-none"><div class="highlight"><pre>#{TIME_STAMP}|#{MESSAGE} +<div class="highlight-none"><div class="highlight"><pre><span></span>#{TIME_STAMP}|#{MESSAGE} #{TIME_STAMP}|#{ID}|>#{QUERY} #{TIME_STAMP}|#{ID}|:#{ELAPSED_TIME} #{PROGRESS} #{TIME_STAMP}|#{ID}|<#{ELAPSED_TIME} #{RETURN_CODE} @@ -187,7 +187,7 @@ level map.</p> <dl class="docutils"> <dt>TIME_STAMP</dt> <dd><p class="first">It's time stamp uses the following format:</p> -<div class="highlight-none"><div class="highlight"><pre>YYYY-MM-DD hh:mm:ss.SSSSSS +<div class="highlight-none"><div class="highlight"><pre><span></span>YYYY-MM-DD hh:mm:ss.SSSSSS </pre></div> </div> <dl class="docutils"> @@ -207,7 +207,7 @@ level map.</p> <dd>Microsecond with six digits.</dd> </dl> <p>Example:</p> -<div class="last highlight-none"><div class="highlight"><pre>2011-07-05 06:25:18.345734 +<div class="last highlight-none"><div class="highlight"><pre><span></span>2011-07-05 06:25:18.345734 </pre></div> </div> </dd> @@ -217,7 +217,7 @@ requests concurrently. Each thread outputs some logs for a request. This ID can be used to extract a log sequence by a thread.</p> <p>Example:</p> -<div class="last highlight-none"><div class="highlight"><pre>45ea3034 +<div class="last highlight-none"><div class="highlight"><pre><span></span>45ea3034 </pre></div> </div> </dd> @@ -236,21 +236,21 @@ a thread.</p> <dt>MESSAGE</dt> <dd><p class="first">Details about the log with free format.</p> <p>Example:</p> -<div class="last highlight-none"><div class="highlight"><pre>query log opened. +<div class="last highlight-none"><div class="highlight"><pre><span></span>query log opened. </pre></div> </div> </dd> <dt>QUERY</dt> <dd><p class="first">A query to be processed.</p> <p>Example:</p> -<div class="last highlight-none"><div class="highlight"><pre>select users --match_columns hobby --query music +<div class="last highlight-none"><div class="highlight"><pre><span></span>select users --match_columns hobby --query music </pre></div> </div> </dd> <dt>ELAPSED_TIME</dt> <dd><p class="first">Elapsed time in nanoseconds since query is started.</p> <p>Example:</p> -<div class="last highlight-none"><div class="highlight"><pre>000000000075770 +<div class="last highlight-none"><div class="highlight"><pre><span></span>000000000075770 (It means 75,770 nanoseconds.) </pre></div> </div> @@ -258,7 +258,7 @@ a thread.</p> <dt>PROGRESS</dt> <dd><p class="first">A processed work at the time.</p> <p>Example:</p> -<div class="last highlight-none"><div class="highlight"><pre>select(313401) +<div class="last highlight-none"><div class="highlight"><pre><span></span>select(313401) (It means that 'select' is processed and 313,401 records are remained.) </pre></div> </div> @@ -266,14 +266,14 @@ a thread.</p> <dt>RETURN_CODE</dt> <dd><p class="first">A return code for the query.</p> <p>Example:</p> -<div class="last highlight-none"><div class="highlight"><pre>rc=0 +<div class="last highlight-none"><div class="highlight"><pre><span></span>rc=0 (It means return code is 0. 0 means GRN_SUCCESS.) </pre></div> </div> </dd> </dl> <p>Example:</p> -<div class="highlight-none"><div class="highlight"><pre>2011-07-05 06:25:19.458756|45ea3034|>select Properties --limit 0 +<div class="highlight-none"><div class="highlight"><pre><span></span>2011-07-05 06:25:19.458756|45ea3034|>select Properties --limit 0 2011-07-05 06:25:19.458829|45ea3034|:000000000072779 select(19) 2011-07-05 06:25:19.458856|45ea3034|:000000000099998 output(0) 2011-07-05 06:25:19.458875|45ea3034|<000000000119062 rc=0 @@ -306,8 +306,8 @@ a thread.</p> </ul> <h4>Previous topic</h4> - <p class="topless"><a href="commands/logical_table_remove.html" - title="previous chapter">7.3.35. <code class="docutils literal"><span class="pre">logical_table_remove</span></code></a></p> + <p class="topless"><a href="sharding.html" + title="previous chapter">7.20. Sharding</a></p> <h4>Next topic</h4> <p class="topless"><a href="tuning.html" title="next chapter">7.22. Tuning</a></p> @@ -345,7 +345,7 @@ a thread.</p> <a href="tuning.html" title="7.22. Tuning" >next</a> |</li> <li class="right" > - <a href="commands/logical_table_remove.html" title="7.3.35. logical_table_remove" + <a href="sharding.html" title="7.20. Sharding" >previous</a> |</li> <li class="nav-item nav-item-0"><a href="../index.html">Groonga v6.0.0 documentation</a> »</li> <li class="nav-item nav-item-1"><a href="../reference.html" >7. Reference manual</a> »</li> Modified: docs/reference/normalizers.html (+4 -4) =================================================================== --- docs/reference/normalizers.html 2016-03-05 15:09:34 +0900 (9c3ca0f) +++ docs/reference/normalizers.html 2016-03-17 12:56:59 +0900 (445d987) @@ -99,7 +99,7 @@ by <a class="reference internal" href="commands/table_create.html#table-create-n <p>Here is an example <code class="docutils literal"><span class="pre">table_create</span></code> that uses <code class="docutils literal"><span class="pre">NormalizerAuto</span></code> normalizer module:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Dictionary TABLE_HASH_KEY ShortText --normalizer NormalizerAuto +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Dictionary TABLE_HASH_KEY ShortText --normalizer NormalizerAuto # [[0, 1337566253.89858, 0.000355720520019531], true] </pre></div> </div> @@ -118,7 +118,7 @@ database.</p> </div> <p>Keys of a table that has a normalizer module are normalized:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>load --table Dictionary +<div class="highlight-none"><div class="highlight"><pre><span></span>load --table Dictionary [ {"_key": "Apple"}, {"_key": "black"}, @@ -200,7 +200,7 @@ voiced sound mark (U+30AC KATAKANA LETTER GA). The former is two chracters but the latter is one character.</p> <p>Here is an example that uses <code class="docutils literal"><span class="pre">NormalizerAuto</span></code> normalizer:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create NormalLexicon TABLE_HASH_KEY ShortText --normalizer NormalizerAuto +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create NormalLexicon TABLE_HASH_KEY ShortText --normalizer NormalizerAuto # [[0, 1337566253.89858, 0.000355720520019531], true] </pre></div> </div> @@ -214,7 +214,7 @@ only UTF-8 encoding.</p> use <code class="docutils literal"><span class="pre">NormalizerAuto</span></code> instead.</p> <p>Here is an example that uses <code class="docutils literal"><span class="pre">NormalizerNFKC51</span></code> normalizer:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create NFKC51Lexicon TABLE_HASH_KEY ShortText --normalizer NormalizerNFKC51 +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create NFKC51Lexicon TABLE_HASH_KEY ShortText --normalizer NormalizerNFKC51 # [[0, 1337566253.89858, 0.000355720520019531], true] </pre></div> </div> Modified: docs/reference/operations/prefix_rk_search.html (+1 -1) =================================================================== --- docs/reference/operations/prefix_rk_search.html 2016-03-05 15:09:34 +0900 (b2e36f8) +++ docs/reference/operations/prefix_rk_search.html 2016-03-17 12:56:59 +0900 (851d1ee) @@ -110,7 +110,7 @@ users.</p> <p>You need <a class="reference internal" href="../tables.html#table-pat-key"><span>TABLE_PAT_KEY</span></a> table for using prefix RK search.</p> <p>You need to put reading in katakana to <code class="docutils literal"><span class="pre">TABLE_PAT_KEY</span></code> as key:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Readings TABLE_PAT_KEY ShortText --normalizer NormalizerAuto +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Readings TABLE_PAT_KEY ShortText --normalizer NormalizerAuto # [[0, 1337566253.89858, 0.000355720520019531], true] load --table Readings [ Modified: docs/reference/output.html (+10 -10) =================================================================== --- docs/reference/output.html 2016-03-05 15:09:34 +0900 (5169818) +++ docs/reference/output.html 2016-03-17 12:56:59 +0900 (50292d9) @@ -113,19 +113,19 @@ output format type by <code class="docutils literal"><span class="pre">output_type</span></code> option.</p> <p>If you don't specify <code class="docutils literal"><span class="pre">output_type</span></code> option, you will get a result in JSON format:</p> -<div class="highlight-none"><div class="highlight"><pre>> status +<div class="highlight-none"><div class="highlight"><pre><span></span>> status [[0,1327721628.10738,0.000131845474243164],{"alloc_count":142,"starttime":1327721626,"uptime":2,"version":"1.2.9-92-gb87d9f8","n_queries":0,"cache_hit_rate":0.0,"command_version":1,"default_command_version":1,"max_command_version":2}] </pre></div> </div> <p>You can specify <code class="docutils literal"><span class="pre">json</span></code> as <code class="docutils literal"><span class="pre">output_type</span></code> value to get a result in JSON format explicitly:</p> -<div class="highlight-none"><div class="highlight"><pre>> status --output_type json +<div class="highlight-none"><div class="highlight"><pre><span></span>> status --output_type json [[0,1327721639.08321,7.93933868408203e-05],{"alloc_count":144,"starttime":1327721626,"uptime":13,"version":"1.2.9-92-gb87d9f8","n_queries":0,"cache_hit_rate":0.0,"command_version":1,"default_command_version":1,"max_command_version":2}] </pre></div> </div> <p>You need to specify <code class="docutils literal"><span class="pre">xml</span></code> as <code class="docutils literal"><span class="pre">output_type</span></code> value to get a result in XML format:</p> -<div class="highlight-none"><div class="highlight"><pre>> status --output_type xml +<div class="highlight-none"><div class="highlight"><pre><span></span>> status --output_type xml <?xml version="1.0" encoding="utf-8"?> <RESULT CODE="0" UP="1327721649.61095" ELAPSED="0.000126361846923828"> <RESULT> @@ -152,7 +152,7 @@ get a result in XML format:</p> </div> <p>You need to specify <code class="docutils literal"><span class="pre">tsv</span></code> as <code class="docutils literal"><span class="pre">output_type</span></code> value to get a result in TSV format:</p> -<div class="highlight-none"><div class="highlight"><pre>> status --output_type tsv +<div class="highlight-none"><div class="highlight"><pre><span></span>> status --output_type tsv 0 1327721664.82675 0.000113964080810547 "alloc_count" 146 "starttime" 1327721626 @@ -168,7 +168,7 @@ END </div> <p>You need to specify <code class="docutils literal"><span class="pre">msgpack</span></code> as <code class="docutils literal"><span class="pre">output_type</span></code> value to get a result in MessagePack format:</p> -<div class="highlight-none"><div class="highlight"><pre>> status --output_type msgpack +<div class="highlight-none"><div class="highlight"><pre><span></span>> status --output_type msgpack (... omitted because MessagePack is binary data format. ...) </pre></div> </div> @@ -181,19 +181,19 @@ by default. In this query interface, you can specify output format type by extension.</p> <p>If you don't specify extension, you will get a result in JSON format:</p> -<div class="highlight-none"><div class="highlight"><pre>% curl http://localhost:10041/d/status +<div class="highlight-none"><div class="highlight"><pre><span></span>% curl http://localhost:10041/d/status [[0,1327809294.54311,0.00082087516784668],{"alloc_count":155,"starttime":1327809282,"uptime":12,"version":"1.2.9-92-gb87d9f8","n_queries":0,"cache_hit_rate":0.0,"command_version":1,"default_command_version":1,"max_command_version":2}] </pre></div> </div> <p>You can specify <code class="docutils literal"><span class="pre">json</span></code> as extension to get a result in JSON format explicitly:</p> -<div class="highlight-none"><div class="highlight"><pre>% curl http://localhost:10041/d/status.json +<div class="highlight-none"><div class="highlight"><pre><span></span>% curl http://localhost:10041/d/status.json [[0,1327809319.01929,9.5367431640625e-05],{"alloc_count":157,"starttime":1327809282,"uptime":37,"version":"1.2.9-92-gb87d9f8","n_queries":0,"cache_hit_rate":0.0,"command_version":1,"default_command_version":1,"max_command_version":2}] </pre></div> </div> <p>You need to specify <code class="docutils literal"><span class="pre">xml</span></code> as extension to get a result in XML format:</p> -<div class="highlight-none"><div class="highlight"><pre>% curl http://localhost:10041/d/status.xml +<div class="highlight-none"><div class="highlight"><pre><span></span>% curl http://localhost:10041/d/status.xml <?xml version="1.0" encoding="utf-8"?> <RESULT CODE="0" UP="1327809339.5782" ELAPSED="9.56058502197266e-05"> <RESULT> @@ -220,7 +220,7 @@ XML format:</p> </div> <p>You need to specify <code class="docutils literal"><span class="pre">tsv</span></code> as extension to get a result in TSV format:</p> -<div class="highlight-none"><div class="highlight"><pre>% curl http://localhost:10041/d/status.tsv +<div class="highlight-none"><div class="highlight"><pre><span></span>% curl http://localhost:10041/d/status.tsv 0 1327809366.84187 8.44001770019531e-05 "alloc_count" 159 "starttime" 1327809282 @@ -236,7 +236,7 @@ END </div> <p>You need to specify <code class="docutils literal"><span class="pre">msgpack</span></code> as extension to get a result in MessagePack format:</p> -<div class="highlight-none"><div class="highlight"><pre>% curl http://localhost:10041/d/status.msgpack +<div class="highlight-none"><div class="highlight"><pre><span></span>% curl http://localhost:10041/d/status.msgpack (... omitted because MessagePack is binary data format. ...) </pre></div> </div> Modified: docs/reference/query_expanders/tsv.html (+11 -11) =================================================================== --- docs/reference/query_expanders/tsv.html 2016-03-05 15:09:34 +0900 (e94696e) +++ docs/reference/query_expanders/tsv.html 2016-03-17 12:56:59 +0900 (67f619d) @@ -100,7 +100,7 @@ expansion feature, you manage your synonyms by Groonga's table.</p> <h2>7.10.1.2. Install<a class="headerlink" href="#install" title="Permalink to this headline">¶</a></h2> <p>You need to register <code class="docutils literal"><span class="pre">query_expanders/tsv</span></code> as a plugin before you use <code class="docutils literal"><span class="pre">QueryExpanderTSV</span></code>:</p> -<div class="highlight-none"><div class="highlight"><pre>plugin_register query_expanders/tsv +<div class="highlight-none"><div class="highlight"><pre><span></span>plugin_register query_expanders/tsv </pre></div> </div> </div> @@ -108,7 +108,7 @@ use <code class="docutils literal"><span class="pre">QueryExpanderTSV</span></co <h2>7.10.1.3. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2> <p>You just add <code class="docutils literal"><span class="pre">--query_expander</span> <span class="pre">QueryExpanderTSV</span></code> parameter to <code class="docutils literal"><span class="pre">select</span></code> command:</p> -<div class="highlight-none"><div class="highlight"><pre>select --query "QUERY" --query_expander QueryExpanderTSV +<div class="highlight-none"><div class="highlight"><pre><span></span>select --query "QUERY" --query_expander QueryExpanderTSV </pre></div> </div> <p>If <code class="docutils literal"><span class="pre">QUERY</span></code> has registered synonyms, they are expanded. For example, @@ -141,20 +141,20 @@ there are the following synonyms.</p> <code class="docutils literal"><span class="pre">groonga</span></code>. And <code class="docutils literal"><span class="pre">mroonga</span></code> and <code class="docutils literal"><span class="pre">groonga</span> <span class="pre">MySQL</span></code> are synonyms of <code class="docutils literal"><span class="pre">mroonga</span></code>.</p> <p>Here is an example of query expnasion that uses <code class="docutils literal"><span class="pre">groonga</span></code> as query:</p> -<div class="highlight-none"><div class="highlight"><pre>select --query "groonga" --query_expander QueryExpanderTSV +<div class="highlight-none"><div class="highlight"><pre><span></span>select --query "groonga" --query_expander QueryExpanderTSV </pre></div> </div> <p>The above command equals to the following command:</p> -<div class="highlight-none"><div class="highlight"><pre>select --query "groonga OR Senna" --query_expander QueryExpanderTSV +<div class="highlight-none"><div class="highlight"><pre><span></span>select --query "groonga OR Senna" --query_expander QueryExpanderTSV </pre></div> </div> <p>Here is another example of query expnasion that uses <code class="docutils literal"><span class="pre">mroonga</span> <span class="pre">search</span></code> as query:</p> -<div class="highlight-none"><div class="highlight"><pre>select --query "mroonga search" --query_expander QueryExpanderTSV +<div class="highlight-none"><div class="highlight"><pre><span></span>select --query "mroonga search" --query_expander QueryExpanderTSV </pre></div> </div> <p>The above command equals to the following command:</p> -<div class="highlight-none"><div class="highlight"><pre>select --query "(mroonga OR (groonga MySQL)) search" --query_expander QueryExpanderTSV +<div class="highlight-none"><div class="highlight"><pre><span></span>select --query "(mroonga OR (groonga MySQL)) search" --query_expander QueryExpanderTSV </pre></div> </div> <p>It is important that registered words (<code class="docutils literal"><span class="pre">groonga</span></code> and <code class="docutils literal"><span class="pre">mroonga</span></code>) @@ -187,11 +187,11 @@ synonyms.</p> <p><code class="docutils literal"><span class="pre">gronga</span></code> in <code class="docutils literal"><span class="pre">word</span></code> has a typo. A <code class="docutils literal"><span class="pre">o</span></code> is missing. <code class="docutils literal"><span class="pre">groonga</span></code> in <code class="docutils literal"><span class="pre">synonym</span></code> is the correct word.</p> <p>Here is an example of using query expnasion as spelling correction:</p> -<div class="highlight-none"><div class="highlight"><pre>select --query "gronga" --query_expander QueryExpanderTSV +<div class="highlight-none"><div class="highlight"><pre><span></span>select --query "gronga" --query_expander QueryExpanderTSV </pre></div> </div> <p>The above command equals to the following command:</p> -<div class="highlight-none"><div class="highlight"><pre>select --query "groonga" --query_expander QueryExpanderTSV +<div class="highlight-none"><div class="highlight"><pre><span></span>select --query "groonga" --query_expander QueryExpanderTSV </pre></div> </div> <p>The former command has a typo in <code class="docutils literal"><span class="pre">--query</span></code> value but the latter @@ -208,7 +208,7 @@ configuration directory. For example, <code class="docutils literal"><span class a TSV file location. The location is decided at build time.</p> <p>You can change the location by environment variable <code class="docutils literal"><span class="pre">GRN_QUERY_EXPANDER_TSV_SYNONYMS_FILE</span></code> at run time:</p> -<div class="highlight-none"><div class="highlight"><pre>% env GRN_QUERY_EXPANDER_TSV_SYNONYMS_FILE=/tmp/synonyms.tsv groonga +<div class="highlight-none"><div class="highlight"><pre><span></span>% env GRN_QUERY_EXPANDER_TSV_SYNONYMS_FILE=/tmp/synonyms.tsv groonga </pre></div> </div> <p>With the above command, <code class="docutils literal"><span class="pre">/tmp/synonyms.tsv</span></code> file is used.</p> @@ -224,13 +224,13 @@ as <code class="docutils literal"><span class="pre">groonga</span> <span class=" the <code class="docutils literal"><span class="pre">word</span></code>. Here is a sample line for <code class="docutils literal"><span class="pre">word</span></code> is <code class="docutils literal"><span class="pre">groonga</span></code> and <code class="docutils literal"><span class="pre">synonyms</span></code> are <code class="docutils literal"><span class="pre">groonga</span></code> and <code class="docutils literal"><span class="pre">Senna</span></code>. <code class="docutils literal"><span class="pre">(TAB)</span></code> means a tab character (<code class="docutils literal"><span class="pre">U+0009</span></code>):</p> -<div class="highlight-none"><div class="highlight"><pre>groonga(TAB)groonga(TAB)Senna +<div class="highlight-none"><div class="highlight"><pre><span></span>groonga(TAB)groonga(TAB)Senna </pre></div> </div> <p>Comment line is supported. Lines that start with <code class="docutils literal"><span class="pre">#</span></code> are ignored. Here is an example for comment line. <code class="docutils literal"><span class="pre">groonga</span></code> line is ignored as comment line:</p> -<div class="highlight-none"><div class="highlight"><pre>#groonga(TAB)groonga(TAB)Senna +<div class="highlight-none"><div class="highlight"><pre><span></span>#groonga(TAB)groonga(TAB)Senna mroonga(TAB)mroonga(TAB)groonga MySQL </pre></div> </div> Modified: docs/reference/regular_expression.html (+15 -15) =================================================================== --- docs/reference/regular_expression.html 2016-03-05 15:09:34 +0900 (ae2760a) +++ docs/reference/regular_expression.html 2016-03-17 12:56:59 +0900 (538ed42) @@ -144,7 +144,7 @@ command.</p> only one table, <code class="docutils literal"><span class="pre">Logs</span></code>. <code class="docutils literal"><span class="pre">Logs</span></code> table has only <code class="docutils literal"><span class="pre">message</span></code> column. Log messages are stored into the <code class="docutils literal"><span class="pre">message</span></code> column.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Logs TABLE_NO_KEY +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Logs TABLE_NO_KEY # [[0, 1337566253.89858, 0.000355720520019531], true] column_create Logs message COLUMN_SCALAR Text # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -163,7 +163,7 @@ load --table Logs <a class="reference internal" href="commands/select.html#select-query"><span>query</span></a>. You need to use <code class="docutils literal"><span class="pre">${COLUMN}:~${REGULAR_EXPRESSION}</span></code> syntax.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Logs --query 'message:~"disk (space|full)"' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Logs --query 'message:~"disk (space|full)"' # [ # [ # 0, @@ -202,7 +202,7 @@ load --table Logs <a class="reference internal" href="commands/select.html#select-filter"><span>filter</span></a>. You need to use <code class="docutils literal"><span class="pre">${COLUMN}</span> <span class="pre">@~</span> <span class="pre">${REGULAR_EXPRESSION}</span></code> syntax.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Logs --filter 'message @~ "disk (space|full)"' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Logs --filter 'message @~ "disk (space|full)"' # [ # [ # 0, @@ -267,7 +267,7 @@ use <a class="reference internal" href="normalizers.html#normalizer-auto"><span> <p>Here are recommended index definitions. In general, it's reasonable index definitions.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create RegexpLexicon TABLE_PAT_KEY ShortText \ +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create RegexpLexicon TABLE_PAT_KEY ShortText \ --default_tokenizer TokenRegexp \ --normalizer NormalizerAuto # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -280,7 +280,7 @@ column_create RegexpLexicon logs_message_index \ regular expression can be evaluated by index because it uses only "the beginning of text" and "literal".</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Logs --query message:~\\\\Ahost1 +<div class="highlight-none"><div class="highlight"><pre><span></span>select Logs --query message:~\\\\Ahost1 # [ # [ # 0, @@ -323,7 +323,7 @@ beginning of text" and "literal".</p> <a class="reference internal" href="commands/select.html#select-query"><span>query</span></a>. It uses the same regular expression as the previous example.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Logs --filter 'message @~ "\\\\Ahost1:"' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Logs --filter 'message @~ "\\\\Ahost1:"' # [ # [ # 0, @@ -369,7 +369,7 @@ require escape between you and Groonga. Here are steps that require <div><ul> <li><p class="first">Shell only when you pass Groonga command from command line the following:</p> -<div class="highlight-none"><div class="highlight"><pre>% groonga /tmp/db select Logs --filter '"message @~ \"\\\\Ahost1:"\"' +<div class="highlight-none"><div class="highlight"><pre><span></span>% groonga /tmp/db select Logs --filter '"message @~ \"\\\\Ahost1:"\"' </pre></div> </div> <p><code class="docutils literal"><span class="pre">--filter</span> <span class="pre">'"message</span> <span class="pre">@~</span> <span class="pre">\"\\\\Ahost1:\""'</span></code> is evaluated as the @@ -457,7 +457,7 @@ are regular expressions that match special character itself:</p> </ul> </div></blockquote> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Logs --filter 'message @~ "warning|info"' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Logs --filter 'message @~ "warning|info"' # [ # [ # 0, @@ -500,7 +500,7 @@ some special characters are used without escaping.</p> <p>Choice syntax is <code class="docutils literal"><span class="pre">A|B</span></code>. The regular expression matches when either <code class="docutils literal"><span class="pre">A</span></code> pattern or <code class="docutils literal"><span class="pre">B</span></code> pattern is matched.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Logs --filter 'message @~ "warning|info"' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Logs --filter 'message @~ "warning|info"' # [ # [ # 0, @@ -554,7 +554,7 @@ index.</p> syntax. For example, <code class="docutils literal"><span class="pre">e(r)\1o\1</span></code> matches <code class="docutils literal"><span class="pre">error</span></code>. Because <code class="docutils literal"><span class="pre">\1</span></code> is replaced with match result (<code class="docutils literal"><span class="pre">r</span></code>) of the first group <code class="docutils literal"><span class="pre">(r)</span></code>.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Logs --filter 'message @~ "e(r)\\\\1o\\\\1"' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Logs --filter 'message @~ "e(r)\\\\1o\\\\1"' # [ # [ # 0, @@ -600,7 +600,7 @@ details.</p> reduces choice syntax scope. The regular expression matches <code class="docutils literal"><span class="pre">[warning]</span></code> and <code class="docutils literal"><span class="pre">[info]</span></code>.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Logs --filter 'message @~ "\\\\[(warning|info)\\\\]"' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Logs --filter 'message @~ "\\\\[(warning|info)\\\\]"' # [ # [ # 0, @@ -650,7 +650,7 @@ index.</p> specify multiple characters to be matched.</p> <p>For example, <code class="docutils literal"><span class="pre">[12]</span></code> matches <code class="docutils literal"><span class="pre">1</span></code> or <code class="docutils literal"><span class="pre">2</span></code>.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Logs --filter 'message @~ "host[12]"' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Logs --filter 'message @~ "host[12]"' # [ # [ # 0, @@ -700,7 +700,7 @@ specify multiple characters to be matched.</p> <p>You can specify characters by range. For example, <code class="docutils literal"><span class="pre">[0-9]</span></code> matches one digit.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Logs --filter 'message @~ "[0-9][0-9]%"' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Logs --filter 'message @~ "[0-9][0-9]%"' # [ # [ # 0, @@ -777,7 +777,7 @@ can be evaluated by index.</p> </table> <p>Here is an example that uses <code class="docutils literal"><span class="pre">\z</span></code>.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Logs --filter 'message @~ "%\\\\z"' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Logs --filter 'message @~ "%\\\\z"' # [ # [ # 0, @@ -844,7 +844,7 @@ can't be evaluated by index.</p> </table> <p>For example, <code class="docutils literal"><span class="pre">er+or</span></code> matches <code class="docutils literal"><span class="pre">error</span></code>, <code class="docutils literal"><span class="pre">errror</span></code> and so on.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Logs --filter 'message @~ "er+or"' +<div class="highlight-none"><div class="highlight"><pre><span></span>select Logs --filter 'message @~ "er+or"' # [ # [ # 0, Modified: docs/reference/scorer.html (+12 -12) =================================================================== --- docs/reference/scorer.html 2016-03-05 15:09:34 +0900 (3c5ef3f) +++ docs/reference/scorer.html 2016-03-17 12:56:59 +0900 (d7942b3) @@ -125,7 +125,7 @@ able to use data type ("title" data are important rather than <p>Here are a schema definition and sample data to show usage.</p> <p>Sample schema:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Memos TABLE_HASH_KEY ShortText +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Memos TABLE_HASH_KEY ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] column_create Memos title COLUMN_SCALAR ShortText # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -143,7 +143,7 @@ column_create Terms content_index COLUMN_INDEX|WITH_POSITION Memos content </div> <p>Sample data:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>load --table Memos +<div class="highlight-none"><div class="highlight"><pre><span></span>load --table Memos [ { "_key": "memo1", @@ -188,25 +188,25 @@ column_create Terms content_index COLUMN_INDEX|WITH_POSITION Memos content There are some syntaxes.</p> <p>For score function that doesn't require any parameter such as <a class="reference internal" href="scorers/scorer_tf_idf.html"><em>scorer_tf_idf</em></a>:</p> -<div class="highlight-none"><div class="highlight"><pre>SCORE_FUNCTION(COLUMN) +<div class="highlight-none"><div class="highlight"><pre><span></span>SCORE_FUNCTION(COLUMN) </pre></div> </div> <p>You can specify weight:</p> -<div class="highlight-none"><div class="highlight"><pre>SCORE_FUNCTION(COLUMN) * WEIGHT +<div class="highlight-none"><div class="highlight"><pre><span></span>SCORE_FUNCTION(COLUMN) * WEIGHT </pre></div> </div> <p>For score function that requires one or more parameters such as <a class="reference internal" href="scorers/scorer_tf_at_most.html"><em>scorer_tf_at_most</em></a>:</p> -<div class="highlight-none"><div class="highlight"><pre>SCORE_FUNCTION(COLUMN, ARGUMENT1, ARGUMENT2, ...) +<div class="highlight-none"><div class="highlight"><pre><span></span>SCORE_FUNCTION(COLUMN, ARGUMENT1, ARGUMENT2, ...) </pre></div> </div> <p>You can specify weight:</p> -<div class="highlight-none"><div class="highlight"><pre>SCORE_FUNCTION(COLUMN, ARGUMENT1, ARGUMENT2, ...) * WEIGHT +<div class="highlight-none"><div class="highlight"><pre><span></span>SCORE_FUNCTION(COLUMN, ARGUMENT1, ARGUMENT2, ...) * WEIGHT </pre></div> </div> <p>You can use different score function for each <a class="reference internal" href="commands/select.html#select-match-columns"><span>match_columns</span></a>:</p> -<div class="highlight-none"><div class="highlight"><pre>SCORE_FUNCTION1(COLUMN1) || +<div class="highlight-none"><div class="highlight"><pre><span></span>SCORE_FUNCTION1(COLUMN1) || SCORE_FUNCTION2(COLUMN2) * WEIGHT || SCORE_FUNCTION3(COLUMN3, ARGUMENT1) || ... @@ -214,7 +214,7 @@ There are some syntaxes.</p> </div> <p>Here is a simplest example:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Memos \ +<div class="highlight-none"><div class="highlight"><pre><span></span>select Memos \ --match_columns "scorer_tf_idf(content)" \ --query "Groonga" \ --output_columns "content, _score" \ @@ -259,7 +259,7 @@ There are some syntaxes.</p> <code class="docutils literal"><span class="pre">select</span></code> command uses TF-IDF based scorer <code class="docutils literal"><span class="pre">scorer_tf_idf()</span></code>.</p> <p>Here is an example that uses weight:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Memos \ +<div class="highlight-none"><div class="highlight"><pre><span></span>select Memos \ --match_columns "scorer_tf_idf(content) * 10" \ --query "Groonga" \ --output_columns "content, _score" \ @@ -305,7 +305,7 @@ doesn't specify weight.</p> argument. <a class="reference internal" href="scorers/scorer_tf_at_most.html"><em>scorer_tf_at_most</em></a> scorer requires one argument. You can limit TF score by the scorer.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Memos \ +<div class="highlight-none"><div class="highlight"><pre><span></span>select Memos \ --match_columns "scorer_tf_at_most(content, 2.0)" \ --query "Groonga" \ --output_columns "content, _score" \ @@ -351,7 +351,7 @@ Because the scorer used in the <code class="docutils literal"><span class="pre"> score value to <code class="docutils literal"><span class="pre">2</span></code>.</p> <p>Here is an example that uses multiple scorers:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Memos \ +<div class="highlight-none"><div class="highlight"><pre><span></span>select Memos \ --match_columns "scorer_tf_idf(title) || scorer_tf_at_most(content, 2.0)" \ --query "Groonga" \ --output_columns "title, content, _score" \ @@ -402,7 +402,7 @@ score value to <code class="docutils literal"><span class="pre">2</span></code>. <code class="docutils literal"><span class="pre">--match_columns</span></code>. You can use the default scorer by just specifying a match column:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Memos \ +<div class="highlight-none"><div class="highlight"><pre><span></span>select Memos \ --match_columns "title || scorer_tf_at_most(content, 2.0)" \ --query "Groonga" \ --output_columns "title, content, _score" \ Modified: docs/reference/scorers/scorer_tf_at_most.html (+5 -5) =================================================================== --- docs/reference/scorers/scorer_tf_at_most.html 2016-03-05 15:09:34 +0900 (06247fd) +++ docs/reference/scorers/scorer_tf_at_most.html 2016-03-17 12:56:59 +0900 (10e033a) @@ -120,7 +120,7 @@ able to use data type ("title" data are important rather than <div class="section" id="syntax"> <h2>7.11.3.1.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> <p>This scorer has two parameters:</p> -<div class="highlight-none"><div class="highlight"><pre>scorer_tf_at_most(column, max) +<div class="highlight-none"><div class="highlight"><pre><span></span>scorer_tf_at_most(column, max) scorer_tf_at_most(index, max) </pre></div> </div> @@ -131,7 +131,7 @@ scorer_tf_at_most(index, max) <p>Here are a schema definition and sample data to show usage.</p> <p>Sample schema:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Logs TABLE_NO_KEY +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Logs TABLE_NO_KEY # [[0, 1337566253.89858, 0.000355720520019531], true] column_create Logs message COLUMN_SCALAR Text # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -145,7 +145,7 @@ column_create Terms message_index COLUMN_INDEX|WITH_POSITION Logs message </div> <p>Sample data:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>load --table Logs +<div class="highlight-none"><div class="highlight"><pre><span></span>load --table Logs [ {"message": "Notice"}, {"message": "Notice Notice"}, @@ -159,7 +159,7 @@ column_create Terms message_index COLUMN_INDEX|WITH_POSITION Logs message <p>You specify <code class="docutils literal"><span class="pre">scorer_tf_at_most</span></code> in <a class="reference internal" href="../commands/select.html#select-match-columns"><span>match_columns</span></a> like the following:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Logs \ +<div class="highlight-none"><div class="highlight"><pre><span></span>select Logs \ --match_columns "scorer_tf_at_most(message, 3.0)" \ --query "Notice" \ --output_columns "message, _score" \ @@ -232,7 +232,7 @@ Because the <code class="docutils literal"><span class="pre">select</span></code </div> <div class="section" id="optional-parameters"> <h3>7.11.3.1.4.2. Optional parameters<a class="headerlink" href="#optional-parameters" title="Permalink to this headline">¶</a></h3> -<p>There is no optional parameters.</p> +<p>There is no optional parameter.</p> </div> </div> <div class="section" id="return-value"> Modified: docs/reference/scorers/scorer_tf_idf.html (+5 -5) =================================================================== --- docs/reference/scorers/scorer_tf_idf.html 2016-03-05 15:09:34 +0900 (226db41) +++ docs/reference/scorers/scorer_tf_idf.html 2016-03-17 12:56:59 +0900 (7ba7d25) @@ -128,7 +128,7 @@ able to use data type ("title" data are important rather than <div class="section" id="syntax"> <h2>7.11.3.2.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> <p>This scorer has only one parameter:</p> -<div class="highlight-none"><div class="highlight"><pre>scorer_tf_idf(column) +<div class="highlight-none"><div class="highlight"><pre><span></span>scorer_tf_idf(column) scorer_tf_idf(index) </pre></div> </div> @@ -139,7 +139,7 @@ scorer_tf_idf(index) <p>Here are a schema definition and sample data to show usage.</p> <p>Sample schema:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Logs TABLE_NO_KEY +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Logs TABLE_NO_KEY # [[0, 1337566253.89858, 0.000355720520019531], true] column_create Logs message COLUMN_SCALAR Text # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -153,7 +153,7 @@ column_create Terms message_index COLUMN_INDEX|WITH_POSITION Logs message </div> <p>Sample data:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>load --table Logs +<div class="highlight-none"><div class="highlight"><pre><span></span>load --table Logs [ {"message": "Error"}, {"message": "Warning"}, @@ -175,7 +175,7 @@ column_create Terms message_index COLUMN_INDEX|WITH_POSITION Logs message <p>You specify <code class="docutils literal"><span class="pre">scorer_tf_idf</span></code> in <a class="reference internal" href="../commands/select.html#select-match-columns"><span>match_columns</span></a> like the following:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>select Logs \ +<div class="highlight-none"><div class="highlight"><pre><span></span>select Logs \ --match_columns "scorer_tf_idf(message)" \ --query "Error OR Info" \ --output_columns "message, _score" \ @@ -251,7 +251,7 @@ is important term.</p> </div> <div class="section" id="optional-parameters"> <h3>7.11.3.2.4.2. Optional parameters<a class="headerlink" href="#optional-parameters" title="Permalink to this headline">¶</a></h3> -<p>There is no optional parameters.</p> +<p>There is no optional parameter.</p> </div> </div> <div class="section" id="return-value"> Modified: docs/reference/sharding.html (+6 -6) =================================================================== --- docs/reference/sharding.html 2016-03-05 15:09:34 +0900 (fde8e07) +++ docs/reference/sharding.html 2016-03-17 12:56:59 +0900 (8231f56) @@ -26,7 +26,7 @@ <link rel="shortcut icon" href="../static/favicon.ico"/> <link rel="top" title="Groonga v6.0.0 documentation" href="../index.html" /> <link rel="up" title="7. Reference manual" href="../reference.html" /> - <link rel="next" title="7.3.30. logical_count" href="commands/logical_count.html" /> + <link rel="next" title="7.21. Log" href="log.html" /> <link rel="prev" title="7.19. Indexing" href="indexing.html" /> <meta property="fb:page_id" content="201193596592346" /><!-- groonga --> <meta property="fb:admins" content="664204556" /><!-- kouhei.sutou --> @@ -68,7 +68,7 @@ <a href="../genindex.html" title="General Index" accesskey="I">index</a></li> <li class="right" > - <a href="commands/logical_count.html" title="7.3.30. logical_count" + <a href="log.html" title="7.21. Log" accesskey="N">next</a> |</li> <li class="right" > <a href="indexing.html" title="7.19. Indexing" @@ -108,7 +108,7 @@ in mruby. You need to enable mruby when you build Groonga.</p> <p>You can confirm whether your Groonga supports mruby or not by <code class="docutils literal"><span class="pre">--version</span></code> command line argument of <a class="reference internal" href="executables/groonga.html"><em>groonga executable file</em></a>:</p> -<div class="highlight-none"><div class="highlight"><pre>% groonga --version +<div class="highlight-none"><div class="highlight"><pre><span></span>% groonga --version groonga 5.0.5 [...,mruby,...] configure options: <...> @@ -205,8 +205,8 @@ name and <code class="docutils literal"><span class="pre">20150814</span></code> <p class="topless"><a href="indexing.html" title="previous chapter">7.19. Indexing</a></p> <h4>Next topic</h4> - <p class="topless"><a href="commands/logical_count.html" - title="next chapter">7.3.30. <code class="docutils literal"><span class="pre">logical_count</span></code></a></p> + <p class="topless"><a href="log.html" + title="next chapter">7.21. Log</a></p> <div role="note" aria-label="source link"> <h3>This Page</h3> <ul class="this-page-menu"> @@ -238,7 +238,7 @@ name and <code class="docutils literal"><span class="pre">20150814</span></code> <a href="../genindex.html" title="General Index" >index</a></li> <li class="right" > - <a href="commands/logical_count.html" title="7.3.30. logical_count" + <a href="log.html" title="7.21. Log" >next</a> |</li> <li class="right" > <a href="indexing.html" title="7.19. Indexing" Modified: docs/reference/suggest/completion.html (+7 -7) =================================================================== --- docs/reference/suggest/completion.html 2016-03-05 15:09:34 +0900 (067dd49) +++ docs/reference/suggest/completion.html 2016-03-17 12:56:59 +0900 (870994e) @@ -259,7 +259,7 @@ completion. <code class="docutils literal"><span class="pre">--type</span> <span <p>For example, here is an command to get completion results by "en":</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>suggest --table item_query --column kana --types complete --frequency_threshold 1 --query en +<div class="highlight-none"><div class="highlight"><pre><span></span>suggest --table item_query --column kana --types complete --frequency_threshold 1 --query en # [ # [ # 0, @@ -311,7 +311,7 @@ inputs the query with the following sequence:</p> </div></blockquote> <p>Groonga can be learned from the input sequence by the following command:</p> -<div class="highlight-none"><div class="highlight"><pre>load --table event_query --each 'suggest_preparer(_id, type, item, sequence, time, pair_query)' +<div class="highlight-none"><div class="highlight"><pre><span></span>load --table event_query --each 'suggest_preparer(_id, type, item, sequence, time, pair_query)' [ {"sequence": "1", "time": 1312950803.86057, "item": "e"}, {"sequence": "1", "time": 1312950803.96857, "item": "en"}, @@ -329,7 +329,7 @@ following command:</p> search. This section describes how to register a word and its reading.</p> <p>Here is an example to register "日本" which means Japan in English:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>load --table event_query --each 'suggest_preparer(_id, type, item, sequence, time, pair_query)' +<div class="highlight-none"><div class="highlight"><pre><span></span>load --table event_query --each 'suggest_preparer(_id, type, item, sequence, time, pair_query)' [ {"sequence": "1", "time": 1312950805.86058, "item": "日本", "type": "submit"} ] @@ -338,7 +338,7 @@ search. This section describes how to register a word and its reading.</p> </div> <p>Here is an example to update reading data to complete "日本":</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>load --table item_query +<div class="highlight-none"><div class="highlight"><pre><span></span>load --table item_query [ {"_key":"日本", "kana":["ニホン", "ニッポン"]} ] @@ -348,7 +348,7 @@ search. This section describes how to register a word and its reading.</p> <p>Then you can complete registered word "日本" by Romaji input - "nihon".</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>suggest --table item_query --column kana --types complete --frequency_threshold 1 --query nihon +<div class="highlight-none"><div class="highlight"><pre><span></span>suggest --table item_query --column kana --types complete --frequency_threshold 1 --query nihon # [ # [ # 0, @@ -387,7 +387,7 @@ search. This section describes how to register a word and its reading.</p> <p>This is the reason that you can also complete the registered word "日本" by query - "nippon".</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>suggest --table item_query --column kana --types complete --frequency_threshold 1 --query nippon +<div class="highlight-none"><div class="highlight"><pre><span></span>suggest --table item_query --column kana --types complete --frequency_threshold 1 --query nippon # [ # [ # 0, @@ -425,7 +425,7 @@ customize priority to set the value of <code class="docutils literal"><span clas <code class="docutils literal"><span class="pre">item_query</span></code> table.</p> <p>Here is an example to customize priority for prefix RK search:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>load --table event_query --each 'suggest_preparer(_id, type, item, sequence, time, pair_query)' +<div class="highlight-none"><div class="highlight"><pre><span></span>load --table event_query --each 'suggest_preparer(_id, type, item, sequence, time, pair_query)' [ {"sequence": "1", "time": 1312950805.86059, "item": "日本語", "type": "submit"} {"sequence": "1", "time": 1312950805.86060, "item": "日本人", "type": "submit"} Modified: docs/reference/suggest/correction.html (+2 -2) =================================================================== --- docs/reference/suggest/correction.html 2016-03-05 15:09:34 +0900 (93da94f) +++ docs/reference/suggest/correction.html 2016-03-17 12:56:59 +0900 (92ecbf1) @@ -184,7 +184,7 @@ correction. <cite>--type correct</cite> option requests corrections.</p> <p>For example, here is an command to get correction results by "saerch":</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>suggest --table item_query --column kana --types correction --frequency_threshold 1 --query saerch +<div class="highlight-none"><div class="highlight"><pre><span></span>suggest --table item_query --column kana --types correction --frequency_threshold 1 --query saerch # [ # [ # 0, @@ -238,7 +238,7 @@ user inputs the query with the following sequence:</p> </div></blockquote> <p>Groonga can be learned from the input sequence by the following command:</p> -<div class="highlight-none"><div class="highlight"><pre>load --table event_query --each 'suggest_preparer(_id, type, item, sequence, time, pair_query)' +<div class="highlight-none"><div class="highlight"><pre><span></span>load --table event_query --each 'suggest_preparer(_id, type, item, sequence, time, pair_query)' [ {"sequence": "1", "time": 1312950803.86057, "item": "s"}, {"sequence": "1", "time": 1312950803.96857, "item": "sa"}, Modified: docs/reference/suggest/suggestion.html (+3 -3) =================================================================== --- docs/reference/suggest/suggestion.html 2016-03-05 15:09:34 +0900 (d85eb13) +++ docs/reference/suggest/suggestion.html 2016-03-17 12:56:59 +0900 (477cf7c) @@ -176,7 +176,7 @@ suggestion. <cite>--type suggest</cite> option requests suggestion</p> <p>For example, here is an command to get suggestion results by "search":</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>suggest --table item_query --column kana --types suggest --frequency_threshold 1 --query search +<div class="highlight-none"><div class="highlight"><pre><span></span>suggest --table item_query --column kana --types suggest --frequency_threshold 1 --query search # [ # [ # 0, @@ -228,7 +228,7 @@ inputs the query with the following sequence:</p> </div></blockquote> <p>Groonga can be learned from the submissions by the following command:</p> -<div class="highlight-none"><div class="highlight"><pre>load --table event_query --each 'suggest_preparer(_id, type, item, sequence, time, pair_query)' +<div class="highlight-none"><div class="highlight"><pre><span></span>load --table event_query --each 'suggest_preparer(_id, type, item, sequence, time, pair_query)' [ {"sequence": "1", "time": 1312950803.86057, "item": "search engine", "type": "submit"}, {"sequence": "1", "time": 1312950808.86057, "item": "web search realtime", "type": "submit"} @@ -241,7 +241,7 @@ following command:</p> <p>The learning data is stored into item_DATASET and pair_DATASET tables. By using select command for such tables, you can all extract learing data.</p> <p>Here is the query to extract all learning data:</p> -<div class="highlight-none"><div class="highlight"><pre>select item_DATASET --limit -1 +<div class="highlight-none"><div class="highlight"><pre><span></span>select item_DATASET --limit -1 select pair_DATASET --filter 'freq0 > 0 || freq1 > 0 || freq2 > 0' --limit -1 </pre></div> </div> Modified: docs/reference/token_filters.html (+3 -3) =================================================================== --- docs/reference/token_filters.html 2016-03-05 15:09:34 +0900 (a2b5aa4) +++ docs/reference/token_filters.html 2016-03-17 12:56:59 +0900 (c3d2a70) @@ -96,7 +96,7 @@ filters to a table by <a class="reference internal" href="commands/table_create. <p>Here is an example <code class="docutils literal"><span class="pre">table_create</span></code> that uses <code class="docutils literal"><span class="pre">TokenFilterStopWord</span></code> token filter module:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>register token_filters/stop_word +<div class="highlight-none"><div class="highlight"><pre><span></span>register token_filters/stop_word # [[0, 1337566253.89858, 0.000355720520019531], true] table_create Terms TABLE_PAT_KEY ShortText \ --default_tokenizer TokenBigram \ @@ -122,7 +122,7 @@ documents because it removes token in searching the documents.</p> <p>The stop word is specified <code class="docutils literal"><span class="pre">is_stop_word</span></code> column on lexicon table.</p> <p>Here is an example that uses <code class="docutils literal"><span class="pre">TokenFilterStopWord</span></code> token filter:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>register token_filters/stop_word +<div class="highlight-none"><div class="highlight"><pre><span></span>register token_filters/stop_word # [[0, 1337566253.89858, 0.000355720520019531], true] table_create Memos TABLE_NO_KEY # [[0, 1337566253.89858, 0.000355720520019531], true] @@ -193,7 +193,7 @@ select Memos --match_columns content --query "Hello and" <p><code class="docutils literal"><span class="pre">TokenFilterStem</span></code> stems tokenized token.</p> <p>Here is an example that uses <code class="docutils literal"><span class="pre">TokenFilterStem</span></code> token filter:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>register token_filters/stem +<div class="highlight-none"><div class="highlight"><pre><span></span>register token_filters/stem # [[0, 1337566253.89858, 0.000355720520019531], true] table_create Memos TABLE_NO_KEY # [[0, 1337566253.89858, 0.000355720520019531], true] Modified: docs/reference/tokenizers.html (+22 -22) =================================================================== --- docs/reference/tokenizers.html 2016-03-05 15:09:34 +0900 (8e6364d) +++ docs/reference/tokenizers.html 2016-03-17 12:56:59 +0900 (8ff3f2b) @@ -116,7 +116,7 @@ know much about tokenizer, it's recommended that you choose try <a class="reference internal" href="#token-bigram"><span>TokenBigram</span></a> tokenizer by <a class="reference internal" href="commands/tokenize.html"><em>tokenize</em></a>:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>tokenize TokenBigram "Hello World" +<div class="highlight-none"><div class="highlight"><pre><span></span>tokenize TokenBigram "Hello World" # [ # [ # 0, @@ -287,7 +287,7 @@ described in the below.</p> <p>If no normalizer is used, <code class="docutils literal"><span class="pre">TokenBigram</span></code> uses pure bigram (all tokens except the last token have two characters) tokenize method:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>tokenize TokenBigram "Hello World" +<div class="highlight-none"><div class="highlight"><pre><span></span>tokenize TokenBigram "Hello World" # [ # [ # 0, @@ -373,7 +373,7 @@ word separator. Bigram tokenize method is suitable for the case.</p> <p><code class="docutils literal"><span class="pre">TokenBigram</span></code> uses one or more white-spaces as token delimiter for ASCII characters:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>tokenize TokenBigram "Hello World" NormalizerAuto +<div class="highlight-none"><div class="highlight"><pre><span></span>tokenize TokenBigram "Hello World" NormalizerAuto # [ # [ # 0, @@ -416,7 +416,7 @@ ASCII characters. Character type is one of them:</p> </ul> </div></blockquote> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>tokenize TokenBigram "100cents!!!" NormalizerAuto +<div class="highlight-none"><div class="highlight"><pre><span></span>tokenize TokenBigram "100cents!!!" NormalizerAuto # [ # [ # 0, @@ -446,7 +446,7 @@ ASCII characters. Character type is one of them:</p> <p>Here is an example that <code class="docutils literal"><span class="pre">TokenBigram</span></code> uses bigram tokenize method for non-ASCII characters.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>tokenize TokenBigram "日本語の勉強" NormalizerAuto +<div class="highlight-none"><div class="highlight"><pre><span></span>tokenize TokenBigram "日本語の勉強" NormalizerAuto # [ # [ # 0, @@ -495,7 +495,7 @@ for non-ASCII characters.</p> difference between them is symbol handling. <code class="docutils literal"><span class="pre">TokenBigramSplitSymbol</span></code> tokenizes symbols by bigram tokenize method:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>tokenize TokenBigramSplitSymbol "100cents!!!" NormalizerAuto +<div class="highlight-none"><div class="highlight"><pre><span></span>tokenize TokenBigramSplitSymbol "100cents!!!" NormalizerAuto # [ # [ # 0, @@ -540,7 +540,7 @@ difference between them is symbol and alphabet handling. <code class="docutils literal"><span class="pre">TokenBigramSplitSymbolAlpha</span></code> tokenizes symbols and alphabets by bigram tokenize method:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>tokenize TokenBigramSplitSymbolAlpha "100cents!!!" NormalizerAuto +<div class="highlight-none"><div class="highlight"><pre><span></span>tokenize TokenBigramSplitSymbolAlpha "100cents!!!" NormalizerAuto # [ # [ # 0, @@ -606,7 +606,7 @@ and digit handling. <code class="docutils literal"><span class="pre">TokenBigram symbols, alphabets and digits by bigram tokenize method. It means that all characters are tokenized by bigram tokenize method:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>tokenize TokenBigramSplitSymbolAlphaDigit "100cents!!!" NormalizerAuto +<div class="highlight-none"><div class="highlight"><pre><span></span>tokenize TokenBigramSplitSymbolAlphaDigit "100cents!!!" NormalizerAuto # [ # [ # 0, @@ -683,7 +683,7 @@ ignores white-spaces in continuous symbols and non-ASCII characters.</p> has symbols and non-ASCII characters.</p> <p>Here is a result by <a class="reference internal" href="#token-bigram"><span>TokenBigram</span></a> :</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>tokenize TokenBigram "日 本 語 ! ! !" NormalizerAuto +<div class="highlight-none"><div class="highlight"><pre><span></span>tokenize TokenBigram "日 本 語 ! ! !" NormalizerAuto # [ # [ # 0, @@ -727,7 +727,7 @@ has symbols and non-ASCII characters.</p> </div> <p>Here is a result by <code class="docutils literal"><span class="pre">TokenBigramIgnoreBlank</span></code>:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>tokenize TokenBigramIgnoreBlank "日 本 語 ! ! !" NormalizerAuto +<div class="highlight-none"><div class="highlight"><pre><span></span>tokenize TokenBigramIgnoreBlank "日 本 語 ! ! !" NormalizerAuto # [ # [ # 0, @@ -778,7 +778,7 @@ tokenize method.</p> has symbols and non-ASCII characters.</p> <p>Here is a result by <a class="reference internal" href="#token-bigram"><span>TokenBigram</span></a> :</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>tokenize TokenBigram "日 本 語 ! ! !" NormalizerAuto +<div class="highlight-none"><div class="highlight"><pre><span></span>tokenize TokenBigram "日 本 語 ! ! !" NormalizerAuto # [ # [ # 0, @@ -822,7 +822,7 @@ has symbols and non-ASCII characters.</p> </div> <p>Here is a result by <code class="docutils literal"><span class="pre">TokenBigramIgnoreBlankSplitSymbol</span></code>:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>tokenize TokenBigramIgnoreBlankSplitSymbol "日 本 語 ! ! !" NormalizerAuto +<div class="highlight-none"><div class="highlight"><pre><span></span>tokenize TokenBigramIgnoreBlankSplitSymbol "日 本 語 ! ! !" NormalizerAuto # [ # [ # 0, @@ -883,7 +883,7 @@ alphabets by bigram tokenize method.</p> has symbols and non-ASCII characters with white spaces and alphabets.</p> <p>Here is a result by <a class="reference internal" href="#token-bigram"><span>TokenBigram</span></a> :</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>tokenize TokenBigram "Hello 日 本 語 ! ! !" NormalizerAuto +<div class="highlight-none"><div class="highlight"><pre><span></span>tokenize TokenBigram "Hello 日 本 語 ! ! !" NormalizerAuto # [ # [ # 0, @@ -932,7 +932,7 @@ has symbols and non-ASCII characters with white spaces and alphabets.</p> </div> <p>Here is a result by <code class="docutils literal"><span class="pre">TokenBigramIgnoreBlankSplitSymbolAlpha</span></code>:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>tokenize TokenBigramIgnoreBlankSplitSymbolAlpha "Hello 日 本 語 ! ! !" NormalizerAuto +<div class="highlight-none"><div class="highlight"><pre><span></span>tokenize TokenBigramIgnoreBlankSplitSymbolAlpha "Hello 日 本 語 ! ! !" NormalizerAuto # [ # [ # 0, @@ -1020,7 +1020,7 @@ because it has symbols and non-ASCII characters with white spaces, alphabets and digits.</p> <p>Here is a result by <a class="reference internal" href="#token-bigram"><span>TokenBigram</span></a> :</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>tokenize TokenBigram "Hello 日 本 語 ! ! ! 777" NormalizerAuto +<div class="highlight-none"><div class="highlight"><pre><span></span>tokenize TokenBigram "Hello 日 本 語 ! ! ! 777" NormalizerAuto # [ # [ # 0, @@ -1074,7 +1074,7 @@ alphabets and digits.</p> </div> <p>Here is a result by <code class="docutils literal"><span class="pre">TokenBigramIgnoreBlankSplitSymbolAlphaDigit</span></code>:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>tokenize TokenBigramIgnoreBlankSplitSymbolAlphaDigit "Hello 日 本 語 ! ! ! 777" NormalizerAuto +<div class="highlight-none"><div class="highlight"><pre><span></span>tokenize TokenBigramIgnoreBlankSplitSymbolAlphaDigit "Hello 日 本 語 ! ! ! 777" NormalizerAuto # [ # [ # 0, @@ -1163,7 +1163,7 @@ alphabets and digits.</p> between them is token unit. <a class="reference internal" href="#token-bigram"><span>TokenBigram</span></a> uses 2 characters per token. <code class="docutils literal"><span class="pre">TokenUnigram</span></code> uses 1 character per token.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>tokenize TokenUnigram "100cents!!!" NormalizerAuto +<div class="highlight-none"><div class="highlight"><pre><span></span>tokenize TokenUnigram "100cents!!!" NormalizerAuto # [ # [ # 0, @@ -1197,7 +1197,7 @@ token. <code class="docutils literal"><span class="pre">TokenUnigram</span></cod between them is token unit. <a class="reference internal" href="#token-bigram"><span>TokenBigram</span></a> uses 2 characters per token. <code class="docutils literal"><span class="pre">TokenTrigram</span></code> uses 3 characters per token.</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>tokenize TokenTrigram "10000cents!!!!!" NormalizerAuto +<div class="highlight-none"><div class="highlight"><pre><span></span>tokenize TokenTrigram "10000cents!!!!!" NormalizerAuto # [ # [ # 0, @@ -1235,7 +1235,7 @@ and <code class="docutils literal"><span class="pre">full-text-search</span></co <span class="pre">full-text-search</span> <span class="pre">http</span></code>.</p> <p>Here is an example of <code class="docutils literal"><span class="pre">TokenDelimit</span></code>:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>tokenize TokenDelimit "Groonga full-text-search HTTP" NormalizerAuto +<div class="highlight-none"><div class="highlight"><pre><span></span>tokenize TokenDelimit "Groonga full-text-search HTTP" NormalizerAuto # [ # [ # 0, @@ -1272,7 +1272,7 @@ character (<code class="docutils literal"><span class="pre">U+0000</span></code> <p><code class="docutils literal"><span class="pre">TokenDelimitNull</span></code> is also suitable for tag text.</p> <p>Here is an example of <code class="docutils literal"><span class="pre">TokenDelimitNull</span></code>:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>tokenize TokenDelimitNull "Groonga\u0000full-text-search\u0000HTTP" NormalizerAuto +<div class="highlight-none"><div class="highlight"><pre><span></span>tokenize TokenDelimitNull "Groonga\u0000full-text-search\u0000HTTP" NormalizerAuto # [ # [ # 0, @@ -1309,7 +1309,7 @@ dictionary.) <a class="reference external" href="https://github.com/neologd/meca <p>Here is an example of <code class="docutils literal"><span class="pre">TokenMeCab</span></code>. <code class="docutils literal"><span class="pre">東京都</span></code> is tokenized to <code class="docutils literal"><span class="pre">東京</span></code> and <code class="docutils literal"><span class="pre">都</span></code>. They don't include <code class="docutils literal"><span class="pre">京都</span></code>:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>tokenize TokenMecab "東京都" +<div class="highlight-none"><div class="highlight"><pre><span></span>tokenize TokenMecab "東京都" # [ # [ # 0, @@ -1363,7 +1363,7 @@ adds the beginning of text mark (<code class="docutils literal"><span class="pre and the end of text mark (<code class="docutils literal"><span class="pre">U+FFF0</span></code>) to the end of text when you index text:</p> <p>Execution example:</p> -<div class="highlight-none"><div class="highlight"><pre>tokenize TokenRegexp "/home/alice/test.txt" NormalizerAuto --mode ADD +<div class="highlight-none"><div class="highlight"><pre><span></span>tokenize TokenRegexp "/home/alice/test.txt" NormalizerAuto --mode ADD # [ # [ # 0, Modified: docs/reference/tuning.html (+10 -10) =================================================================== --- docs/reference/tuning.html 2016-03-05 15:09:34 +0900 (709a2f5) +++ docs/reference/tuning.html 2016-03-17 12:56:59 +0900 (948a092) @@ -102,7 +102,7 @@ many files.</p> relax the limitation.</p> <p>Here is an expression that compute how many files are opened by Groonga:</p> -<div class="highlight-none"><div class="highlight"><pre>3 (for DB) + +<div class="highlight-none"><div class="highlight"><pre><span></span>3 (for DB) + N tables + N columns (except index clumns) + (N index columns * 2) + @@ -110,7 +110,7 @@ Groonga:</p> </pre></div> </div> <p>Here is an example schema:</p> -<div class="highlight-none"><div class="highlight"><pre>table_create Entries TABLE_HASH_KEY ShortText +<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Entries TABLE_HASH_KEY ShortText column_create Entries content COLUMN_SCALAR Text column_create Entries n_likes COLUMN_SCALAR UInt32 table_create Terms TABLE_PAT_KEY ShortText --default_tokenizer TokenBigram --normalizer NormalizerAuto @@ -119,7 +119,7 @@ column_create Terms entries_content_index COLUMN_INDEX|WITH_POSITION Entries con </pre></div> </div> <p>This example opens at least 11 files:</p> -<div class="highlight-none"><div class="highlight"><pre>3 + +<div class="highlight-none"><div class="highlight"><pre><span></span>3 + 2 (Entries and Terms) + 2 (Entries.content and Entries.n_likes) + 4 (Terms.entries_key_index and Terms.entries_content_index) + @@ -151,14 +151,14 @@ than database size.</p> <p>You can relax the <a class="reference internal" href="#tuning-max-n-open-files"><span>The max number of open files per process</span></a> parameter by creating a configuration file <code class="docutils literal"><span class="pre">/etc/security/limits.d/groonga.conf</span></code> that has the following content:</p> -<div class="highlight-none"><div class="highlight"><pre>${USER} soft nofile ${MAX_VALUE} +<div class="highlight-none"><div class="highlight"><pre><span></span>${USER} soft nofile ${MAX_VALUE} ${USER} hard nofile ${MAX_VALUE} </pre></div> </div> <p>If you run Groonga process by <code class="docutils literal"><span class="pre">groonga</span></code> user and your Groonga process needs to open less than 10000 files, use the following configuration:</p> -<div class="highlight-none"><div class="highlight"><pre>groonga soft nofile 10000 +<div class="highlight-none"><div class="highlight"><pre><span></span>groonga soft nofile 10000 groonga hard nofile 10000 </pre></div> </div> @@ -176,12 +176,12 @@ the configuration.</p> about <code class="docutils literal"><span class="pre">vm.overcommit_memory</span></code> parameter details.</p> <p>You can set the configuration by putting a configuration file <code class="docutils literal"><span class="pre">/etc/sysctl.d/groonga.conf</span></code> that has the following content:</p> -<div class="highlight-none"><div class="highlight"><pre>vm.overcommit_memory = 1 +<div class="highlight-none"><div class="highlight"><pre><span></span>vm.overcommit_memory = 1 </pre></div> </div> <p>The configuration can be applied by restarting your system or run the following command:</p> -<div class="highlight-none"><div class="highlight"><pre>% sudo sysctl --system +<div class="highlight-none"><div class="highlight"><pre><span></span>% sudo sysctl --system </pre></div> </div> </div> @@ -199,18 +199,18 @@ limitation. (<code class="docutils literal"><span class="pre">256KiB</span> <spa 32GiB size database by <code class="docutils literal"><span class="pre">65536</span> <span class="pre">*</span> <span class="pre">2</span> <span class="pre">=</span> <span class="pre">131072</span></code>. You can set the configuration by putting a configuration file <code class="docutils literal"><span class="pre">/etc/sysctl.d/groonga.conf</span></code> that has the following content:</p> -<div class="highlight-none"><div class="highlight"><pre>vm.max_map_count = 131072 +<div class="highlight-none"><div class="highlight"><pre><span></span>vm.max_map_count = 131072 </pre></div> </div> <p>Note that your real configuration file will be the following because you already have <code class="docutils literal"><span class="pre">vm.overcommit_memory</span></code> configuration:</p> -<div class="highlight-none"><div class="highlight"><pre>vm.overcommit_memory = 1 +<div class="highlight-none"><div class="highlight"><pre><span></span>vm.overcommit_memory = 1 vm.max_map_count = 131072 </pre></div> </div> <p>The configuration can be applied by restarting your system or run the following command:</p> -<div class="highlight-none"><div class="highlight"><pre>% sudo sysctl -p +<div class="highlight-none"><div class="highlight"><pre><span></span>% sudo sysctl -p </pre></div> </div> </div> Modified: docs/reference/types.html (+1 -1) =================================================================== --- docs/reference/types.html 2016-03-05 15:09:34 +0900 (3bc3b7e) +++ docs/reference/types.html 2016-03-17 12:56:59 +0900 (560a642) @@ -92,7 +92,7 @@ <div class="section" id="description"> <h2>7.4.2. Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2> <p>Groonga identifies data types to store.</p> -<p>A primary key of table and column value belong to some kind of data types in Groonga database. And normaly, column values become in common with all records in one table.</p> +<p>A primary key of table and column value belong to some kind of data types in Groonga database. And normally, column values become in common with all records in one table.</p> <p>A primary key type and column type can be specified Groonga defined types, user defined types or user defined table.</p> <p>If you specify other table to primary key type, this table becomes subset of the table of primary key type.</p> <p>If you specify other table to column type, this column becomes reference key of the table of column type.</p> Modified: docs/searchindex.js (+1 -1) =================================================================== --- docs/searchindex.js 2016-03-05 15:09:34 +0900 (218885b) +++ docs/searchindex.js 2016-03-17 12:56:59 +0900 (1fa7fa4) @@ -1 +1 @@ ... truncated to 1.0MB
