rroonga 4.0.3-x86-mingw32 → 4.0.4-x86-mingw32

data/vendor/local/share/doc/groonga/en/html/_sources/reference/commands/tokenize.txt

@@ -25,6 +25,7 @@ optional::
            string
            [normalizer=null]
            [flags=NONE]
+           [mode=ADD]
 
 Usage
 -----
@@ -163,6 +164,32 @@ string. So the character is good character for this puropose. If
 treated as already tokenized string. Tokenizer just tokenizes by
 tokenized delimiter.
 
+``mode``
+""""""""
+
+It specifies a tokenize mode. If the mode is specified ``ADD``, the text
+is tokenized by the rule that adding a document. If the mode is specified
+``GET``, the text is tokenized by the rule that searching a document. If
+the mode is omitted, the text is tokenized by the ``ADD`` mode.
+
+The default mode is ``ADD``.
+
+Here is an example to the ``ADD`` mode.
+
+.. groonga-command
+.. include:: ../../example/reference/commands/tokenize/add_mode.log
+.. tokenize TokenBigram "Fulltext Search" --mode ADD
+
+The last alphabet is tokenized by one character.
+
+Here is an example to the ``GET`` mode.
+
+.. groonga-command
+.. include:: ../../example/reference/commands/tokenize/get_mode.log
+.. tokenize TokenBigram "Fulltext Search" --mode GET
+
+The last alphabet is tokenized by two characters.
+
 Return value
 ------------
 

data/vendor/local/share/doc/groonga/en/html/_sources/reference/commands/tokenizer_list.txt

@@ -39,15 +39,15 @@ Return value
 ``tokenizer_list`` command returns tokenizers. Each tokenizers has an attribute
 that contains the name. The attribute will be increased in the feature::
 
-  [HEADER, tokenizer]
+  [HEADER, tokenizers]
 
 ``HEADER``
 
   See :doc:`/reference/command/output_format` about ``HEADER``.
 
-``tokenizer``
+``tokenizers``
 
-  ``tokenizer`` is an array of tokenizer. Tokenizer is an object that has the following
+  ``tokenizers`` is an array of tokenizer. Tokenizer is an object that has the following
   attributes.
 
   .. list-table::

data/vendor/local/share/doc/groonga/en/html/_sources/reference/executables/groonga-benchmark.txt

@@ -97,7 +97,7 @@ groonga-benchmark用のデータファイルは自分で作成することも既
 groonga-benchmark命令
 ^^^^^^^^^^^^^^^^^^^^^
 
-現在サポートされているgroonga-benchmark命令は以下の8つです。
+現在サポートされているgroonga-benchmark命令は以下の11種類です。
 
   do_local コマンドファイル [スレッド数] [繰り返し数]
 
@@ -105,7 +105,11 @@ groonga-benchmark命令
 
   do_gqpt コマンドファイル [スレッド数] [繰り返し数]
 
-    コマンドファイルをgroongaサーバで実行します。スレッド数や繰り返し数の意味はdo_localの場合と同じです。
+    コマンドファイルをgroongaサーバでGQTP経由で実行します。スレッド数や繰り返し数の意味はdo_localの場合と同じです。
+
+  do_http コマンドファイル [スレッド数] [繰り返し数]
+
+    コマンドファイルをgroongaサーバでHTTP経由で実行します。スレッド数や繰り返し数の意味はdo_localの場合と同じです。
 
   rep_local コマンドファイル [スレッド数] [繰り返し数]
 
@@ -113,7 +117,11 @@ groonga-benchmark命令
 
   rep_gqpt コマンドファイル [スレッド数] [繰り返し数]
 
-    コマンドファイルをgroongaサーバで実行し、より詳細な報告を行います。 スレッド数や繰り返し数の意味はdo_localと 同じです。
+    コマンドファイルをgroongaサーバでGQTP経由で実行し、より詳細な報告を行います。 スレッド数や繰り返し数の意味はdo_localと 同じです。
+
+  rep_http コマンドファイル [スレッド数] [繰り返し数]
+
+    コマンドファイルをgroongaサーバでHTTP経由で実行し、より詳細な報告を行います。 スレッド数や繰り返し数の意味はdo_localと 同じです。
 
   out_local コマンドファイル 入力ファイル名
 
