rroonga 5.0.4-x86-mingw32 → 5.0.5-x86-mingw32

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

@@ -3,7 +3,7 @@
 .. highlightlang:: none
 
 .. groonga-command
-.. database: io_flush
+.. database: commands_io_flush
 
 ``io_flush``
 ============
@@ -17,44 +17,253 @@ Summary
 
 .. versionadded:: 5.0.5
 
-TODO
+``io_flush`` flushes all changes in memory to disk
+explicitly. Normally, you don't need to use ``io_flush``
+explicitly. Because flushing is done automatically by OS. And flushing
+by OS is effective.
+
+You need to use ``io_flush`` explicitly when your system may often
+crash unexpectedly or you may not shutdown your Groonga process in a
+normal way. (For example, using :doc:`shutdown` is a normal shutdown
+process.) It's better that you use ``io_flush`` after you change your
+Groonga database for the case. Here are commands that change your
+Groonga database:
+
+  * :doc:`load`
+  * :doc:`delete`
+  * :doc:`truncate`
+  * :doc:`table_create`
+  * :doc:`table_remove`
+  * :doc:`table_rename`
+  * :doc:`column_create`
+  * :doc:`column_remove`
+  * :doc:`column_rename`
+  * :doc:`plugin_register`
+  * :doc:`plugin_unregister`
+
+If you're using :ref:`select-scorer` parameter in :doc:`select` to
+change existing column values, :doc:`select` is added to the above
+list.
+
+Note that ``io_flush`` may be a heavy process. If there are many
+changes in memory, flushing them to disk is a heavy process.
 
 Syntax
 ------
 
-``io_flush`` command has two parameters. ::
+This command takes two parameters.
+
+All parameters are optional::
 
-  io_flush [target_name]
+  io_flush [target_name=null]
            [recursive=yes]
 
 Usage
 -----
 
-TODO
+You can flush all changes in memory to disk with no arguments:
+
+.. groonga-command
+.. include:: ../../example/reference/commands/io_flush/all.log
+.. io_flush
+
+If you know what is changed, you can narrow flush targets. Here is a
+correspondence table between command and flush targets.
+
+.. list-table::
+   :header-rows: 1
+
+   * - Command
+     - Flush targets
+     - ``io_flush`` arguments
+   * - :doc:`load` and :doc:`delete`
+     - Target table and its columns.
+
+       If there are one or more reference columns in these columns,
+       referenced tables are also flush targets.
+
+       If there are one or more indexed columns in these columns,
+       tables of corresponding index columns and corresponding index
+       columns are also flush targets.
+     - Table and its columns::
+
+         io_flush --target_name TABLE_NAME
+
+       A referenced table::
+
+         io_flush --target_name REFERENCED_TABLE_NAME --recursive no
+
+       A table of an index column::
+
+         io_flush --target_name TABLE_NAME_OF_INDEX_COLUMN --recursive no
+
+       An index column::
+
+         io_flush --target_name TABLE_NAME_OF_INDEX_COLUMN.INDEX_COLUMN
+   * - :doc:`truncate`
+     - Target table and its columns.
+
+       If there are one or more reference columns in these columns,
+       referenced tables are also flush targets.
+
+       If there are one or more indexed columns in these columns,
+       tables of corresponding index columns and corresponding index
+       columns are also flush targets.
+
+       Database is also flush target.
+     - Table and its columns::
+
+         io_flush --target_name TABLE_NAME
+
+       A referenced table::
+
+         io_flush --target_name REFERENCED_TABLE_NAME --recursive no
+
+       A table of an index column::
+
+         io_flush --target_name TABLE_NAME_OF_INDEX_COLUMN --recursive no
+
+       An index column::
+
+         io_flush --target_name TABLE_NAME_OF_INDEX_COLUMN.INDEX_COLUMN
+
+       Database::
+
+         io_flush --recursive no
+   * - :doc:`table_create`
+     - Target table and database.
+     - Table::
+
+         io_flush --target_name TABLE_NAME
+
+       Database::
+
+         io_flush --recursive no
+   * - :doc:`table_remove` and :doc:`table_rename`
+     - Database.
+     - Database::
+
+         io_flush --recursive no
+   * - :doc:`column_create`
+     - Target column and database.
+     - Table::
+
+         io_flush --target_name TABLE_NAME.COLUMN_NAME
+
+       Database::
+
+         io_flush --recursive no
+   * - :doc:`column_remove` and :doc:`column_rename`
+     - Database.
+     - Database::
+
+         io_flush --recursive no
+   * - :doc:`plugin_register` and :doc:`plugin_unregister`
+     - Database.
+     - Database::
+
+         io_flush --recursive no
+
 
 Parameters
 ----------
 
