rroonga 7.0.2-x86-mingw32 → 7.1.1-x86-mingw32

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

@@ -1,113 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-.. groonga-command
-.. database: commands_table_shutdown
-
-``shutdown``
-============
-
-Summary
--------
-
-``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
-
-   ``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.
-
-
-Syntax
-------
-
-This command takes only one optional parameter::
-
-  shutdown [mode=graceful]
-
-Usage
------
-
-``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

@@ -1,151 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-.. groonga-command
-.. database: commands_status
-
-``status``
-==========
-
-Summary
--------
-
-``status`` returns the current status of the context that processes
-the request.
-
-Context is an unit that processes requests. Normally, context is
-created for each thread.
-
-Syntax
-------
-
-This command takes no parameters::
-
-  status
-
-.. _status-usage:
-
-Usage
------
-
-Here is a simple example:
-
-.. groonga-command
-.. include:: ../../example/reference/commands/status.log
-.. status
-
-It returns the current status of the context that processes the
-request. See :ref:`status-return-value` for details.
-
-Parameters
-----------
-
-This section describes all parameters.
-
-Required parameters
-^^^^^^^^^^^^^^^^^^^
-
-There is no required parameter.
-
-Optional parameters
-^^^^^^^^^^^^^^^^^^^
-
-There is no optional parameter.
-
-.. _status-return-value:
-
-Return value
-------------
-
-The command returns the current status as an object::
-
-  [
-    HEADER,
-    {
-      "alloc_count": ALLOC_COUNT,
-      "cache_hit_rate": CACHE_HIT_RATE,
-      "command_version": COMMAND_VERSION,
-      "default_command_version": DEFAULT_COMMAND_VERSION,
-      "max_command_version": MAX_COMMAND_VERSION,
-      "n_queries": N_QUERIES,
-      "start_time": START_TIME,
-      "starttime": STARTTIME,
-      "uptime": UPTIME,
-      "version": VERSION
-    }
-  ]
-
-See :doc:`/reference/command/output_format` for ``HEADER``.
-
-Here are descriptions about values. See :ref:`status-usage` for real
-values:
-
-.. list-table::
-   :header-rows: 1
-
-   * - Key
-     - Description
-     - Example
-   * - ``alloc_count``
-     - The number of allocated memory blocks that aren't freed.  If
-       this value is continuously increased, there may be a memory
-       leak.
-     - ``1400``
-   * - ``cache_hit_rate``
-     - Percentage of cache used responses in the Groonga process. If
-       there are 10 requests and 7 responses are created from cache,
-       ``cache_hit_rate`` is ``70.0``. The percentage is computed from
-       only requests that use commands that support cache.
-
-       Here are commands that support cache:
-
-         * :doc:`select`
-         * :doc:`logical_select`
-         * :doc:`logical_range_filter`
-         * :doc:`logical_count`
-
-     - ``29.4``
-   * - ``command_version``
-     - The :doc:`/reference/command/command_version` that is used by
-       the context.
-     - ``1``
-   * - ``default_command_version``
-     - The default :doc:`/reference/command/command_version` of the
-       Groonga process.
-     - ``1``
-   * - ``max_command_version``
-     - The max :doc:`/reference/command/command_version` of the
-       Groonga process.
-     - ``2``
-   * - ``n_queries``
-     - The number of requests processed by the Groonga process. It
-       counts only requests that use commands that support cache.
-
-       Here are commands that support cache:
-
-         * :doc:`select`
-         * :doc:`logical_select`
-         * :doc:`logical_range_filter`
-         * :doc:`logical_count`
-
-     - ``29``
-   * - ``start_time``
-     - .. versionadded:: 5.0.8
-
-       The time that the Groonga process started in UNIX time.
-     - ``1441761403``
-   * - ``starttime``
-     - .. deprecated:: 5.0.8
-          Use ``start_time`` instead.
-     - ``1441761403``
-   * - ``uptime``
-     - The elapsed time since the Groonga process started in second.
-
-       For example, ``216639`` means that ``2.5`` (= ``216639 / 60 /
-       60 / 24 = 2.507``) days.
-
-     - ``216639``
-   * - ``version``
-     - The version of the Groonga process.
-     - ``5.0.7``

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

