rroonga 4.0.0-x64-mingw32 → 4.0.1-x64-mingw32

data/vendor/local/share/doc/groonga/ja/html/_sources/reference/commands/cache_limit.txt

@@ -70,7 +70,7 @@ Return value
 
 ``cache_limit`` returns the current max number of query cache entries::
 
-  [[HEADER, N_ENTRIES]]
+  [HEADER, N_ENTRIES]
 
 ``HEADER``
 

data/vendor/local/share/doc/groonga/ja/html/_sources/reference/commands/column_create.txt

@@ -94,8 +94,7 @@ Return value
 
 ``HEADER``
 
-  The format of HEADER is [0, UNIX_TIME_WHEN_COMMAND_IS_STARTED, ELAPSED_TIME].
-  See :doc:`/reference/command/output_format` about HEADER.
+  See :doc:`/reference/command/output_format` about ``HEADER``.
 
 ``SUCCEEDED``
 

data/vendor/local/share/doc/groonga/ja/html/_sources/reference/commands/column_rename.txt

@@ -11,16 +11,31 @@
 Summary
 -------
 
-``column_rename`` command renames specified column name of table.
+``column_rename`` command renames a column.
+
+It is a light operation. It just changes a relationship between name
+and the column object. It doesn't copy column values.
+
+It is a dangerous operation. You must stop all operations including
+read operations while you run ``column_rename``. If the following case
+is occurred, Groonga process may be crashed:
+
+  * Starts an operation (like ``select``) that accesses the column to
+    be renamed by the current column name. The current column name is
+    called as ``the old column name`` in the below because the column
+    name is renamed.
+  * Runs ``column_rename``. The ``select`` is still running.
+  * The ``select`` accesses the column to be renamed by the old column
+    name. But the ``select`` can't find the column by the old name
+    because the column has been renamed to the new column name. It may
+    crash the Groonga process.
 
 Syntax
 ------
 
-``column_rename`` command takes two parameters.
-
-The required parameter is ``table`` and ``column_name``::
+``column_rename`` command takes three parameters. All parameters are required::
 
-  column_rename table column
+  column_rename table name new_name
 
 Usage
 -----
@@ -46,20 +61,26 @@ Parameters
 
 This section describes parameters of ``column_rename``.
 
-Required parameter
-^^^^^^^^^^^^^^^^^^
+Required parameters
+^^^^^^^^^^^^^^^^^^^
+
+All parameters are required.
+
+``table``
+"""""""""
+
+It specifies the name of table that has the column to be renamed.
 
-There are required parameters, ``table_name`` and ``column_name``.
+``name``
+""""""""
 
-``table_name``
-""""""""""""""
+It specifies the column name to be renamed.
 
-It specifies the name of table.
+``new_name``
+""""""""""""
 
-``column_name``
-"""""""""""""""
+It specifies the new column name.
 
-It specifies the name of column.
 
 Return value
 ------------
@@ -70,10 +91,9 @@ Return value
 
 ``HEADER``
 
-  The format of HEADER is [0, UNIX_TIME_WHEN_COMMAND_IS_STARTED, ELAPSED_TIME].
-  See :doc:`/reference/command/output_format` about HEADER.
+  See :doc:`/reference/command/output_format` about ``HEADER``.
 
 ``SUCCEEDED_OR_NOT``
 
-  If command succeeded, it returns true, otherwise it returns false on error.
+  It is ``true`` on success, ``false`` otherwise.
 

data/vendor/local/share/doc/groonga/ja/html/_sources/reference/commands/delete.txt

@@ -40,7 +40,7 @@ Here are a schema definition and sample data to show usage.
 .. [
 .. {"_key": 1, "status": "OK"}
 .. {"_key": 2, "status": "NG"}
-.. ] 
+.. ]
 
 Delete the record from Entry table which has "2" as the key.
 
@@ -67,12 +67,12 @@ The country column of Users table associates with Country table.
 .. {"_key": 2, "name": "Mike", country: "United States"}
 .. {"_key": 3, "name": "Takashi", country: "Japan"}
 .. {"_key": 4, "name": "Hanako", country: "Japan"}
