rroonga 6.0.0-x86-mingw32 → 6.0.2-x86-mingw32

data/vendor/local/share/doc/groonga/ja/html/_sources/reference/command/request_timeout.txt

@@ -0,0 +1,78 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+Request timeout
+===============
+
+Summary
+-------
+
+.. versionadded:: 6.0.2
+
+You can set timeout to each request.
+
+If a request isn't completed until the specified timeout, the request
+is canceled. If you don't set timeout, the request is processed until
+the request is completed.
+
+Request timeout feature is useful when you implement timeout on client
+side. If you only implement timeout only on client side, the request
+keeps processing after client stops waiting response. It uses needless
+resources. If you set timeout to the request, the request will be
+canceled soon.
+
+How to set timeout to request
+-----------------------------
+
+All commands accept ``request_timeout`` parameter. You can set timeout
+to request by adding ``request_timeout`` parameter.
+
+Unit of timeout out value is second. You can set timeout less than 1
+second by using decimal such as ``0.1``. ``0.1`` means 100
+milliseconds.
+
+Here is an example to set ``5.5`` seconds timeout to a request::
+
+  select Users --request_timeout 5.5
+
+Return code on timeout
+----------------------
+
+If the request is timed out, ``GRN_CANCEL`` (``-77``)
+:doc:`return_code` is returned in response header.
+
+Here is an example response on timeout::
+
+  [
+    [
+      -77,
+      1459846102.63304,
+      0.000220775604248047,
+      "[request-canceler] a request is canceled: <0x7fa0d5d7ed00>"
+    ]
+  ]
+
+See :doc:`/reference/command/output_format` for response header.
+
+Enable request timeout by default
+---------------------------------
+
+:doc:`/reference/executables/groonga` supports enabling request
+timeout by default. You can specify the default request timeout by
+:option:`--default-request-timeout`.
+
+If the default request timeout is larger than 0 second, the default
+request timeout is used as request timeout for all requests.
+
+You can overwrite the default request timeout by specifying
+``request_timeout`` parameter to request. If the default request
+timeout is 3 seconds and ``request_timeout`` parameter is 1 second,
+the request is canceled after 1 second.
+
+See also
+--------
+
+* :doc:`/reference/command/return_code`
+* :doc:`/reference/command/output_format`
+* :doc:`/reference/commands/request_cancel`

data/vendor/local/share/doc/groonga/ja/html/_sources/reference/command/return_code.txt

@@ -97,6 +97,12 @@ only C API. It is not showen in query API.
 * -69: ``GRN_TOO_SMALL_LIMIT``
 * -70: ``GRN_CAS_ERROR``
 * -71: ``GRN_UNSUPPORTED_COMMAND_VERSION``
+* -72: ``GRN_NORMALIZER_ERROR``
+* -73: ``GRN_TOKEN_FILTER_ERROR``
+* -74: ``GRN_COMMAND_ERROR``
+* -75: ``GRN_PLUGIN_ERROR``
+* -76: ``GRN_SCORER_ERROR``
+* -77: ``GRN_CANCEL``
 
 See also
 --------

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

@@ -18,5 +18,6 @@ This section describes about command and built-in commands.
    command/output_format
    command/pretty_print
    command/request_id