@@ -1,271 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-.. groonga-command
-.. % groonga-suggest-create-dataset /tmp/groonga-databases/suggest query
-.. database: suggest
-
-``suggest``
-===========
-
-.. note::
-
-   The suggest feature specification isn't stable. The
-   specification may be changed.
-
-Summary
--------
-
-suggest - returns completion, correction and/or suggestion for a query.
-
-The suggest command returns completion, correction and/or
-suggestion for a specified query.
-
-See :doc:`/reference/suggest/introduction` about completion,
-correction and suggestion.
-
-Syntax
-------
-::
-
- 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
------
-
-Here are learned data for completion.
-
-.. groonga-command
-.. include:: ../../example/reference/commands/suggest-learn-completion.log
-.. load --table event_query --each 'suggest_preparer(_id, type, item, sequence, time, pair_query)'
-.. [
-.. {"sequence": "1", "time": 1312950803.86057, "item": "e"},
-.. {"sequence": "1", "time": 1312950803.96857, "item": "en"},
-.. {"sequence": "1", "time": 1312950804.26057, "item": "eng"},
-.. {"sequence": "1", "time": 1312950804.56057, "item": "engi"},
-.. {"sequence": "1", "time": 1312950804.76057, "item": "engin"},
-.. {"sequence": "1", "time": 1312950805.86057, "item": "engine", "type": "submit"}
-.. ]
-
-Here are learned data for correction.
-
-.. groonga-command
-.. include:: ../../example/reference/commands/suggest-learn-correction.log
-.. {"sequence": "2", "time": 1312950803.86057, "item": "s"},
-.. {"sequence": "2", "time": 1312950803.96857, "item": "sa"},
-.. {"sequence": "2", "time": 1312950804.26057, "item": "sae"},
-.. {"sequence": "2", "time": 1312950804.56057, "item": "saer"},
-.. {"sequence": "2", "time": 1312950804.76057, "item": "saerc"},
-.. {"sequence": "2", "time": 1312950805.76057, "item": "saerch", "type": "submit"},
-.. {"sequence": "2", "time": 1312950809.76057, "item": "serch"},
-.. {"sequence": "2", "time": 1312950810.86057, "item": "search", "type": "submit"}
-.. ]
-
-Here are learned data for suggestion.
-
-.. groonga-command
-.. include:: ../../example/reference/commands/suggest-learn-suggestion.log
-.. load --table event_query --each 'suggest_preparer(_id, type, item, sequence, time, pair_query)'
-.. [
-.. {"sequence": "3", "time": 1312950803.86057, "item": "search engine", "type": "submit"},
-.. {"sequence": "3", "time": 1312950808.86057, "item": "web search realtime", "type": "submit"}
-.. ]
-
-Here is a completion example.
-
-.. groonga-command
-.. include:: ../../example/reference/commands/suggest-completion.log
-.. suggest --table item_query --column kana --types complete --frequency_threshold 1 --query en
-
-Here is a correction example.
-
-.. groonga-command
-.. include:: ../../example/reference/commands/suggest-correction.log
-.. suggest --table item_query --column kana --types correct --frequency_threshold 1 --query saerch
-
-Here is a suggestion example.
-
-.. groonga-command
-.. include:: ../../example/reference/commands/suggest-suggestion.log
-.. suggest --table item_query --column kana --types suggest --frequency_threshold 1 --query search
-
-Here is a mixed example.
-
-.. groonga-command
-.. include:: ../../example/reference/commands/suggest-mixed.log
-.. suggest --table item_query --column kana --types complete|correct|suggest --frequency_threshold 1 --query search
-
-Parameters
-----------
-
-``types``
-  Specifies what types are returned by the suggest
-  command.
-
-  Here are available types:
-
-    ``complete``
-      The suggest command does completion.
-
-    ``correct``
-      The suggest command does correction.
-
-    ``suggest``
-      The suggest command does suggestion.
-
-  You can specify one or more types separated by ``|``.
-  Here are examples:
-
-    It returns correction::
-
-      correct
-
-    It returns correction and suggestion::
-
-      correct|suggest
-
-    It returns complete, correction and suggestion::
-
-      complete|correct|suggest
-
-``table``
-  Specifies table name that has ``item_${DATA_SET_NAME}`` format.
-  For example, ``item_query`` is a table name if you created
-  dataset by the following command::
-
-    groonga-suggest-create-dataset /tmp/db-path query
-
-``column``
-  Specifies a column name that has furigana in
-  Katakana in ``table`` table.
-
-``query``
-  Specifies query for completion, correction and/or
-  suggestion.
-
-``sortby``
-  Specifies sort key.
-
-  Default:
-    ``-_score``
-
-``output_columns``
-  Specifies output columns.
-
-  Default:
-    ``_key,_score``
-
-``offset``
-  Specifies returned records offset.
-
-  Default:
-    ``0``
-
-``limit``
-  Specifies number of returned records.
-
-  Default:
-    ``10``
-
-``frequency_threshold``
-  Specifies threshold for item frequency. Returned records must have
-  ``_score`` that is greater than or equal to ``frequency_threshold``.
-
-  Default:
-    ``100``
-
-``conditional_probability_threshold``
-
-  Specifies threshold for conditional
-  probability. Conditional probability is used for learned
-  data. It is probability of query submission when ``query``
-  is occurred. Returned records must have conditional
-  probability that is greater than or equal to
-  ``conditional_probability_threshold``.
-
-  Default:
-    ``0.2``
-
-``prefix_search``
-  Specifies whether optional prefix search is used or not
-  in completion.
-
-  Here are available values:
-
-    ``yes``
-      Prefix search is always used.
-
-    ``no``
-      Prefix search is never used.
-
-    ``auto``
-      Prefix search is used only when other search can't
-      find any records.
-
-  Default:
-    ``auto``
-
-``similar_search``
-  Specifies whether optional similar search is used or not
-  in correction.
-
-  Here are available values:
-
-    ``yes``
-      Similar search is always used.
-
-    ``no``
-      Similar search is never used.
-
-    ``auto``
-      Similar search is used only when other search can't
-      find any records.
-
-  Default:
-    ``auto``
-
-Return value
-------------
-
-Here is a returned JSON format::
-
- {"type1": [["candidate1", score of candidate1],
-            ["candidate2", score of candidate2],
-            ...],
-  "type2": [["candidate1", score of candidate1],
-            ["candidate2", score of candidate2],
-            ...],
-  ...}
-
-``type``
-
-  A type specified by ``types``.
-
-``candidate``
-
-  A candidate for completion, correction or suggestion.
-
-``score of candidate``
-
-  A score of corresponding ``candidate``. It means that
-  higher score candidate is more likely candidate for
-  completion, correction or suggestion. Returned candidates
-  are sorted by ``score of candidate`` descending by
-  default.
-
-See also
---------
-
-* :doc:`/reference/suggest`
-* :doc:`/reference/executables/groonga-suggest-create-dataset`