rroonga 4.0.7-x64-mingw32 → 4.0.8-x64-mingw32

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

@@ -0,0 +1,139 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+``request_cancel``
+==================
+
+Summary
+-------
+
+.. note::
+   ``request_cancel`` command is an experimental feature.
+
+.. versionadded:: 4.0.9
+
+``request_cancel`` command cancels a running request.
+
+There are some limitations:
+
+  * Request ID must be managed by user. (You need to assign unique key
+    for each request.)
+  * Cancel request may be ignored. (You can send ``request_cancel``
+    command multiple times for the same request ID.)
+  * Only multithreading type Groonga server is supported. (You can use
+    with :doc:`/reference/executables/groonga` based server but can't
+    use with :doc:`/reference/executables/groonga-httpd`.)
+
+See :doc:`/reference/command/request_id` about request ID.
+
+If request is canceled, the canceled request has ``-5``
+(``GRN_INTERRUPTED_FUNCTION_CALL``) as
+:doc:`/reference/command/return_code`.
+
+Syntax
+------
+
+``request_cancel`` command takes only one parameter.
+
+The required parameter is only ``id``::
+
+  request_cancel id
+
+Usage
+-----
+
+Here is an example of ``request_cancel`` command::
+
+  $ curl 'http://localhost:10041/d/select?table=LargeTable&filter=true&request_id=unique-id-1' &
+  # The above "select" takes a long time...
+  # Point: "request_id=unique-id-1"
+  $ curl 'http://localhost:10041/d/request_cancel?id=unique-id-1'
+  [[...], {"id": "unique-id-1", "canceled": true}]
+  # Point: "id=unique-id-1"
+
+Assume that the first ``select`` command takes a long
+time. ``unique-id-1`` request ID is assigned to the ``select`` command
+by ``request_id=unique-id-1`` parameter.
+
+The second ``request_cancel`` command passes ``id=unique-id-1``
+parameter. ``unique-id-1`` is the same request ID passed in ``select``
+command.
+
+The ``select`` command may not be canceled immediately. And the cancel
+request may be ignored.
+
+You can send cancel request for the same request ID multiple times. If
+the target request is canceled or finished, ``"canceled"`` value is
+changed to ``false`` from ``true``::
+
+  $ curl 'http://localhost:10041/d/request_cancel?id=unique-id-1'
+  [[...], {"id": "unique-id-1", "canceled": true}]
+  # "select" is still running... ("canceled" is "true")
+  $ curl 'http://localhost:10041/d/request_cancel?id=unique-id-1'
+  [[...], {"id": "unique-id-1", "canceled": true}]
+  # "select" is still running... ("canceled" is "true")
+  $ curl 'http://localhost:10041/d/request_cancel?id=unique-id-1'
+  [[...], {"id": "unique-id-1", "canceled": false}]
+  # "select" is canceled or finished. ("canceled" is "false")
+
+If the ``select`` command is canceled, response of the ``select``
+command has ``-5`` (``GRN_INTERRUPTED_FUNCTION_CALL``) as
+:doc:`/reference/command/return_code`::
+
+  $ curl 'http://localhost:10041/d/select?table=LargeTable&filter=true&request_id=unique-id-1' &
+  [[-5, ...], ...]
+
+Parameters
+----------
+
+This section describes parameters of ``request_cancel``.
+
+Required parameter
+^^^^^^^^^^^^^^^^^^
+
+There is required parameter, ``id``.
+
+``id``
+""""""
+
+It specifies the ID for the target request.
+
+Return value
+------------
+
+``request_cancel`` command returns the result of the cancel request::
+
+  [
+    HEADER,
+    {
+      "id":       ID,
+      "canceled": CANCEL_REQUEST_IS_ACCEPTED_OR_NOT
+    }
+  ]
+
+``HEADER``
+
+  See :doc:`/reference/command/output_format` about ``HEADER``.
+
+``ID``
+
+  The ID of the target request.
+
+``CANCEL_REQUEST_IS_ACCEPTED_OR_NOT``
+
+  If the cancel request is accepted, this is ``true``, otherwise this
+  is ``false``.
+
+  Note that "cancel request is accepted" doesn't means that "the
+  target request is canceled". It just means "cancel request is
+  notified to the target request but the cancel request may be ignored
+  by the target request".
+
+  If request assigned with the request ID doesn't exist, this is
+  ``false``.
+
+See also
+--------
+
+* :doc:`/reference/command/request_id`

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

