rroonga 5.0.0-x86-mingw32 → 5.0.1-x86-mingw32

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

@@ -0,0 +1,112 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+.. groonga-command
+.. database: logical_range_filter
+
+``logical_range_filter``
+========================
+
+Summary
+-------
+
+.. note::
+
+   This command is an experimental feature.
+
+.. versionadded:: 5.0.0
+
+TODO: Write summary
+
+Syntax
+------
+
+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]
+
+Usage
+-----
+
+Register ``sharding`` plugin to use ``logical_range_filter`` command in advance.
+
+.. groonga-command
+.. register sharding
+
+Parameters
+----------
+
+This section describes parameters of ``logical_range_filter``.
+
+Required parameter
+^^^^^^^^^^^^^^^^^^
+
+There are required parameters, ``logical_table`` and ``shard_key``.
+
+``logical_table``
+"""""""""""""""""
+
+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".
+
+``shard_key``
+"""""""""""""
+
+Specifies column name which is treated as shared key in each parted table.
+
+Optional parameters
+^^^^^^^^^^^^^^^^^^^
+
+There are optional parameters.
+
+``min``
+"""""""
+
+Specifies the min value of ``shard_key``
+
+``min_border``
+""""""""""""""
+
+Specifies whether the min value of borderline must be include or not.
+Specify ``include`` or ``exclude`` as the value of this parameter.
+
+``max``
+"""""""
+
+Specifies the max value of ``shard_key``.
+
+``max_border``
+""""""""""""""
+
+Specifies whether the max value of borderline must be include or not.
+Specify ``include`` or ``exclude`` as the value of this parameter.
+
+``order``
+""""""""""
+
+``filter``
+""""""""""
+
+``offset``
+""""""""""
+
+``output_columns``
+""""""""""""""""""
+
+Return value
+------------
+
+::
+
+  [HEADER, LOGICAL_FILTERED]

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

@@ -8,10 +8,11 @@
 ``normalize``
 =============
 
-.. Caution::
+.. note::
 
-  ``normalize`` command is the experimental feature.
-  This command may be changed in the future.
+   This command is an experimental feature.
+
+   This command may be changed in the future.
 
 Summary
 -------
@@ -55,7 +56,7 @@ There are required parameters, ``normalizer`` and ``string``.
 ``normalizer``
 """"""""""""""
 
-It specifies the normalizer name. ``normalize`` command uses the
+Specifies the normalizer name. ``normalize`` command uses the
 normalizer that is named ``normalizer``.
 
 See :doc:`/reference/normalizers` about built-in normalizers.