-This section describes parameters of ``io_flush``.
+This section describes all parameters.
+
+Required parameters
+^^^^^^^^^^^^^^^^^^^
+
+There is no required parameters.
 
 Optional parameters
 ^^^^^^^^^^^^^^^^^^^
 
 There are optional parameters.
 
+.. _io-flush-target-name:
+
 ``target_name``
 """""""""""""""
 
-TODO
+Specifies a flush target object name. Target object is one of
+database, table or column.
+
+If you omit this parameter, database is flush target object:
+
+.. groonga-command
+.. include:: ../../example/reference/commands/io_flush/target_name_database.log
+.. io_flush
+
+If you specify table name, the table is flush target object:
+
+.. groonga-command
+.. include:: ../../example/reference/commands/io_flush/target_name_table.log
+.. table_create Users TABLE_HASH_KEY ShortText
+.. io_flush --target_name Users
+
+If you specify column name, the column is flush target object:
+
+.. groonga-command
+.. include:: ../../example/reference/commands/io_flush/target_name_column.log
+.. column_create Users age COLUMN_SCALAR UInt8
+.. io_flush --target_name Users.age
+
+.. _io-flush-recursive:
 
 ``recursive``
 """""""""""""
 
-TODO
+Specifies whether child objects of the flush target object are also
+flush target objects.
+
+Child objects of database is all tables and all columns.
+
+Child objects of table is all its columns.
+
+Child objects of column is nothing.
+
+``recursive`` value must be ``yes`` or ``no``. ``yes`` means that all
+of the specified flush target object and child objects are flush
+target objects. ``no`` means that only the specified flush target
+object is flush target object.
+
+The following ``io_flush`` flushes all changes in database, all tables
+and all columns:
+
+.. groonga-command
+.. include:: ../../example/reference/commands/io_flush/recursive_yes.log
+.. io_flush --recursive yes
+
+The following ``io_flush`` flushes all changes only in database:
+
+.. groonga-command
+.. include:: ../../example/reference/commands/io_flush/recursive_no.log
+.. io_flush --recursive no
+
+If you specify other value (not ``yes`` neither ``no``) or omit
+``recursive`` parameter, ``yes`` is used.
+
+``yes`` is used in the following case because invalid ``recursive``
+argument is specified:
+
+.. groonga-command
+.. include:: ../../example/reference/commands/io_flush/recursive_invalid.log
+.. io_flush --recursive invalid
+
+``yes`` is used in the following case because ``recursive`` parameter
+isn't specified:
+
+.. groonga-command
+.. include:: ../../example/reference/commands/io_flush/recursive_default.log
+.. io_flush
 
 Return value
 ------------
 
-::
+The command returns ``true`` as body on success such as::
 
   [HEADER, true]
+
+If the command fails, error details are in ``HEADER``.
+
+See :doc:`/reference/command/output_format` for ``HEADER``.

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

@@ -26,9 +26,7 @@ recursively. The target object is one of database, table and column.
 Syntax
 ------
 
-``truncate`` command takes only one parameter.
-
-There is no required parameter::
+This command takes only one optional parameter::
 
   lock_clear [target_name=null]
 

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

@@ -10,7 +10,7 @@ Summary
 
 log_level - ログ出力レベルの設定
 
-Groonga組込コマンドの一つであるlog_levelについて説明します。組込コマンドは、groonga実行ファイルの引数、標準>入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
+Groonga組込コマンドの一つであるlog_levelについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
 
 log_levelは、ログ出力レベルを設定します。
 

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

@@ -27,7 +27,7 @@ Note that this feature is not matured yet, so there are some limitations.
 Syntax
 ------
 
-``logical_count`` command has seven parameters.
+This command takes many parameters.
 
 The required parameters are ``logical_table`` and ``shard_key``::
 
@@ -168,6 +168,8 @@ Specify ``include`` or ``exclude`` as the value of this parameter.
 Return value
 ------------
 
+TODO
+
 ::
 
   [HEADER, LOGICAL_COUNT]

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

@@ -0,0 +1,138 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+.. groonga-command
+.. database: commands_logical_parameters
+
+``logical_parameters``
+======================
+
+Summary
+-------
+
+.. note::
+
+   This command is an experimental feature.
+
+.. versionadded:: 5.0.6
+
+``logical_parameters`` is a command for test. Normally, you don't need
+to use this command.
+
+``logical_parameters`` provides the following two features:
+
+  * It returns the current parameters for ``logical_*`` commands.
+  * It sets new parameters for ``logical_*`` commands.
+
+Here is a list of parameters:
+
+  * :ref:`logical-parameters-range-index`
+
+.. note::
+
+   The parameters are independent in each thread. (To be exact, each
+   :c:type:`grn_ctx`.) If you want to control the parameters
+   perfectly, you should reduce the max number of threads to ``1`` by
+   :doc:`/reference/commands/thread_limit` while you're using the
+   parameters.
+
+Syntax
+------
+
+This command takes only one optional parameter::
+
+  logical_parameters [range_index=null]
+
+Usage
+-----
+
+You need to register ``sharding`` plugin to use this command:
+
+.. groonga-command
+.. include:: ../../example/reference/commands/logical_parameters/usage_register.log
+.. plugin_register sharding
+
+You can get the all current parameter values by calling without
+parameters:
+
+.. groonga-command
+.. include:: ../../example/reference/commands/logical_parameters/usage_get.log
+.. logical_parameters
+
+You can set new values by calling with parameters:
+
+.. groonga-command
+.. include:: ../../example/reference/commands/logical_parameters/usage_set.log
+.. logical_parameters --range_index never
+
+``logical_parameters`` returns the parameter values before new values
+are set when you set new values.
+
+Parameters
+----------
+
+This section describes parameters.
+
+Required parameters
+^^^^^^^^^^^^^^^^^^^
+
+There is no required parameters.
+
+Optional parameters
+^^^^^^^^^^^^^^^^^^^
+
+There is one optional parameter.
+
+.. _logical-parameters-range-index:
+
+``range_index``
+"""""""""""""""
+
+Specifies how to use range index in :doc:`logical_range_filter` by
+keyword.
+
+Here are available keywords:
+
+  * ``auto`` (default)
+  * ``always``
+  * ``never``
+
+If ``auto`` is specified, range index is used only when it'll be
+efficient. This is the default value.
+
+.. groonga-command
+.. include:: ../../example/reference/commands/logical_parameters/range_index_auto.log
+.. logical_parameters --range_index auto
+
+If ``always`` is specified, range index is always used. It'll be
+useful for testing a case that range index is used.
+
+.. groonga-command
+.. include:: ../../example/reference/commands/logical_parameters/range_index_always.log
+.. logical_parameters --range_index always
+
+If ``never`` is specified, range index is never used. It'll be useful
+for testing a case that range index isn't used.
+
+.. groonga-command
+.. include:: ../../example/reference/commands/logical_parameters/range_index_never.log
+.. logical_parameters --range_index never
+
+Return value
+------------
+
+The command returns the current parameters for ``logical_*`` command::
+
+  [
+    HEADER,
+    {"range_index": HOW_TO_USE_RANGE_INDEX}
+  ]
+
+``HOW_TO_USE_RANGE_INDEX`` value is one of the followings:
+
+  * ``"auto"``
+  * ``"always"``
+  * ``"never"``
+
+See :doc:`/reference/command/output_format` for ``HEADER``.

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