@@ -2,34 +2,42 @@
 
 .. highlightlang:: none
 
-.. groonga-command
-.. database: commands_truncate
-
 ``truncate``
 ============
 
 Summary
 -------
 
-``truncate`` command deletes all records from specified table.
+``truncate`` command deletes all records from specified table or all
+values from specified column.
 
 Syntax
 ------
 
 ``truncate`` command takes only one parameter.
 
-The required parameter is only ``table``::
+The required parameter is only ``target_name``::
+
+  truncate target_name
+
+.. versionadded:: 4.0.9
+
+   ``target_name`` parameter can be used since 4.0.9. You need to use
+   ``table`` parameter for 4.0.8 or earlier.
 
-  truncate table
+   For backward compatibility, ``truncate`` command accepts ``table``
+   parameter. But it should not be used for newly written code.
 
 Usage
 -----
 
-Here is a simple example of ``truncate`` command.
+Here is a simple example of ``truncate`` command against a table.
 
 .. groonga-command
-.. include:: ../../example/reference/commands/truncate/truncate.log
+.. database: commands_truncate_table
+.. include:: ../../example/reference/commands/truncate/truncate_table.log
 .. table_create Users TABLE_PAT_KEY ShortText
+.. column_create Users score COLUMN_SCALAR Int32
 .. load --table Users
 .. [
 .. {"_key": "Alice",  "score": 2},
@@ -40,6 +48,23 @@ Here is a simple example of ``truncate`` command.
 .. truncate Users
 .. select Users
 
+Here is a simple example of ``truncate`` command against a column.
+
+.. groonga-command
+.. database: commands_truncate_column
+.. include:: ../../example/reference/commands/truncate/truncate_column.log
+.. table_create Users TABLE_PAT_KEY ShortText
+.. column_create Users score COLUMN_SCALAR Int32
+.. load --table Users
+.. [
+.. {"_key": "Alice",  "score": 2},
+.. {"_key": "Bob",    "score": 0},
+.. {"_key": "Carlos", "score": -1}
+.. ]
+.. select Users
+.. truncate Users.score
+.. select Users
+
 Parameters
 ----------
 
@@ -48,19 +73,19 @@ This section describes parameters of ``truncate``.
 Required parameter
 ^^^^^^^^^^^^^^^^^^
 
-There is required parameter, ``table_name``.
+There is required parameter, ``target_name``.
 
-``table_name``
-""""""""""""""
+``target_name``
+"""""""""""""""
 
-It specifies the name of table.
+It specifies the name of table or column.
 
 Return value
 ------------
 
-::
+``truncate`` command returns whether truncation is succeeded or not::
 
- [HEADER, SUCCEEDED_OR_NOT]
+  [HEADER, SUCCEEDED_OR_NOT]
 
 ``HEADER``
 

data/vendor/local/share/doc/groonga/en/html/_sources/reference/executables/grndb.txt

@@ -0,0 +1,84 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+``grndb``
+=========
+
+Summary
+-------
+
+.. note::
+
+   This executable command is an experimental feature.
+
+.. versionadded:: 4.0.9
+
+``grndb`` manages a Groonga database.
+
+Here are features:
+
+  * Checks whether database is broken or not.
+  * Recovers broken database automatically if the database is
+    recoverable.
+
+Syntax
+------
+
+``grndb`` requires command and database path::
+
+  grndb COMMAND [OPTIONS] DATABASE_PATH
+
+Here are available commands:
+
+  * ``check`` - Checks whether database is broken or not.
+  * ``recover`` - Recovers database.
+
+Usage
+-----
+
+Here is an example to check the database at ``/var/lib/groonga/db/db``::
+
+  $ grndb check /var/lib/groonga/db/db
+
+Here is an example to recover the database at ``/var/lib/groonga/db/db``::
+
+  $ grndb recover /var/lib/groonga/db/db
+
+Commands
+--------
+
+This section describes available commands.
+
+``check``
+"""""""""
+
+It checks an existing Groonga database. If the database is broken,
+``grndb`` reports reasons and exits with non-``0`` exit status.
+
+.. note::
+
+   You must not use this command for opened database. If the database
+   is opened, this command may report wrong result.
+
+``recover``
+"""""""""""
+
+It recovers an existing broken Groonga database.
+
+If the database is not broken, ``grndb`` does nothing and exits with
+``0`` exit status.
+
+If the database is broken and one or more index columns are only
+broken, ``grndb`` recovers these index columns and exists with ``0``
+exit status. It may take a long time for large indexed data.
+
+If the database is broken and tables or data columns are broken,
+``grndb`` reports broken reasons and exits with non-``0`` exit
+status. You can know whether the database is recoverable or not by
+``check`` command.
+
+.. note::
+
+   You must not use this command for opened database. If the database
+   is opened, this command may break the database.

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

@@ -119,28 +119,9 @@ Here is an example that uses ``NormalizerNFKC51`` normalizer:
 Additional normalizers
 ----------------------
 
-Here is a list of additional normalizers provided by ``groonga-normalizer-mysql`` plugins:
-
-  * ``NormalizerMySQLGeneralCI``
-  * ``NormalizerMySQLUnicodeCI``
-  * ``NormalizerMySQLUnicodeCIExceptKanaCIKanaWithVoicedSoundMark``
-
-``groonga-normalizer-mysql`` is a Groonga plugin.
-It provides MySQL compatible normalizers to Groonga.
-``NormalizerMySQLGeneralCI`` corresponds to ``utf8mb4_general_ci``.
-
-You need to register ``normalizers/mysql`` plugin in advance.
-
-.. groonga-command
-.. include:: ../example/reference/normalizers/normalizer-mysql-register.log
-.. register normalizers/mysql
-
-Here is an example that uses ``NormalizerMySQLGeneralCI`` normalizer:
-
-.. groonga-command
-.. include:: ../example/reference/normalizers/normalizer-mysql-genral-ci.log
-.. table_create MySQLGeneralLexicon TABLE_HASH_KEY ShortText --normalizer NormalizerMySQLGeneralCI
+There are additional normalizers:
 
+  * `groonga-normalizer-mysql <https://github.com/groonga/groonga-normalizer-mysql>_`
 
 See also
 --------

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

@@ -2,9 +2,6 @@
 
 .. highlightlang:: none
 
-.. groonga-command
-.. database: token_filters
-
 Token filters
 =============
 
@@ -25,8 +22,13 @@ Here is an example ``table_create`` that uses ``TokenFilterStopWord``
 token filter module:
 
 .. groonga-command
+.. database: token_filters_example
 .. include:: ../example/reference/token_filters/example-table-create.log
-.. table_create Terms TABLE_PAT_KEY ShortText --default_tokenizer TokenBigram --normalizer NormalizerAuto --token_filters TokenFilterStopWord
+.. register token_filters/stop_word
+.. table_create Terms TABLE_PAT_KEY ShortText \
+..   --default_tokenizer TokenBigram \
+..   --normalizer NormalizerAuto \
+..   --token_filters TokenFilterStopWord
 
 Available token filters
 -----------------------
@@ -52,11 +54,15 @@ The stop word is specified ``is_stop_word`` column on lexicon table.
 Here is an example that uses ``TokenFilterStopWord`` token filter:
 
 .. groonga-command
+.. database: token_filters_stop_word
 .. include:: ../example/reference/token_filters/stop_word.log
 .. register token_filters/stop_word
 .. table_create Memos TABLE_NO_KEY
 .. column_create Memos content COLUMN_SCALAR ShortText
-.. table_create Terms TABLE_PAT_KEY ShortText   --default_tokenizer TokenBigram   --normalizer NormalizerAuto   --token_filters TokenFilterStopWord
+.. table_create Terms TABLE_PAT_KEY ShortText \
+..   --default_tokenizer TokenBigram \
+..   --normalizer NormalizerAuto \
+..   --token_filters TokenFilterStopWord
 .. column_create Terms memos_content COLUMN_INDEX|WITH_POSITION Memos content
 .. column_create Terms is_stop_word COLUMN_SCALAR Bool
 .. load --table Terms
@@ -86,12 +92,15 @@ Here is an example that uses ``TokenFilterStopWord`` token filter:
 Here is an example that uses ``TokenFilterStem`` token filter:
 
 .. groonga-command
+.. database: token_filters_stem
 .. include:: ../example/reference/token_filters/stem.log
-.. register token_filters/stop_word
 .. register token_filters/stem
 .. table_create Memos TABLE_NO_KEY
 .. column_create Memos content COLUMN_SCALAR ShortText
-.. table_create Terms TABLE_PAT_KEY ShortText   --default_tokenizer TokenBigram   --normalizer NormalizerAuto   --token_filters TokenFilterStem
+.. table_create Terms TABLE_PAT_KEY ShortText \
+..   --default_tokenizer TokenBigram \
+..   --normalizer NormalizerAuto \
+..   --token_filters TokenFilterStem
 .. column_create Terms memos_content COLUMN_INDEX|WITH_POSITION Memos content
 .. load --table Memos
 .. [

data/vendor/local/share/doc/groonga/en/html/_sources/server/http/comparison.txt

@@ -19,7 +19,7 @@ There are many differences between :doc:`groonga` and
 +----------------------------+------------------------+----------------------+
 |     Custom prefix path     | x                      | o                    |
 +----------------------------+------------------------+----------------------+
-|   Custom command version   | o                      | x (comming soon)     |
+|   Custom command version   | o                      | o                    |
 +----------------------------+------------------------+----------------------+
 |      Multi databases       | x                      | o                    |
 +----------------------------+------------------------+----------------------+

data/vendor/local/share/doc/groonga/en/html/_static/basic.css

@@ -197,10 +197,7 @@ h3:hover > a.headerlink,
 h4:hover > a.headerlink,
 h5:hover > a.headerlink,
 h6:hover > a.headerlink,
-dt:hover > a.headerlink,
-caption:hover > a.headerlink,
-p.caption:hover > a.headerlink,
-div.code-block-caption:hover > a.headerlink {
+dt:hover > a.headerlink {
     visibility: visible;
 }
 
@@ -317,13 +314,6 @@ table.docutils {
     border-collapse: collapse;
 }
 
-table caption span.caption-number {
-    font-style: italic;
-}
-
-table caption span.caption-text {
-}
-
 table.docutils td, table.docutils th {
     padding: 1px 8px 1px 5px;
     border-top: 0;
@@ -354,25 +344,6 @@ table.citation td {
     border-bottom: none;
 }
 
-/* -- figures --------------------------------------------------------------- */
-
-div.figure {
-    margin: 0.5em;
-    padding: 0.5em;
-}
-
-div.figure p.caption {
-    padding: 0.3em;
-}
-
-div.figure p.caption span.caption-number {
-    font-style: italic;
-}
-
-div.figure p.caption span.caption-text {
-}
-
-
 /* -- other body styles ----------------------------------------------------- */
 
 ol.arabic {
@@ -435,10 +406,6 @@ dl.glossary dt {
     font-size: 1.3em;
 }
 
-.sig-paren {
-    font-size: larger;
-}
-
 .versionmodified {
     font-style: italic;
 }
@@ -504,51 +471,22 @@ table.highlighttable td {
     padding: 0 0.5em 0 0.5em;
 }
 
-div.code-block-caption {
-    padding: 2px 5px;
-    font-size: small;
-}
-
-div.code-block-caption code {
-    background-color: transparent;
-}
-
-div.code-block-caption + div > div.highlight > pre {
-    margin-top: 0;
-}
-
-div.code-block-caption span.caption-number {
-    padding: 0.1em 0.3em;
-    font-style: italic;
-}
-
-div.code-block-caption span.caption-text {
-}
-
-div.container {
-    padding: 1em 1em 0;
-}
-
-div.container div.highlight {
-    margin: 0;
-}
-
-code.descname {
+tt.descname {
     background-color: transparent;
     font-weight: bold;
     font-size: 1.2em;
 }
 
-code.descclassname {
+tt.descclassname {
     background-color: transparent;
 }
 
-code.xref, a code {
+tt.xref, a tt {
     background-color: transparent;
     font-weight: bold;
 }
 
-h1 code, h2 code, h3 code, h4 code, h5 code, h6 code {
+h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt {
     background-color: transparent;
 }