-.. ] 
+.. ]
 .. load --table Country
 .. [
 .. {"_key": "United States"}
 .. {"_key": "Japan"}
-.. ] 
+.. ]
 .. delete Country "United States"
 .. select Country
 .. select Users
@@ -108,8 +108,7 @@ Return value
 
 ``HEADER``
 
-  The format of HEADER is [0, UNIX_TIME_WHEN_COMMAND_IS_STARTED, ELAPSED_TIME].
-  See :doc:`/reference/command/output_format` about HEADER.
+  See :doc:`/reference/command/output_format` about ``HEADER``.
 
 ``SUCCEEDED_OR_NOT``
 

data/vendor/local/share/doc/groonga/ja/html/_sources/reference/commands/normalize.txt

@@ -132,8 +132,7 @@ Return value
 
 ``HEADER``
 
-  The format of HEADER is [0, UNIX_TIME_WHEN_COMMAND_IS_STARTED, ELAPSED_TIME].
-  See :doc:`/reference/command/output_format` about HEADER.
+  See :doc:`/reference/command/output_format` about ``HEADER``.
 
 ``normalized_text``
 

data/vendor/local/share/doc/groonga/ja/html/_sources/reference/commands/select.txt

@@ -42,6 +42,7 @@ Syntax
          [query_expansion=null]
          [query_flags=ALLOW_PRAGMA|ALLOW_COLUMN|ALLOW_UPDATE|ALLOW_LEADING_NOT|NONE]
          [query_expander=null]
+         [adjuster=null]
 
 Usage
 -----
@@ -838,6 +839,104 @@ TODO: write in English and add example.
 
   検索結果をクエリキャッシュに残しません。キャッシュして再利用される可能性が低いクエリに対して用います。キャッシュ容量は有限です。有効なキャッシュが多くヒットするために、このパラメータは有効です。
 
+Score related parameters
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+There is a score related parameter, ``adjuster``.
+
+.. _select-adjuster:
+
+
+``adjuster``
+""""""""""""
+
+It specifies one or more score adjust expressions. You need to use
+``adjuster`` with ``query`` or ``filter``. ``adjuster`` doesn't work
+with not searched request.
+
+You can increase score of specific records by ``adjuster``. You can
+use ``adjuster`` to set high score for important records.
+
+For example, you can use ``adjuster`` to increase score of records
+that have ``groonga`` tag.
+
+Here is the syntax::
+
+  --adjuster "SCORE_ADJUST_EXPRESSION1 + SCORE_ADJUST_EXPRESSION2 + ..."
+
+Here is the ``SCORE_ADJUST_EXPRESSION`` syntax::
+
+  COLUMN @ "KEYWORD" * FACTOR
+
+Note the following:
+
+  * ``COLUMN`` must be indexed.
+  * ``"KEYWORD"`` must be a string.
+  * ``FACTOR`` must be a positive integer.
+
+Here is a sample ``adjuster`` usage example that uses just one
+``SCORE_ADJUST_EXPRESSION``:
+
+.. groonga-command
+.. include:: ../../example/reference/commands/select/adjuster_one.log
+.. select Entries \
+..   --filter true \
+..   --adjuster 'content @ "groonga" * 5' \
+..   --output_columns _key,content,_score
+
+The ``select`` command matches all records. Then it applies
+``adjuster``. The adjuster increases score of records that have
+``"groonga"`` in ``Entries.content`` column by 5. There is only one
+record that has ``"groonga"`` in ``Entries.content`` column.  So the
+record that its key is ``"Groonga"`` has score 6 (``= 1 + 5``).
+
+You can omit ``FACTOR``. If you omit ``FACTOR``, it is treated as 1.
+
+Here is a sample ``adjuster`` usage example that omits ``FACTOR``:
+
+.. groonga-command
+.. include:: ../../example/reference/commands/select/adjuster_no_factor.log
+.. select Entries \
+..   --filter true \
+..   --adjuster 'content @ "groonga"' \
+..   --output_columns _key,content,_score
+
+The ``adjuster`` in the ``select`` command doesn't have ``FACTOR``. So
+the factor is treated as 1. There is only one record that has
+``"groonga"`` in ``Entries.content`` column. So the record that its
+key is ``"Groonga"`` has score 2 (``= 1 + 1``).
+
+Here is a sample ``adjuster`` usage example that uses multiple
+``SCORE_ADJUST_EXPRESSION``:
+
+.. groonga-command
+.. include:: ../../example/reference/commands/select/adjuster_multiple.log
+.. select Entries \
+..   --filter true \
+..   --adjuster 'content @ "groonga" * 5 + content @ "started" * 3' \
+..   --output_columns _key,content,_score
+
+The ``adjuster`` in the ``select`` command has two
+``SCORE_ADJUST_EXPRESSION`` s. The final increased score is sum of
+scores of these ``SCORE_ADJUST_EXPRESSION`` s. All
+``SCORE_ADJUST_EXPRESSION`` s in the ``select`` command are applied to
+a record that its key is ``"Groonga"``. So the final increased score
+of the record is sum of scores of all ``SCORE_ADJUST_EXPRESSION`` s.
+
+The first ``SCORE_ADJUST_EXPRESSION`` is ``content @ "groonga" * 5``.
+It increases score by 5.
+
+The second ``SCORE_ADJUST_EXPRESSION`` is ``content @ "started" * 3``.
+It increases score by 3.
+
+The final increased score is 9 (``= 1 + 5 + 3``).
+
+A ``SCORE_ADJUST_EXPRESSION`` has a factor for ``"KEYWORD"``. This
+means that increased scores of all records that has ``"KEYWORD"`` are
+the same value. You can change increase score for each record that has
+the same ``"KEYWORD"``. It is useful to tune search score. See
+:ref:`weight-vector-column` for details.
+
 返値
 ----
 