@@ -22,19 +22,31 @@ TODO: Write summary
 Syntax
 ------
 
+This command takes many parameters.
+
 The required parameters are ``logical_table`` and ``shard_key``::
 
   logical_range_filter
-                logical_table
-                shard_key
-                [min]
-                [min_border]
-                [max]
-                [max_border]
-                [order]
-                [filter]
-                [offset]
-                [output_columns]
+    logical_table
+    shard_key
+    [min=null]
+    [min_border=null]
+    [max=null]
+    [max_border=null]
+    [order=ascending]
+    [filter=null]
+    [offset=0]
+    [limit=10]
+    [output_columns=_key,*]
+    [use_range_index=null]
+
+There are some parameters that can be only used as named
+parameters. You can't use these parameters as ordered parameters. You
+must specify parameter name.
+
+Here are parameters that can be only used as named parameters:
+
+  * ``cache=no``
 
 Usage
 -----
@@ -44,6 +56,8 @@ Register ``sharding`` plugin to use ``logical_range_filter`` command in advance.
 .. groonga-command
 .. register sharding
 
+TODO: Add examples
+
 Parameters
 ----------
 
@@ -60,11 +74,15 @@ There are required parameters, ``logical_table`` and ``shard_key``.
 Specifies logical table name. It means table name without "_YYYYMMDD" postfix.
 If you use actual table such as "Logs_20150203", "Logs_20150203" and so on, logical table name is "Logs".
 