@@ -125,7 +133,11 @@ groonga-benchmark命令
 
   out_gqtp コマンドファイル 出力ファイル名
 
-    コマンドファイルをgroongaサーバで実行します。その他はout_local命令と同等です。
+    コマンドファイルをgroongaサーバでGQTP経由で実行します。その他はout_local命令と同等です。
+
+  out_http コマンドファイル 出力ファイル名
+
+    コマンドファイルをgroongaサーバでHTTP経由で実行します。その他はout_local命令と同等です。
 
   test_local コマンドファイル 入力ファイル名
     コマンドファイルをgroonga-benchmark単体で実行し、各コマンドの実行結果を入力ファイルと比較します。処理時間など本質的要素以外に差分があった場合、差分を、入力ファイル.diffというファイルに書きだします。
@@ -152,7 +164,7 @@ groonga-benchmark命令
   1行目
     コメント行。
   2行目
-    test.dll というコマンドファイルをgroonga単体で実行し、詳細に報告する。
+    test.ddl というコマンドファイルをgroonga単体で実行し、詳細に報告する。
   3行目
     test.load というコマンドファイルをgroonga単体で実行する。(最後の";"セミコロンは複数のgroonga-benchmark命令を記述する場合に必要ですが、この例のように1つのgroonga-benchmark命令を実行する場合に付与しても問題ありません。)
   4行目

data/vendor/local/share/doc/groonga/en/html/_sources/reference/executables/groonga-suggest-learner.txt

@@ -45,21 +45,30 @@ Here is the sample to load log data under ``logs`` directory::
 Options
 -------
 
-.. cmdoption:: -r
+.. cmdoption:: -r <endpoint>, --receive-endpoint <endpoint>
 
-   Specify endpoint for receiver.
+   Uses ``<endpoint>`` as the receiver endpoint.
 
-.. cmdoption:: -s
+.. cmdoption:: -s <endpoint>, --send-endpoint <endpoint>
 
-   Specify endpoint for sender.
+   Uses ``<endpoint>`` as the sender endpoint.
 
-.. cmdoption:: -d
+.. cmdoption:: -d, --daemon
 
-   Specify this option to daemonize.
+   Runs as a daemon.
 
-.. cmdoption:: -l
+.. cmdoption:: -l <directory>, --log-base-path <directory>
 
-   Specify log directory.
+   Reads logs from ``<directory>``.
+
+.. cmdoption:: --log-path <path>
+
+   Outputs log to ``<path>``.
+
+.. cmdoption:: --log-level <level>
+
+   Uses ``<level>`` for log level. ``<level>`` must be between 1 and 9.
+   Larger level outputs more logs.
 
 Parameters
 ----------

data/vendor/local/share/doc/groonga/en/html/_sources/reference/executables/groonga.txt

@@ -64,7 +64,7 @@ Groongaのデータベースは、groongaコマンドかCライブラリイン
 .. cmdoption:: -p, --port <port number>
 
    クライアント、サーバ、またはデーモンモードで使用するTCPポート番号。
-   (デフォルトは10041番)
+   (クライアントモードのデフォルトは10043番、サーバ、またはデーモンモードのデフォルトは、HTTPの場合、10041番、GQTPの場合、10043番)
 
 .. cmdoption:: -i, --server-id <ip/hostname>
 
@@ -132,7 +132,7 @@ Groongaのデータベースは、groongaコマンドかCライブラリイン
 
    使用するデータベースのパス名を指定します。
 
-   クライアントモードの場合は接続先のホスト名とポート番号を指定します(デフォルト値は'localhost:10041')。ポート番号を指定しない場合には、10041が指定されたものとします。
+   クライアントモードの場合は接続先のホスト名とポート番号を指定します(デフォルト値は'localhost:10043')。ポート番号を指定しない場合には、10043が指定されたものとします。
 
 .. cmdoption:: command [args]
 

