rroonga 6.0.0-x64-mingw32 → 6.0.2-x64-mingw32

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

@@ -47,8 +47,8 @@ Parameters
 
 This section describes parameters of ``normalizer``.
 
-Required parameter
-^^^^^^^^^^^^^^^^^^
+Required parameters
+^^^^^^^^^^^^^^^^^^^
 
 There are required parameters, ``normalizer`` and ``string``.
 

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

@@ -78,7 +78,7 @@ If you want to check existence of a column, use
 Optional parameters
 ^^^^^^^^^^^^^^^^^^^
 
-There is no optional parameters.
+There is no optional parameter.
 
 Return value
 ------------

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

@@ -77,7 +77,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/en/html/_sources/reference/commands/object_remove.txt

@@ -79,7 +79,7 @@ This section describes all parameters.
 Required parameters
 ^^^^^^^^^^^^^^^^^^^
 
-There is only one required parameters.
+There is only one required parameter.
 
 .. _object-remove-name:
 

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

@@ -88,8 +88,8 @@ Parameters
 
 This section describes parameters of ``request_cancel``.
 
-Required parameter
-^^^^^^^^^^^^^^^^^^
+Required parameters
+^^^^^^^^^^^^^^^^^^^
 
 There is required parameter, ``id``.
 

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

@@ -57,12 +57,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/en/html/_sources/reference/commands/select.txt

@@ -291,8 +291,8 @@ Parameters
 
 This section describes all parameters. Parameters are categorized.
 
-Required parameter
-^^^^^^^^^^^^^^^^^^
+Required parameters
+^^^^^^^^^^^^^^^^^^^
 
 There is a required parameter, ``table``.
 
@@ -471,7 +471,7 @@ logical and. It means that matched records should be matched against
 both ``filter`` and ``query``.
 
 ``filter`` parameter is designed for complex conditions. A filter text
-should be formated in :doc:`/reference/grn_expr/script_syntax`. The syntax is
+should be formatted in :doc:`/reference/grn_expr/script_syntax`. The syntax is
 similar to ECMAScript. For example, ``column == "value"`` means that
 the value of ``column`` column is equal to ``"value"``. ``column <
 value`` means that the value of ``column`` column is less than

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

@@ -2,38 +2,112 @@
 
 .. highlightlang:: none
 
+.. groonga-command
+.. database: commands_table_shutdown
+
 ``shutdown``
 ============
 
 Summary
 -------
 
-shutdown - サーバプロセスの停止
+``shutdown`` stops the Groonga server process.
+
+``shutdown`` 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
+``shutdown`` command is executed.
+
+.. versionadded:: 6.0.1
 
-Groonga組込コマンドの一つであるshutdownについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入
-力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
+   ``shutdown`` uses immediate shutdown by specifying ``immediate`` to
+   ``mode`` parameter. The Groonga server process stops immediately
+   even when there are some running commands.
+
+   .. note::
+
+      You need to set :doc:`/reference/command/request_id` to all
+      requests to use immediate shutdown.
 
-shutdownは、接続しているgroongaサーバプロセスを停止します。
 
 Syntax
 ------
-::
 
- shutdown
+This command takes only one optional parameter::
+
+  shutdown [mode=graceful]
 
 Usage
 -----
-::
 
- shutdown
+``shutdown`` use graceful shutdown by default:
+
+.. groonga-command
+.. include:: ../../example/reference/commands/shutdown/default.log
+.. shutdown
+
+You can specify ``graceful`` to ``mode`` parameter explicitly:
+
+.. groonga-command
+.. database: commands_table_shutdown
+.. include:: ../../example/reference/commands/shutdown/graceful.log
+.. shutdown --mode graceful
+
+You can choose immediate shutdown by specifying ``immediate`` to
+``mode`` parameter:
+
+.. groonga-command
+.. database: commands_table_shutdown
+.. include:: ../../example/reference/commands/shutdown/immediate.log
+.. shutdown --mode immediate
+
+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.
 
 Parameters
 ----------
 