+TODO: Add examples
+
 ``shard_key``
 """""""""""""
 
 Specifies column name which is treated as shared key in each parted table.
 
+TODO: Add examples
+
 Optional parameters
 ^^^^^^^^^^^^^^^^^^^
 
@@ -75,38 +93,107 @@ There are optional parameters.
 
 Specifies the min value of ``shard_key``
 
+TODO: Add examples
+
 ``min_border``
 """"""""""""""
 
 Specifies whether the min value of borderline must be include or not.
 Specify ``include`` or ``exclude`` as the value of this parameter.
 
+TODO: Add examples
+
 ``max``
 """""""
 
 Specifies the max value of ``shard_key``.
 
+TODO: Add examples
+
 ``max_border``
 """"""""""""""
 
 Specifies whether the max value of borderline must be include or not.
 Specify ``include`` or ``exclude`` as the value of this parameter.
 
+TODO: Add examples
+
 ``order``
 """"""""""
 
+TODO
+
 ``filter``
 """"""""""
 
+TODO
+
 ``offset``
 """"""""""
 
+TODO
+
+``limit``
+"""""""""
+
+TODO
+
 ``output_columns``
 """"""""""""""""""
 
+TODO
+
+``use_range_index``
+"""""""""""""""""""
+
+Specifies whether range_index is used or not.
+Note that it's a parameter for test. It should not be used for production.
+
+TODO: Add examples
+
+Cache related parameter
+^^^^^^^^^^^^^^^^^^^^^^^
+
+.. _logical-range-filter-cache:
+
+``cache``
+"""""""""
+
+Specifies whether caching the result of this query or not.
+
+If the result of this query is cached, the next same query returns
+response quickly by using the cache.
+
+It doesn't control whether existing cached result is used or not.
+
+Here are available values:
+
+.. list-table::
+   :header-rows: 1
+
+   * - Value
+     - Description
+   * - ``no``
+     - Don't cache the output of this query.
+   * - ``yes``
+     - Cache the output of this query.
+       It's the default value.
+
+TODO: Add examples
+
+.. Here is an example to disable caching the result of this query:
+
+.. .. groonga-command
+.. .. include:: ../../example/reference/commands/logical_range_filter/cache_no.log
+.. .. logical_range_filter ... --cache no
+
+The default value is ``yes``.
+
 Return value
 ------------
 
+TODO
+
 ::
 
   [HEADER, LOGICAL_FILTERED]