data/vendor/local/share/doc/groonga/en/html/_sources/reference/functions/highlight_full.txt

@@ -0,0 +1,132 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+.. groonga-command
+.. database: functions_highlight_full
+
+highlight_full
+==============
+
+.. caution::
+
+   This feature is experimental. API will be changed.
+
+Summary
+-------
+
+``highlight_full`` tags target text. It can use to highlight the search
+keyword. It can specify use/not use HTML escape, the normalizer name and
+change the tag for each keyword.
+
+Syntax
+------
+
+``highlight_full`` has required parameter and optional parameter::
+
+  highlight_full(column, normalizer_name, use_html_escape,
+                 keyword1, open_tag1, close_tag1,
+                 ...
+                 [keywordN, open_tagN, close_tagN])
+
+Usage
+-----
+
+Here are a schema definition and sample data to show usage.
+
+.. groonga-command
+.. include:: ../../example/reference/functions/highlight_full/usage_setup.log
+.. table_create Entries TABLE_NO_KEY
+.. column_create Entries body COLUMN_SCALAR ShortText
+.. table_create Terms TABLE_PAT_KEY ShortText --default_tokenizer TokenBigram --normalizer NormalizerAuto
+.. column_create Terms document_index COLUMN_INDEX|WITH_POSITION Entries body
+.. load --table Entries
+.. [
+.. ["content"],
+.. {"body": "Mroonga is a ＭｙＳＱＬ storage engine based on Groonga. <b>Rroonga</b> is a Ruby binding of Groonga."}
+.. ]
+
+``highlight_full`` can be used in only ``--output_columns`` in
+:doc:`/reference/commands/select`.
+
+``highlight_full`` requires Groonga 4.0.5 or later.
+
+``highlight_full`` requires :doc:`/reference/command/command_version` 2
+or later.
+
+The following example uses HTML escape and normalzier is ``NormalizeAuto``.
+It specifies the tags ``<span class="keyword1">`` and ``</span>`` of the
+keyword ``groonga``, and the tags ``<span class="keyword2">`` and ``</span>``
+of the keyword ``mysql``.
+
+.. groonga-command
+.. include:: ../../example/reference/functions/highlight_full/usage_basic.log
+.. select Entries --output_columns 'highlight_full(body, "NormalizerAuto", true, "Groonga", "<span class=\\"keyword1\\">", "</span>", "mysql", "<span class=\\"keyword2\\">", "</span>")' --command_version 2
+
+The text are scanned by the keywords for tagging after they are normalized
+by ``NormalizerAuto`` normalizer.
+
+``--query "groonga mysql"`` matches to the first record's body.
+``highight_full`` surrounds the keywords ``groonga`` contained in the text
+with ``<span class="keyword1">`` and ``</span>``, and the keywords ``mysql``
+contained in the text with with ``<span class="keyword2">`` and ``</span>``.
+
+Special characters such as ``<`` and ``>`` are escapsed as ``&lt;`` and
+``&gt;``.
+
+You can specify string literal instead of column.
+
+.. groonga-command
+.. include:: ../../example/reference/functions/highlight_full/usage_string_literal.log
+.. 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"
+
+Parameters
+----------
+There are three required parameters, ``column``, ``normalizer_name`` and ``use_html_escape``.
+There are three or over optional parameters, ``keywordN``, ``open_tagN`` and ``end_tagN``.
+
+``column``
+^^^^^^^^^^
+
+It specifies a column of the table.
+
+``normalizer_name``
+^^^^^^^^^^^^^^^^^^^
+
+It specifies a normalizer name.
+
+``use_html_escape``
+^^^^^^^^^^^^^^^^^^^
+
+It specifies use or not use HTML escape. If it is ``true`` , use HTML escape.
+If it is ``false`` , not use HTML escape.
+
+``keywordN``
+^^^^^^^^^^^^
+
+It specifies a keyword for tagging.
+You can specify multiple keywords for each three arguments.
+
+``open_tagN``
+^^^^^^^^^^^^^
+
+It specifies a open tag.
+You can specify multiple open tags for each three arguments.
+
+``close_tagN``
+^^^^^^^^^^^^^^
+
+It specifies a close tag.
+You can specify multiple close tags for each three arguments.
+
+Return value
+------------
+
+``highlight_full`` returns a tagged string or ``null``. If
+``highlight_full`` can't find any keywords, it returns ``null``.
+
+See also
+--------
+
+* :doc:`/reference/commands/select`
+* :doc:`/reference/functions/highlight_html`