@@ -72,7 +73,7 @@ MySQL compatible normalizer by registering `groonga-normalizer-mysql
 ``string``
 """"""""""
 
-It specifies any string which you want to normalize.
+Specifies any string which you want to normalize.
 
 If you want to include spaces in ``string``, you need to quote
 ``string`` by single quotation (``'``) or double quotation (``"``).
@@ -89,7 +90,7 @@ There are optional parameters.
 ``flags``
 """""""""
 
-It specifies a normalization customize options. You can specify
+Specifies a normalization customize options. You can specify
 multiple options separated by "``|``". For example,
 ``REMOVE_BLANK|WITH_TYPES``.
 

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

@@ -0,0 +1,64 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+.. groonga-command
+.. database: commands_plugin_register
+
+``plugin_register``
+===================
+
+.. versionadded:: 5.0.1
+
+Summary
+-------
+
+``plugin_register`` command registers a plugin. You need to register a plugin
+before you use a plugin.
+
+You need just one ``plugin_register`` command for a plugin in the same
+database because registered plugin information is written into the
+database.  When you restart your ``groonga`` process, ``groonga``
+process loads all registered plugins without ``plugin_register`` command.
+
+You can unregister a registered plugin by :doc:`plugin_unregister`.
+
+Syntax
+------
+
+``plugin_register`` has a parameter ``name``. It is required parameter::
+
+  plugin_register name
+
+Usage
+-----
+
+Here is a sample that registers ``QueryExpanderTSV`` query expander
+that is included in
+``${PREFIX}/lib/groonga/plugins/query_expanders/tsv.so``.
+
+.. groonga-command
+.. include:: ../../example/reference/commands/plugin_register/query_expanders_tsv.log
+.. plugin_register query_expanders/tsv
+
+You can omit ``${PREFIX}/lib/groonga/plugins/`` and suffix (``.so``).
+They are completed automatically.
+
+You can specify absolute path such as ``plugin_register
+/usr/lib/groonga/plugins/query_expanders/tsv.so``.
+
+Return value
+------------
+
+``plugin_register`` returns ``true`` as body on success such as::
+
+  [HEADER, true]
+
+If ``plugin_register`` fails, error details are in ``HEADER``.
+
+See :doc:`/reference/command/output_format` for ``HEADER``.
+
+See also
+--------
+
+* :doc:`plugin_unregister`

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

@@ -0,0 +1,63 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+.. groonga-command
+.. database: commands_plugin_unregister
+
+``plugin_unregister``
+=====================
+
+.. note::
+
+   This command is an experimental feature.
+
+.. versionadded:: 5.0.1
+
+Summary
+-------
+
+``plugin_unregister`` command unregisters a plugin.
+
+Syntax
+------
+
+``plugin_unregister`` has a parameter ``name``. It is required parameter::
+
+  plugin_unregister name
+
+Usage
+-----
+
+Here is a sample that unregisters ``QueryExpanderTSV`` query expander
+that is included in
+``${PREFIX}/lib/groonga/plugins/query_expanders/tsv.so``.
+
+.. groonga-command
+.. plugin_register query_expanders/tsv
+
+.. groonga-command
+.. include:: ../../example/reference/commands/plugin_unregister/query_expanders_tsv.log
+.. plugin_unregister query_expanders/tsv
+
+You can omit ``${PREFIX}/lib/groonga/plugins/`` and suffix (``.so``).
+They are completed automatically.
+
+You can specify absolute path such as ``plugin_unregister
+/usr/lib/groonga/plugins/query_expanders/tsv.so``.
+
+Return value
+------------
+
+``plugin_unregister`` returns ``true`` as body on success such as::
+
+  [HEADER, true]
+
+If ``plugin_unregister`` fails, error details are in ``HEADER``.
+
+See :doc:`/reference/command/output_format` for ``HEADER``.
+
+See also
+--------
+
+* :doc:`plugin_unregister`

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

@@ -8,6 +8,9 @@
 ``register``
 ============
 
+.. deprecated:: 5.0.1
+   Use :doc:`plugin_register` instead.
+
 Summary
 -------
 
@@ -21,7 +24,8 @@ process loads all registered plugins without ``register`` command.
 
 .. note::
 
-   Registered plugins can't be removed for now.
+   Registered plugins can be removed since Groonga 5.0.1. Use
+   :doc:`plugin_unregister` in such a case.
 
 Syntax
 ------
@@ -57,3 +61,9 @@ Return value
 If ``register`` fails, error details are in ``HEADER``.
 
 See :doc:`/reference/command/output_format` for ``HEADER``.
+
+See also
+--------
+
+* :doc:`plugin_register`
+* :doc:`plugin_unregister`

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

@@ -9,7 +9,8 @@ Summary
 -------
 
 .. note::
-   ``request_cancel`` command is an experimental feature.
+
+   This command is an experimental feature.
 
 .. versionadded:: 4.0.9
 
@@ -97,7 +98,7 @@ There is required parameter, ``id``.
 ``id``
 """"""
 
-It specifies the ID for the target request.
+Specifies the ID for the target request.
 
 Return value
 ------------

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

@@ -45,7 +45,7 @@ This section describes all parameters.
 ``script``
 """"""""""
 
-It specifies the Ruby script which you want to evaluate.
+Specifies the Ruby script which you want to evaluate.
 
 Return value
 ------------

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

@@ -45,7 +45,7 @@ This section describes all parameters.
 ``path``
 """"""""
 
-It specifies the Ruby script path which you want to load.
+Specifies the Ruby script path which you want to load.
 
 Return value
 ------------

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

@@ -297,7 +297,7 @@ There is a required parameter, ``table``.
 ``table``
 """""""""
 
-It specifies a table to be searched. ``table`` must be specified.
+Specifies a table to be searched. ``table`` must be specified.
 
 If nonexistent table is specified, an error is returned.
 
@@ -322,7 +322,7 @@ and ``filter`` aren't specified, all records are selected.
 ``match_columns``
 """""""""""""""""
 
-It specifies the default target column for fulltext search by
+Specifies the default target column for fulltext search by
 ``query`` parameter value. A target column for fulltext search can be
 specified in ``query`` parameter. The difference between
 ``match_columns`` and ``query`` is whether weight is supported or
@@ -391,7 +391,7 @@ of blog entry is more important rather thatn content of blog entry.
 ``query``
 """""""""
 
-It specifies the query text. Normally, it is used for fulltext search
+Specifies the query text. Normally, it is used for fulltext search
 with ``match_columns`` parameter. ``query`` parameter is designed for
 a fulltext search form in a Web page. A query text should be formatted
 in :doc:`/reference/grn_expr/query_syntax`. The syntax is similar to common search
@@ -452,7 +452,7 @@ See :doc:`/reference/grn_expr/query_syntax` for other operations.
 ``filter``
 """"""""""
 
-It specifies the filter text. Normally, it is used for complex search
+Specifies the filter text. Normally, it is used for complex search
 conditions. ``filter`` can be used with ``query`` parameter. If both
 ``filter`` and ``query`` are specified, there are conbined with
 logical and. It means that matched records should be matched against
@@ -493,7 +493,7 @@ Advanced search parameters
 ``match_escalation_threshold``
 """"""""""""""""""""""""""""""
 
-It specifies threshold to determine whether search storategy
+Specifies threshold to determine whether search storategy
 escalation is used or not. The threshold is compared against the
 number of matched records. If the number of matched records is equal
 to or less than the threshold, the search storategy escalation is
@@ -740,7 +740,7 @@ Output related parameters
 ``output_columns``
 """"""""""""""""""
 
-It specifies output columns separated by ``,``.
+Specifies output columns separated by ``,``.
 
 Here is a simple ``output_columns`` usage example.
 
@@ -772,7 +772,7 @@ values except ``_score`` are outputted.
 ``sortby``
 """"""""""
 
-It specifies sort keys separated by ``,``. Each sort key is column
+Specifies sort keys separated by ``,``. Each sort key is column
 name.
 
 Here is a simple ``sortby`` usage example.
@@ -815,7 +815,7 @@ it's just ignored but get a warning in log file.
 ``offset``
 """"""""""
 
-It specifies offset to determine output records range. Offset is
+Specifies offset to determine output records range. Offset is
 zero-based. ``--offset 1`` means output range is started from the 2nd
 record.
 
@@ -843,7 +843,7 @@ The default value is ``0``.
 ``limit``
 """""""""
 
-It specifies the max number of output records. If the number of
+Specifies the max number of output records. If the number of
 matched records is less than ``limit``, all records are outputted.
 
 Here is a simple ``limit`` usage example.
@@ -890,7 +890,7 @@ drilldown related parameters are described in another section.
 ``drilldown``
 """""""""""""
 
-It specifies keys for grouping separated by ``,``.
+Specifies keys for grouping separated by ``,``.
 
 Matched records by specified search conditions are grouped by each
 key. If you specify no search condition, all records are grouped by
@@ -954,7 +954,7 @@ The ``select`` command outputs the following information:
 ``drilldown_sortby``
 """"""""""""""""""""
 
-It specifies sort keys for drilldown outputs separated by ``,``. Each
+Specifies sort keys for drilldown outputs separated by ``,``. Each
 sort key is column name.
 
 You can refer the number of grouped records by ``_nsubrecs``
@@ -996,7 +996,7 @@ If you want to use different sort keys for each drilldown, use
 ``drilldown_output_columns``
 """"""""""""""""""""""""""""
 
-It specifies output columns for drilldown separated by ``,``.
+Specifies output columns for drilldown separated by ``,``.
 
 Here is a ``drilldown_output_columns`` example:
 
@@ -1079,7 +1079,7 @@ You can use more :doc:`/reference/columns/pseudo` in
 ``drilldown_offset``
 """"""""""""""""""""
 
-It specifies offset to determine range of drilldown output
+Specifies offset to determine range of drilldown output
 records. Offset is zero-based. ``--drilldown_offset 1`` means output
 range is started from the 2nd record.
 
@@ -1121,7 +1121,7 @@ The default value of ``drilldown_offset`` is ``0``.
 ``drilldown_limit``
 """""""""""""""""""
 
-It specifies the max number of groups in a drilldown. If the number of
+Specifies the max number of groups in a drilldown. If the number of
 groups is less than ``drilldown_limit``, all groups are outputted.
 
 Here is a ``drilldown_limit`` example:
@@ -1162,7 +1162,7 @@ The default value of ``drilldown_limit`` is ``10``.
 ``drilldown_calc_types``
 """"""""""""""""""""""""
 
-It specifies how to calculate (aggregate) values in grouped records by
+Specifies how to calculate (aggregate) values in grouped records by
 a drilldown. You can specify multiple calculation types separated by
 "``,``". For example, ``MAX,MIN``.
 
@@ -1309,7 +1309,7 @@ that only ``COUNT`` is enabled. Because ``NONE`` is just ignored and
 ``drilldown_calc_target``
 """""""""""""""""""""""""
 
-It specifies the target column for :ref:`select-drilldown-calc-types`.
+Specifies the target column for :ref:`select-drilldown-calc-types`.
 
 If you specify a calculation type that needs a target column such as
 ``MAX`` in :ref:`select-drilldown-calc-types` but you omit
@@ -1555,7 +1555,7 @@ There is a score related parameter, ``adjuster``.
 ``adjuster``
 """"""""""""
 
-It specifies one or more score adjust expressions. You need to use
+Specifies one or more score adjust expressions. You need to use
 ``adjuster`` with ``query`` or ``filter``. ``adjuster`` doesn't work
 with not searched request.