data/vendor/local/share/doc/groonga/ja/html/_sources/reference/commands/table_create.txt

@@ -187,7 +187,7 @@ Here are available flags:
 +--------------------+------------------------------+
 | ``TABLE_NO_KEY``   | Array table.                 |
 +--------------------+------------------------------+
-| ``TABLE_HASH_HEY`` | Hash table.                  |
+| ``TABLE_HASH_KEY`` | Hash table.                  |
 +--------------------+------------------------------+
 | ``TABLE_PAT_KEY``  | Patricia trie.               |
 +--------------------+------------------------------+

data/vendor/local/share/doc/groonga/ja/html/_sources/reference/commands/truncate.txt

@@ -64,8 +64,7 @@ Return value
 
 ``HEADER``
 
-  The format of HEADER is [0, UNIX_TIME_WHEN_COMMAND_IS_STARTED, ELAPSED_TIME].
-  See :doc:`/reference/command/output_format` about HEADER.
+  See :doc:`/reference/command/output_format` about ``HEADER``.
 
 ``SUCCEEDED_OR_NOT``
 

data/vendor/local/share/doc/groonga/ja/html/_sources/reference/executables/groonga-suggest-httpd.txt

@@ -2,13 +2,17 @@
 
 .. highlightlang:: none
 
+.. groonga-command
+.. database: groonga-suggest-httpd
+
 groonga-suggest-httpd
 =====================
 
 Summary
 -------
 
-TODO
+groonga-suggest-httpd is a program to provide interface which accepts HTTP request and returns suggestion dataset, then saves logs for learning.
+groonga-suggest-httpd behaves similar in point of view of suggestion functionality, but the name of parameter is different.
 
 Synopsis
 --------
@@ -20,6 +24,30 @@ Synopsis
 Usage
 -----
 