data/vendor/local/share/doc/groonga/en/html/_sources/reference/functions/highlight_html.txt

@@ -0,0 +1,100 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+.. groonga-command
+.. database: functions_highlight_html
+
+highlight_html
+==============
+
+.. caution::
+
+   This feature is experimental. API will be changed.
+
+Summary
+-------
+
+``highlight_html`` tags target text. It can use to highlight the search
+keywords. The tagged text are prepared for embedding HTML. Special
+characters such as ``<`` and ``>`` are escapsed as ``&lt;`` and ``&gt;``.
+Keyword is surrounded with ``<span class="keyword">`` and ``</span>``.
+For example, a tagged text of ``I am a groonga user. <3`` for keyword
+``groonga`` is ``I am a <span class="keyword">groonga</span> user. &lt;3``.
+
+Syntax
+------
+
+``highlight_html`` has only one parameter::
+
+  highlight_html(column)
+
+Usage
+-----
+
+Here are a schema definition and sample data to show usage.
+
+.. groonga-command
+.. include:: ../../example/reference/functions/highlight_html/usage_setup.log
+.. table_create Entries TABLE_NO_KEY
+.. column_create Entries body COLUMN_SCALAR ShortText
+.. table_create Terms TABLE_PAT_KEY ShortText --default_tokenizer TokenBigram --normalizer NormalizerAuto
+.. column_create Terms document_index COLUMN_INDEX|WITH_POSITION Entries body
+.. load --table Entries
+.. [
+.. ["content"],
+.. {"body": "Mroonga is a ＭｙＳＱＬ storage engine based on Groonga. <b>Rroonga</b> is a Ruby binding of Groonga."}
+.. ]
+
+``highlight_html`` can be used in only ``--output_columns`` in
+:doc:`/reference/commands/select`.
+
+``highlight_html`` requires Groonga 4.0.5 or later.
+
+``highlight_html`` requires :doc:`/reference/command/command_version` 2
+or later.
+
+You also need to specify ``--query`` and/or ``--filter``. Keywords are
+extracted from ``--query`` and ``--filter`` arguments.
+
+The following example uses ``--query "groonga mysql"``. In this case,
+``groonga`` and ``mysql`` are used as keywords.
+
+.. groonga-command
+.. include:: ../../example/reference/functions/highlight_html/usage_basic.log
+.. select Entries --output_columns --match_columns body --query 'groonga mysql' --output_columns 'highlight_html(body)' --command_version 2
+
+The text are scanned by the keywords for tagging after they are normalized
+by ``NormalizerAuto`` normalizer.
+
+``--query "groonga mysql"`` matches to only the first record's body.
+``highlight_html(body)`` surrounds the keywords ``groonga`` or ``mysql``
+contained in the text with ``<span class="keyword">`` and ``</span>``.
+
+You can specify string literal instead of column.
+
+.. groonga-command
+.. include:: ../../example/reference/functions/highlight_html/usage_string_literal.log
+.. select Entries --output_columns 'highlight_html("Groonga is very fast fulltext search engine.")' --command_version 2 --match_columns body --query "groonga"
+
+Parameters
+----------
+
+There is only one parameter ``column`` .
+
+``column``
+^^^^^^^^^^
+
+It specifies a column of the table.
+
+Return value
+------------
+
+``highlight_html`` returns a tagged string or ``null``. If
+``highlight_html`` can't find any keywords, it returns ``null``.
+
+See also
+--------
+
+* :doc:`/reference/commands/select`
+* :doc:`/reference/functions/highlight_full`