-ありません。
+This section describes parameters of this command.
+
+Required parameters
+^^^^^^^^^^^^^^^^^^^
+
+There is no required parameter.
+
+Optional parameters
+^^^^^^^^^^^^^^^^^^^
+
+There are optional parameters.
+
+``mode``
+""""""""
+
+Specifies shutdown mode. Here are available shutdown modes:
+
+.. list-table::
+   :header-rows: 1
+
+   * - Value
+     - Description
+   * - ``graceful``
+     - Stops after running commands are finished.
+
+       This is the default.
+   * - ``immediate``
+     - .. versionadded:: 6.0.1
+
+          Stops immediately even if there are some running commands.
 
 Return value
 ------------
 
-ありません。
+``shutdown`` returns ``true`` as body when shutdown is
+accepted::
+
+  [HEADER, true]
+
+If ``shutdown`` doesn't accept shutdown, error details are in
+``HEADER``.
 
+See :doc:`/reference/command/output_format` for ``HEADER``.

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

@@ -46,12 +46,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.
 
 .. _status-return-value:
 

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

@@ -29,7 +29,17 @@ Syntax
 ------
 ::
 
- suggest types table column query [sortby [output_columns [offset [limit [frequency_threshold [conditional_probability_threshold [prefix_search]]]]]]]
+ suggest types
+         table
+         column
+         query
+         [sortby=-_score]
+         [output_columns=_key,_score]
+         [offset=0]
+         [limit=10]
+         [frequency_threshold=100]
+         [conditional_probability_threshold=0.2]
+         [prefix_search=auto]
 
 Usage
 -----

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

@@ -60,6 +60,28 @@ If your records are searched by key or referenced by one or more
 columns, ``TABLE_NO_KEY`` type isn't suitable. Lexicon for fulltext
 search is the case.
 
+Create large data store table
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+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.
+
+You can expand the maximum total key size to 1TiB from 4GiB by
+``KEY_LARGE`` flag. ``KEY_LARGE`` flag can be used with only
+``TABLE_HASH_KEY``. You can't use ``KEY_LARGE`` flag with
+``TABLE_NO_KEY``, ``TABLE_PAT_KEY`` nor ``TABLE_DAT_KEY``.
+
+Here is an example to create a table that can store many large keys:
+
+.. groonga-command
+.. include:: ../../example/reference/commands/table_create/large_data_store_table.log
+.. table_create Paths TABLE_HASH_KEY|KEY_LARGE ShortText
+
+The ``table_create`` command creates a table that is named ``Paths``
+and is ``TABLE_HASH_KEY`` type. The ``Paths`` table can store many
+large keys.
+
 Create lexicon table
 ^^^^^^^^^^^^^^^^^^^^
 
@@ -175,7 +197,7 @@ Here are available characters:
 * ``_`` (underscore) (NOTE: Underscore can't be used as the first
   character.)
 
-You need to create a name with one or more the above chracters. Note
+You need to create a name with one or more the above characters. Note
 that you cannot use ``_`` as the first character such as
 ``_name``.
 
@@ -188,20 +210,24 @@ Specifies a table type and table customize options.
 
 Here are available flags:
 
-+--------------------+------------------------------+
-|      flags         | description                  |
-+--------------------+------------------------------+
-| ``TABLE_NO_KEY``   | Array table.                 |
-+--------------------+------------------------------+
-| ``TABLE_HASH_KEY`` | Hash table.                  |
-+--------------------+------------------------------+
-| ``TABLE_PAT_KEY``  | Patricia trie.               |
-+--------------------+------------------------------+
-| ``TABLE_DAT_KEY``  | Double Array trie.           |
-+--------------------+------------------------------+
-| ``KEY_WITH_SIS``   | Enable Semi Infinite String. |
-|                    | Require ``TABLE_PAT_KEY``.   |
-+--------------------+------------------------------+
+.. list-table::
+   :header-rows: 1
+
+   * - Flag
+     - Description
+   * - ``TABLE_NO_KEY``
+     - Array table. See also :ref:`table-no-key`.
+   * - ``TABLE_HASH_KEY``
+     - Hash table. See also :ref:`table-hash-key`.
+   * - ``TABLE_PAT_KEY``
+     - Patricia trie. See also :ref:`table-pat-key`.
+   * - ``TABLE_DAT_KEY``
+     - Double array trie. See also :ref:`table-dat-key`.
+   * - ``KEY_WITH_SIS``
+     - Enable Semi Infinite String. Require ``TABLE_PAT_KEY``.
+   * - ``KEY_LARGE``
+     - Expand the maximum total key size to 1TiB from 4GiB. Require
+       ``TABLE_HASH_KEY``.
 
 .. note::
    Since Groonga 2.1.0 ``KEY_NORMALIZE`` flag is deprecated. Use

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