+
+Set up
+^^^^^^
+
+First you need to set up database for suggestion.
+
+.. groonga-command
+.. include:: ../example/reference/executables/groonga-suggest-httpd-setup.log
+.. .. % groonga-suggest-create-dataset /tmp/groonga-databases/groonga-suggest-httpd query
+
+Launch groonga-suggest-httpd
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Execute groonga-suggest-httpd command:
+
+.. groonga-command
+.. include:: ../example/reference/executables/groonga-suggest-httpd-launch.log
+.. .. % groonga-suggest-httpd /tmp/groonga-databases/groonga-suggest-httpd
+
+After executing above command, groonga-suggest-httpd accepts HTTP request on 8080 port.
+
+Request to groonga-suggest-httpd
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
 TODO
 
 Options
@@ -57,12 +85,108 @@ Options
 
    Specify this option to disable checking max fd on start.
 
-Parameters
-----------
+Command line Parameters
+-----------------------
 
 There is one required parameter - ``database_path``.
 
 ``database_path``
 ^^^^^^^^^^^^^^^^^^^
 
-Specifies the path to a groonga database.
+Specifies the path to a Groonga database. This database must be created by :doc:`groonga-suggest-create-dataset` command because it executes required initialization for suggestion.
+
+
+GET Parameters
+--------------
+
+groonga-suggest-httpd accepts following GET parameters.
+
+There are required parameters which depends on type of query.
+
+Required parameters
+^^^^^^^^^^^^^^^^^^^
+
+.. list-table::
+   :header-rows: 1
+
+   * - Key
+     - Description
+     - Note
+   * - q
+     - UTF-8 encoded string which user fills in form
+     - 
+   * - t
+     - The type of query. The value of type must be complete, correct, suggest or submit. It also accepts multiple type of query which is concatinated by '|'. Note that 'submit' is invalid value when you specify multiple type of query.
+     - 
+
+Required parameters for learning
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. list-table::
+   :header-rows: 1
+
+   * - Key
+     - Description
+     - Note
+   * - s
+     - Elapsed time from 0:00 January 1, 1970
+     - Note that you need specify the value of 's' in milliseconds
+   * - i
+     - Unique ID to distinct user
+     - Use session ID or IP address for example
+   * - l
+     - Specify the name of dataset for learning. It also accepts multiple dataset name which is concatinated by '|'
+     - Note that dataset name must be matched to following regular expression '[A-Za-z ][A-Za-z0-9 ]{0,15}'
+
+Required parameters for suggestion
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. list-table::
+   :header-rows: 1
+
+   * - Key
+     - Description
+     - Note
+   * - n
+     - Specify the name of dataset for suggestion
+     - This dataset name is used to calculate suggestion results
+
+Optional parameter
+^^^^^^^^^^^^^^^^^^
+
+.. list-table::
+   :header-rows: 1
+
+   * - Key
+     - Description
+     - Note
+   * - callback
+     - Specify the name of function if you prefer JSONP as response format
+     - The name of function must be matched to reqular expression '[A-Za-z ][A-Za-z0-9 ]{0,15}'
+
+Return value
+------------
+
+``groonga-suggest-httpd`` command returns following response in JSON or JSONP format.
+
+In JSON format::
+
+  {TYPE: [[CANDIDATE_1, SCORE_1], [CANDIDATE_2, SCORE_2], ... [CANDIDATE_N, SCORE_N]]}
+
+In JSONP format::
+
+  FUNCTION({TYPE: [[CANDIDATE_1, SCORE_1], [CANDIDATE_2, SCORE_2], ... [CANDIDATE_N, SCORE_N]]})
+
+
+``TYPE``
+
+  'complete', 'correct' or 'suggest'.
+
+``CANDIDATE_N``
+
+  The string of candidate (UTF-8).
+
+``SCORE_N``
+
+  The number of score.
+

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

@@ -25,7 +25,17 @@ TODO
 Options
 -------
 
-TODO
+.. cmdoption:: -r, --receive-endpoint
+
+   Specify endpoint for receiver.
+
+.. cmdoption:: -s, --send-endpoint
+
+   Specify endpoint for sender.
+
+.. cmdoption:: -d, --daemon
+
+   Specify this option to daemonize.
 
 Parameters
 ----------