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

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

@@ -1,23 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-Command
-=======
-
-Command is the most important processing unit in query API. You
-request a processing to groonga by a command.
-
-This section describes about command and built-in commands.
-
-.. toctree::
-   :maxdepth: 1
-   :glob:
-
-   command/command_version
-   command/output_format
-   command/pretty_print
-   command/request_id
-   command/request_timeout
-   command/return_code
-   commands/*

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

@@ -1,75 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-Command version
-===============
-
-概要
-----
-
-Groonga1.1からコマンドバージョンという概念が導入されます。コマンドバージョンは、selectやloadなどのGroongaのコマンドの仕様の互換性を表します。Groongaパッケージのバージョンが新しくなったとしても、同一のコマンドバージョンが使用可能であるなら、すべてのコマンドについて互換性が保証されます。コマンドバージョンが異なれば、同じ名前のコマンドであっても、動作に互換性がない可能性があります。
-
-あるバージョンのGroongaは、二つのコマンドバージョンを同時にサポートするようになります。
-使用するコマンドバージョンは、groongaを起動する際のコマンドラインオプションないしコンフィグファイルにdefault-commnad-versionパラメータを与えることによって指定できます。また、個々のコマンドを実行する際に、command_versionパラメータを与えることによっても指定することができます。
-
-コマンドバージョンは1からはじまり、更新されるたびに1ずつ大きくなります。現状のGroongaのコマンドの仕様はcommand-version 1という扱いになります。次回提供するGroongaは、command-version 1とcommand-version 2の二つをサポートすることになります。
-
-バージョンの位置づけ
---------------------
-
-あるバージョンのGroongaにおいてサポートされるコマンドバージョンは、develop, stable,deprecatedのいずれかの位置づけとなります。
-
-develop
-  まだ開発中であり、仕様が変更される可能性があります。
-
-stable
-  使用可能であり仕様も安定しています。その時点で使用することが推奨されます。
-
-deprecated
-  使用可能であり仕様も安定していますが、廃止予定であり使用が推奨されません。
-
-あるバージョンのGroongaがサポートする二つのコマンドバージョンのうち、いずれか一つが必ずstableの位置づけとなります。残りの一つは、developないしdeprecatedとなります。
-
-たとえば下記のようにGroongaのサポートするコマンドバージョンは推移します。::
-
-  groonga1.1: command-version1=stable     command-version2=develop
-  groonga1.2: command-version1=deprecated command-version2=stable
-  groonga1.3: command-version2=stable     command-version3=develop
-  groonga1.4: command-version2=deprecated command-version3=stable
-  groonga1.5: command-version3=stable     command-version4=develop
-
-あるコマンドバージョンははじめにdevelop扱いとしてリリースされ、やがてstableに移行します。
-その後二世代経過するとそのコマンドバージョンはdeprecated扱いとなります。さらに次のコマンドバージョンがリリースされると、deprecatedだったコマンドバージョンはサポート対象外となります。
-
-default-commnad-versionパラメータやcommand_versionパラメータを指定せずにgroongaコマンドを実行した際には、その時点でstableであるコマンドバージョンが指定されたものとみなします。
-
-groongaプロセス起動時に、default-command-versionパラメータにstable扱いでないコマンドバージョンを指定した場合には、警告メッセージがログファイルに出力されます。また、サポート範囲外のコマンドバージョンを指定した場合にはエラーとなり、プロセスは速やかに停止します。
-
-コマンドバージョンの指定方法
-----------------------------
-
-コマンドバージョンの指定方法はgroonga実行モジュールの引数として指定する方法と各コマンドの引数として指定する方法があります。
-
-default-command-versionパラメータ
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-groonga実行モジュールの引数としてdefault-command-versionパラメータを指定できます。
-(configファイルの中に指定することも可能です)
-
-実行例::
-
-  groonga --default-command-version 1
-
-そのプロセスで実行するすべてのコマンドについて、デフォルトのコマンドバージョンとして指定されたバージョンを使用します。指定されたコマンドバージョンがstableであった場合にはなんのメッセージも表示されずそのまま起動します。指定されたコマンドバージョンがdevelopあるいはdeprecatedであった場合には、groonga.logファイルに警告メッセージを出力します。指定されたコマンドバージョンがサポート対象外であった場合には標準エラー出力にエラーメッセージを出力し、プロセスは速やかに終了します。
-
-command_versionパラメータ
-^^^^^^^^^^^^^^^^^^^^^^^^^
-
-select,loadなどのすべてのgroongaコマンドにcommand_versionが指定できます。
-
-実行例::
-
-  select --command_version 1 --table tablename
-
-指定されたコマンドバージョンでコマンドを実行します。指定されたコマンドバージョンがサポート対象外であった場合にはエラーが返されます。command-versionが指定されなかった場合は、当該プロセス起動時にdefault-command-versionに指定した値が指定されたものとみなします。

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

@@ -1,228 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-Output format
-=============
-
-Summary
--------
-
-Commands output their result as JSON, MessagePack, XML or TSV format.
-
-JSON and MessagePack output have the same structure. XML and TSV are
-their original structure.
-
-JSON or MessagePack is recommend format. XML is useful for visual
-result check. TSV is just for special use. Normally you doesn't need
-to use TSV.
-
-JSON and MessagePack
---------------------
-
-This secsion describes the structure of command result on JSON and
-MessagePack format. JSON is used to show structure because MessagePack
-is binary format. Binary format isn't proper for documenataion.
-
-JSON and MessagePack uses the following structure::
-
-  [HEADER, BODY]
-
-For example::
-
-  [
-    [
-      0,
-      1337566253.89858,
-      0.000355720520019531
-    ],
-    [
-      [
-        [
-          1
-        ],
-        [
-          [
-            "_id",
-            "UInt32"
-          ],
-          [
-            "_key",
-            "ShortText"
-          ],
-          [
-            "content",
-            "Text"
-          ],
-          [
-            "n_likes",
-            "UInt32"
-          ]
-        ],
-        [
-          2,
-          "Groonga",
-          "I started to use groonga. It's very fast!",
-          10
-        ]
-      ]
-    ]
-  ]
-
-In the example, the following part is ``HEADER``::
-
-  [
-    0,
-    1337566253.89858,
-    0.000355720520019531
-  ]
-
-The following part is ``BODY``::
-
-  [
-    [
-      [
-        1
-      ],
-      [
-        [
-          "_id",
-          "UInt32"
-        ],
-        [
-          "_key",
-          "ShortText"
-        ],
-        [
-          "content",
-          "Text"
-        ],
-        [
-          "n_likes",
-          "UInt32"
-        ]
-      ],
-      [
-        2,
-        "Groonga",
-        "I started to use groonga. It's very fast!",
-        10
-      ]
-    ]
-  ]
-
-``HEADER``
-^^^^^^^^^^
-
-``HEADER`` is an array. The content of ``HEADER`` has some patterns.
-
-Success case
-++++++++++++
-
-``HEADER`` has three elements on success::
-
-  [0, UNIX_TIME_WHEN_COMMAND_IS_STARTED, ELAPSED_TIME]
-
-The first element is always ``0``.
-
-``UNIX_TIME_WHEN_COMMAND_IS_STARTED`` is the number of seconds
-since 1970-01-01 00:00:00 UTC when the command is started
-processing. ``ELAPSED_TIME`` is the elapsed time for processing the
-command in seconds. Both ``UNIX_TIME_WHEN_COMMAND_IS_STARTED`` and
-``ELAPSED_TIME`` are float value. The precision of them are
-nanosecond.
-
-Error case
-++++++++++
-
-``HEADER`` has four or five elements on error::
-
-  [
-    RETURN_CODE,
-    UNIX_TIME_WHEN_COMMAND_IS_STARTED,
-    ELAPSED_TIME,
-    ERROR_MESSAGE,
-    ERROR_LOCATION
-  ]
-
-``ERROR_LOCATION`` may not be included in ``HEADER`` but other four
-elements are always included.
-
-``RETURN_CODE`` is non 0 value. See :doc:`return_code` about available
-return codes.
-
-``UNIX_TIME_WHEN_COMMAND_IS_STARTED`` and ``ELAPSED_TIME`` are the
-same as success case.
-
-``ERROR_MESSAGE`` is an error message in string.
-
-``ERROR_LOCATION`` is optional. If error location is collected,
-``ERROR_LOCATION`` is included. ``ERROR_LOCATION`` is an
-array. ``ERROR_LOCATION`` has one ore two elements::
-
-  [
-    LOCATION_IN_GROONGA,
-    LOCATION_IN_INPUT
-  ]
-
-``LOCATION_IN_GROONGA`` is the source location that error is occurred
-in groonga. It is useful for groonga developers but not useful for
-users. ``LOCATION_IN_GROONGA`` is an array. ``LOCATION_IN_GROONGA`` has
-three elements::
-
-  [
-    FUNCTION_NAME,
-    SOURCE_FILE_NAME,
-    LINE_NUMBER
-  ]
-
-``FUNCTION_NAME`` is the name of function that error is occurred.
-
-``SOURCE_FILE_NAME`` is the name of groonga's source file that error is
-occurred.
-
-``LINE_NUMBER`` is the line number of ``SOURCE_FILE_NAME`` that error
-is occurred.
-
-``LOCATION_IN_INPUT`` is optional. ``LOCATION_IN_INPUT`` is included
-when the location that error is occurred in input file is
-collected. Input file can be specified by ``--file`` command line
-option for ``groonga`` command. ``LOCATION_IN_GROONGA`` is an
-array. ``LOCATION_IN_GROONGA`` has three elements::
-
-  [
-    INPUT_FILE_NAME,
-    LINE_NUMBER,
-    LINE_CONTENT
-  ]
-
-``INPUT_FILE_NAME`` is the input file name that error is occurred.
-
-``LINE_NUMBER`` is the line number of ``INPUT_FILE_NAME`` that error
-is occurred.
-
-``LINE_CONTENT`` is the content at ``LINE_NUMBER`` in
-``INPUT_FILE_NAME``.
-
-``BODY``
-^^^^^^^^
-
-``BODY`` content depends on the executed command. It may be omitted.
-
-``BODY`` may be an error message on error case.
-
-XML
----
-
-TODO
-
-TSV
----
-
-TODO
-
-See also
---------
-
-* :doc:`return_code` describes about return code.
-

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

@@ -1,45 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-Pretty print
-============
-
-Summary
--------
-
-.. versionadded:: 5.1.0
-
-Groonga supports pretty print when you choose JSON for
-:doc:`output_format`.
-
-Usage
------
-
-Just specify ``yes`` to ``output_pretty`` parameter::
-
-  > status --output_pretty yes
-  [
-    [
-      0,
-      1448344438.43783,
-      5.29289245605469e-05
-    ],
-    {
-      "alloc_count": 233,
-      "starttime": 1448344437,
-      "start_time": 1448344437,
-      "uptime": 1,
-      "version": "5.0.9-135-g0763d91",
-      "n_queries": 0,
-      "cache_hit_rate": 0.0,
-      "command_version": 1,
-      "default_command_version": 1,
-      "max_command_version": 2
-    }
-  ]
-
-Here is a result without ``output_pretty`` parameter::
-
-  > status
-  [[0,1448344438.43783,5.29289245605469e-05],{"alloc_count":233,"starttime":1448344437,...}]

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

@@ -1,41 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-Request ID
-==========
-
-Summary
--------
-
-.. versionadded:: 4.0.9
-
-You can assign ID to each request.
-
-The ID can be used by canceling the request. See also
-:doc:`/reference/commands/request_cancel` for details about canceling
-a request.
-
-Request ID should be managed by user. If you assign the same ID for
-some running requests, you can't cancel the request.
-
-The simplest ID sequence is incremented numbers such as ``1``,
-``2`` , ``...``.
-
-A request ID is a string. The maximum request ID size is 4096 byte.
-
-How to assign ID to request
----------------------------
-
-All commands accept ``request_id`` parameter. You can assign ID to
-request by adding ``request_id`` parameter.
-
-Here is an example to assign ``id-1`` ID to a request::
-
-  select Users --request_id id-1
-
-See also
---------
-
-* :doc:`/reference/commands/request_cancel`
-

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

@@ -1,78 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-Request timeout
-===============
-
-Summary
--------
-
-.. versionadded:: 6.0.2
-
-You can set timeout to each request.
-
-If a request isn't completed until the specified timeout, the request
-is canceled. If you don't set timeout, the request is processed until
-the request is completed.
-
-Request timeout feature is useful when you implement timeout on client
-side. If you only implement timeout only on client side, the request
-keeps processing after client stops waiting response. It uses needless
-resources. If you set timeout to the request, the request will be
-canceled soon.
-
-How to set timeout to request
------------------------------
-
-All commands accept ``request_timeout`` parameter. You can set timeout
-to request by adding ``request_timeout`` parameter.
-
-Unit of timeout out value is second. You can set timeout less than 1
-second by using decimal such as ``0.1``. ``0.1`` means 100
-milliseconds.
-
-Here is an example to set ``5.5`` seconds timeout to a request::
-
-  select Users --request_timeout 5.5
-
-Return code on timeout
-----------------------
-
-If the request is timed out, ``GRN_CANCEL`` (``-77``)
-:doc:`return_code` is returned in response header.
-
-Here is an example response on timeout::
-
-  [
-    [
-      -77,
-      1459846102.63304,
-      0.000220775604248047,
-      "[request-canceler] a request is canceled: <0x7fa0d5d7ed00>"
-    ]
-  ]
-
-See :doc:`/reference/command/output_format` for response header.
-
-Enable request timeout by default
----------------------------------
-
-:doc:`/reference/executables/groonga` supports enabling request
-timeout by default. You can specify the default request timeout by
-:option:`groonga --default-request-timeout`.
-
-If the default request timeout is larger than 0 second, the default
-request timeout is used as request timeout for all requests.
-
-You can overwrite the default request timeout by specifying
-``request_timeout`` parameter to request. If the default request
-timeout is 3 seconds and ``request_timeout`` parameter is 1 second,
-the request is canceled after 1 second.
-
-See also
---------
-
-* :doc:`/reference/command/return_code`
-* :doc:`/reference/command/output_format`
-* :doc:`/reference/commands/request_cancel`