@@ -15,12 +15,18 @@ Summary
 more indexes against key of the table and its columns, they are also
 removed.
 
+.. versionadded:: 6.0.1
+
+   You can also remove tables and columns that reference the target
+   table by using ``dependent`` parameter.
+
 Syntax
 ------
 
-This command takes only one required parameter::
+This command takes two parameters::
 
   table_remove name
+               [dependent=no]
 
 .. _table-remove-usage:
 
@@ -36,6 +42,7 @@ This section describes about the followings:
 
   * Basic usage
   * Unremovable cases
+  * Removes a table with tables and columns that reference the target table
   * Decreases used resources
 
 .. _table-remove-basic-usage:
@@ -173,6 +180,44 @@ You need to remove ``Table.reference_column`` before you remove
 .. column_remove Table reference_column
 .. table_remove ReferencedByColumn
 
+.. _table-remove-remove-dependents:
+
+Removes a table with tables and columns that reference the target table
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. versionadded:: 6.0.1
+
+If you understand what you'll do, you can also remove tables and
+columns that reference the target table with one ``table_remove``
+command by using ``--dependent yes`` parameter.
+
+``ReferencedTable`` in the following schema is referenced from a table
+and a column:
+
+.. groonga-command
+.. include:: ../../example/reference/commands/table_remove/remove_dependents_schema.log
+.. table_create ReferencedTable TABLE_HASH_KEY ShortText
+.. table_create Table1 TABLE_HASH_KEY ReferencedTable
+.. table_create Table2 TABLE_NO_KEY
+.. column_create Table2 reference_column COLUMN_SCALAR ReferencedTable
+
+You can't remove ``ReferencedTable`` by default:
+
+.. groonga-command
+.. include:: ../../example/reference/commands/table_remove/remove_dependents_default.log
+.. table_remove ReferencedTable
+
+You can remove ``ReferencedTable``, ``Table1`` and
+``Table2.reference_column`` by using ``--dependent yes``
+parameter. ``Table1`` and ``Table2.reference_column`` reference
+``ReferencedTable``:
+
+.. groonga-command
+.. include:: ../../example/reference/commands/table_remove/remove_dependents_yes.log
+.. table_remove ReferencedTable --dependent yes
+
+.. _table-remove-decreases-used-resources:
+
 Decreases used resources
 ^^^^^^^^^^^^^^^^^^^^^^^^
 
@@ -215,7 +260,7 @@ This section describes all parameters.
 Required parameters
 ^^^^^^^^^^^^^^^^^^^
 
-There is only one required parameters.
+There is only one required parameter.
 
 .. _table-remove-name:
 
@@ -226,6 +271,32 @@ Specifies the table name to be removed.
 
 See :ref:`table-remove-usage` how to use this parameter.
 
+Optional parameters
+^^^^^^^^^^^^^^^^^^^
+
+There is only one optional parameter.
+
+.. _table-remove-dependent:
+
+``dependent``
+"""""""""""""
+
+.. versionadded:: 6.0.1
+
+Specifies whether tables and columns that reference the target table
+are also removed or not.
+
+If this value is ``yes``, tables and columns that reference the target
+table are also removed. Otherwise, they aren't removed and an error is
+returned.
+
+In other words, if there are any tables and columns that reference the
+target table, the target table isn't removed by default.
+
+You should use this parameter carefully. This is a danger parameter.
+
+See :ref:`table-remove-remove-dependents` how to use this parameter.
+
 Return value
 ------------
 

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

@@ -25,6 +25,7 @@ optional::
                  string
                  [flags=NONE]
                  [mode=GET]
+                 [index_column=null]
 
 Usage
 -----
@@ -96,6 +97,15 @@ The default value is ``GET``.
 
 See :ref:`tokenize-mode` option in :doc:`/reference/commands/tokenize` about details.
 
+``index_column``
+""""""""""""""""
+
+Specifies an index column.
+
+Return value includes ``estimated_size`` of the index.
+
+The ``estimated_size`` is useful for checking estimated frequency of tokens.
+
 Return value
 ------------