+   command/request_timeout
    command/return_code
    commands/*

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

@@ -367,7 +367,7 @@ See :ref:`column-copy-to-table` for example.
 Optional parameters
 ^^^^^^^^^^^^^^^^^^^
 
-There is no optional parameters.
+There is no optional parameter.
 
 Return value
 ------------

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

@@ -67,7 +67,7 @@ You can't use an empty string as key.
 Optional parameters
 ^^^^^^^^^^^^^^^^^^^
 
-There is no optional parameters.
+There is no optional parameter.
 
 Return value
 ------------

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

@@ -67,7 +67,7 @@ You can't use an empty string as key.
 Optional parameters
 ^^^^^^^^^^^^^^^^^^^
 
-There is no optional parameters.
+There is no optional parameter.
 
 Return value
 ------------

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

@@ -68,7 +68,7 @@ The max value size is 4091B (= 4KiB - 5B).
 Optional parameters
 ^^^^^^^^^^^^^^^^^^^
 
-There is no optional parameters.
+There is no optional parameter.
 
 Return value
 ------------

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

@@ -66,12 +66,12 @@ This section describes all parameters.
 Required parameters
 ^^^^^^^^^^^^^^^^^^^
 
-There is no required parameters.
+There is no required parameter.
 
 Optional parameters
 ^^^^^^^^^^^^^^^^^^^
 
-There is no optional parameters.
+There is no optional parameter.
 
 Return value
 ------------

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

@@ -173,7 +173,7 @@ This section describes all parameters.
 Required parameters
 ^^^^^^^^^^^^^^^^^^^
 
-There is no required parameters.
+There is no required parameter.
 
 Optional parameters
 ^^^^^^^^^^^^^^^^^^^

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

@@ -37,7 +37,7 @@ This section describes all parameters.
   ``Format 2:``
     [{COLUMN_NAME1: VALUE1, COLUMN_NAME2: VALUE2}, {COLUMN_NAME1: VALUE1, COLUMN_NAME2: VALUE2},..]
 
-  ``[COLUMN_NAME1, COLUMN_NAME2,..]`` format in ``Format 1`` is effective only when ``column`` parameter isn't specified.
+  ``[COLUMN_NAME1, COLUMN_NAME2,..]`` format in ``Format 1`` is effective only when ``columns`` parameter isn't specified.
 
   When a target table contains primary key, you must specify ``_key`` column (pseudo column associated primary key) as the one of ``COLUMN_NAME``.
 

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

@@ -11,10 +11,6 @@
 Summary
 -------
 
-.. note::
-
-   This command is an experimental feature.
-
 .. versionadded:: 5.0.0
 
 ``logical_count`` is a command to count matched records even though actual records are stored into parted tables. It is useful for users because there is less need to care about maximum records of table :doc:`/limitations`.
@@ -118,8 +114,8 @@ Parameters
 
 This section describes parameters of ``logical_count``.
 
-Required parameter
-^^^^^^^^^^^^^^^^^^
+Required parameters
+^^^^^^^^^^^^^^^^^^^
 
 There are required parameters, ``logical_table`` and ``shard_key``.
 

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

@@ -11,10 +11,6 @@
 Summary
 -------
 
-.. note::
-
-   This command is an experimental feature.
-
 .. versionadded:: 5.0.6
 
 ``logical_parameters`` is a command for test. Normally, you don't need
@@ -77,7 +73,7 @@ This section describes parameters.
 Required parameters
 ^^^^^^^^^^^^^^^^^^^
 
-There is no required parameters.
+There is no required parameter.
 
 Optional parameters
 ^^^^^^^^^^^^^^^^^^^

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

@@ -11,10 +11,6 @@
 Summary
 -------
 
-.. note::
-
-   This command is an experimental feature.
-
 .. versionadded:: 5.0.0
 
 TODO: Write summary
@@ -63,8 +59,8 @@ Parameters
 
 This section describes parameters of ``logical_range_filter``.
 
-Required parameter
-^^^^^^^^^^^^^^^^^^
+Required parameters
+^^^^^^^^^^^^^^^^^^^
 
 There are required parameters, ``logical_table`` and ``shard_key``.
 

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

@@ -11,10 +11,6 @@
 Summary
 -------
 
-.. note::
-
-   This command is an experimental feature.
-
 .. versionadded:: 5.0.5
 
 ``logical_select`` is a sharding version of
@@ -210,8 +206,8 @@ Parameters
 
 This section describes parameters of ``logical_select``.
 
-Required parameter
-^^^^^^^^^^^^^^^^^^
+Required parameters
+^^^^^^^^^^^^^^^^^^^
 
 There are required parameters, ``logical_table`` and ``shard_key``.
 
@@ -283,7 +279,7 @@ table. ``Entry_20150708`` isn't used.
 ``min_border``
 """"""""""""""
 
-Specifies whether the minimum value is include or not. Here is
+Specifies whether the minimum value is included or not. Here is
 available values.
 
 .. list-table::
@@ -335,7 +331,7 @@ table. ``Entry_20150709`` isn't used.
 ``max_border``
 """"""""""""""
 
-Specifies whether the maximum value is include or not. Here is
+Specifies whether the maximum value is included or not. Here is
 available values.
 
 .. list-table::

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

@@ -11,10 +11,6 @@
 Summary
 -------
 
-.. note::
-
-   This command is an experimental feature.
-
 .. versionadded:: 5.0.7
 
 ``logical_shard_list`` returns all existing shard names against the
@@ -82,7 +78,7 @@ The list is sorted by shard name in ascending order.
 Optional parameters
 ^^^^^^^^^^^^^^^^^^^
 
-There is no optional parameters.
+There is no optional parameter.
 
 Return value
 ------------