data/vendor/local/share/doc/groonga/en/html/_sources/reference/functions/snippet_html.txt

@@ -70,7 +70,7 @@ case, ``fast`` and ``performance`` are used as keywords.
 
 ``--query "fast performance"`` matches to only the first record's
 content. ``snippet_html(content)`` extracts two text parts that
-include the keywords ``fast`` or ``performance`` and surronds the
+include the keywords ``fast`` or ``performance`` and surrounds the
 keywords with ``<span class="keyword">`` and ``</span>``.
 
 The max number of text parts is 3. If there are 4 or more text parts

data/vendor/local/share/doc/groonga/en/html/_sources/server/http/comparison.txt

@@ -27,7 +27,7 @@ There are many differences between :doc:`groonga` and
 +----------------------------+------------------------+----------------------+
 |      Gzip compression      | x                      | o                    |
 +----------------------------+------------------------+----------------------+
-|            POST            | x                      | o                    |
+|            POST            | o                      | o                    |
 +----------------------------+------------------------+----------------------+
 |           HTTPS            | x                      | o                    |
 +----------------------------+------------------------+----------------------+

data/vendor/local/share/doc/groonga/en/html/_sources/troubleshooting/mmap_cannot_allocate_memory.txt

@@ -38,7 +38,7 @@ If you want to handle over 16GB groonga database, you must specify at least 6553
 
 You can modify vm.max_map_count temporary by sudo sysctl -w vm.max_map_count=65536.
 
-Then save the configuration value to /etc/sysctl.conf or /etc/sysctl.d/*.conf.
+Then save the configuration value to ``/etc/sysctl.conf`` or ``/etc/sysctl.d/*.conf``.
 
 See :doc:`/reference/tuning` documentation about tuning related parameters.
 

data/vendor/local/share/doc/groonga/en/html/_sources/tutorial/data.txt

@@ -136,7 +136,9 @@ The following example adds a reference column to the Site table that was created
 .. include:: ../example/tutorial/data-7.log
 .. column_create --table Site --name link --type Site
 .. load --table Site
-.. [{"_key":"http://example.org/","link":"http://example.net/"}]
+.. [
+.. {"_key":"http://example.org/","link":"http://example.net/"}
+.. ]
 .. select --table Site --output_columns _key,title,link._key,link.title --query title:@this
 
 The `type` parameter of the :doc:`/reference/commands/column_create` command specifies the table to be associated with the reference column. In this example, the reference column is associated with the own table. Then, the :doc:`/reference/commands/load` command registers a link from "http://example.org" to "http://example.net". Note that a reference column requires the primary key, not the ID, of the record to be referred to. After that, the link is confirmed by the :doc:`/reference/commands/select` command. In this case, the primary key and the title of the referred record are output because link._key and link.title are specified to the `output_columns` parameter.
@@ -154,7 +156,9 @@ The previous example used a regular column, so each record could have at most on
 .. include:: ../example/tutorial/data-8.log
 .. column_create --table Site --name links --flags COLUMN_VECTOR --type Site
 .. load --table Site
-.. [{"_key":"http://example.org/","links":["http://example.net/","http://example.org/","http://example.com/"]}]
+.. [
+.. {"_key":"http://example.org/","links":["http://example.net/","http://example.org/","http://example.com/"]},
+.. ]
 .. select --table Site --output_columns _key,title,links._key,links.title --query title:@this
 
 The only difference at the first step is the `flags` parameter that specifies to create a vector column. The `type` parameter of the :doc:`/reference/commands/column_create` command is the same as in the previous example. Then, the :doc:`/reference/commands/load` command registers three links from "http://example.org/" to "http://example.net/", "http://example.org/" and "http://example.com/". After that, the links are confirmed by the :doc:`/reference/commands/select` command. In this case, the primary keys and the titles are output as arrays because links._key and links.title are specified to the `output_columns` parameter.