rroonga 2.1.2-x86-mingw32 → 2.1.3-x86-mingw32

data/vendor/local/share/doc/groonga/source/server/http/comparison.txt

@@ -1,298 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-Comparison
-==========
-
-There are many differences between :doc:`groonga` and
-:doc:`groonga-httpd`. Here is a comparison table.
-
-+----------------------------+------------------------+----------------------+
-|                            |        groonga         |    groonga-httpd     |
-+============================+========================+======================+
-|        Performance         | o                      | o                    |
-+----------------------------+------------------------+----------------------+
-|   Using multi CPU cores    | o (by multi threading) | o (by multi process) |
-+----------------------------+------------------------+----------------------+
-|     Configuration file     | optional               | required             |
-+----------------------------+------------------------+----------------------+
-|     Custom prefix path     | x                      | o                    |
-+----------------------------+------------------------+----------------------+
-|   Custom command version   | o                      | x (comming soon)     |
-+----------------------------+------------------------+----------------------+
-|      Multi databases       | x                      | o                    |
-+----------------------------+------------------------+----------------------+
-|       Authentication       | x                      | o                    |
-+----------------------------+------------------------+----------------------+
-|      Gzip compression      | x                      | o                    |
-+----------------------------+------------------------+----------------------+
-|            POST            | x                      | o                    |
-+----------------------------+------------------------+----------------------+
-|           HTTPS            | x                      | o                    |
-+----------------------------+------------------------+----------------------+
-|         Access log         | x                      | o                    |
-+----------------------------+------------------------+----------------------+
-| Upgrading without downtime | x                      | o                    |
-+----------------------------+------------------------+----------------------+
-
-Performance
------------
-
-Both :doc:`groonga` and :doc:`groonga-httpd` are very fast. They can
-work with the same throughput.
-
-Using multi CPU cores
----------------------
-
-Groonga scales on multi CPU cores. :doc:`groonga` scales by multi
-threading. :doc:`groonga-httpd` scales by multi processes.
-
-:doc:`groonga` uses the same number of threads as CPU cores by
-default. If you have 8 CPU cores, 8 threads are used by default.
-
-:doc:`groonga-httpd` uses 1 process by default. You need to set
-`worker_processes
-<http://nginx.org/en/docs/ngx_core_module.html#worker_processes>`_
-directive to use CPU cores. If you have 8 CPU cores, specify
-``worker_processes 8`` in configuration file like the following::
-
-  worker_processes 8;
-
-  http {
-    # ...
-  }
-
-Configuration file
-------------------
-
-:doc:`groonga` can work without configuration file. All configuration
-items such as port number and the max number of threads can be
-specified by command line. Configuration file is also used to specify
-configuration items.
-
-It's very easy to run groonga HTTP server because :doc:`groonga`
-requires just a few options to run. Here is the most simple command
-line to start HTTP server by :doc:`groonga`::
-
-  % groonga --protocol http -d /PATH/TO/DATABASE
-
-:doc:`groonga-httpd` requires configuration file to run. Here is the
-most simple configuration file to start HTTP server by
-:doc:`groonga-httpd`::
-
-  events {
-  }
-
-  http {
-    server {
-      listen 10041;
-
-      location /d/ {
-        groonga on;
-        groonga_database /PATH/TO/DATABASE;
-      }
-    }
-  }
-
-Custom prefix path
-------------------
-
-:doc:`groonga` accepts a path that starts with ``/d/`` as command URL
-such as ``http://localhost:10041/d/status``. You cannot change the
-prefix path ``/d/``.
-
-:doc:`groonga-httpd` can custom prefix path. For example, you can use
-``http://localhost:10041/api/status`` as command URL. Here is a sample
-configuration to use ``/api/`` as prefix path::
-
-  events {
-  }
-
-  http {
-    server {
-      listen 10041;
-
-      location /api/ { # <- change this
-        groonga on;
-        groonga_database /PATH/TO/DATABASE;
-      }
-    }
-  }
-
-Custom command version
-----------------------
-
-Groonga has :doc:`/reference/command/command_version` mechanism. It is for
-upgrading groonga commands with backward compatibility.
-
-:doc:`groonga` can change the default command veresion by
-``--default-command-version`` option. Here is a sample command line to
-use command version 2 as the default command version::
-
-  % groonga --protocol http --default-command-version 2 -d /PATH/TO/DATABASE
-
-:doc:`groonga-httpd` cannot custom the default command version
-yet. But it will be supported soon. If it is supported, you can
-provides different command version groonga commands in the same
-:doc:`groonga-httpd` process. Here is a sample configuration to
-provide command version 1 commands under ``/api/1/`` and command
-version 2 comamnds under ``/api/2/``::
-
-  events {
-  }
-
-  http {
-    server {
-      listen 10041;
-
-      groonga_database /PATH/TO/DATABASE;
-
-      location /api/1/ {
-        groonga on;
-        groogna_default_command_version 1;
-      }
-
-      location /api/2/ {
-        groonga on;
-        groogna_default_command_version 2;
-      }
-    }
-  }
-
-Multi databases
----------------
-
-:doc:`groonga` can use only one database in a process.
-
-:doc:`groonga-httpd` can use one or more databases in a process. Here
-is a sample configuration to provide ``/tmp/db1`` database under
-``/db1/`` path and ``/tmp/db2`` database under ``/db2/`` path::
-
-  events {
-  }
-
-  http {
-    server {
-      listen 10041;
-
-      location /db1/ {
-        groonga on;
-        groonga_database /tmp/db1;
-      }
-
-      location /db2/ {
-        groonga on;
-        groonga_database /tmp/db2;
-      }
-    }
-  }
-
-Authentication
---------------
-
-HTTP supports authentications such as basic authentication and digest
-authentication. It can be used for restricting use of danger command such
-as :doc:`/reference/commands/shutdown`.
-
-:doc:`groonga` doesn't support any authentications. To restrict use of
-danger command, other tools such as iptables and reverse proxy are
-needed.
-
-:doc:`groonga-httpd` supports basic authentication. Here is a sample
-configuration to restrict use of :doc:`/reference/commands/shutdown`
-command::
-
-  events {
-  }
-
-  http {
-    server {
-      listen 10041;
-
-      groonga_database /PATH/TO/DATABASE;
-
-      location /d/shutdown {
-        groonga on;
-        auth_basic           "manager is required!";
-        auth_basic_user_file "/etc/managers.htpasswd";
-      }
-
-      location /d/ {
-        groonga on;
-      }
-    }
-  }
-
-Gzip compression
-----------------
-
-HTTP supports response compression by gzip with ``Content-Encoding:
-gzip`` response header. It can reduce network flow. It is useful
-for large search response.
-
-:doc:`groonga` doesn't support compression. To support compression,
-reverse proxy is needed.
-
-:doc:`groonga-httpd` supports gzip compression. Here is a sample
-configuration to compress response by gzip::
-
-  events {
-  }
-
-  http {
-    server {
-      listen 10041;
-
-      groonga_database /PATH/TO/DATABASE;
-
-      location /d/ {
-        groonga    on;
-        gzip       on;
-        gzip_types *;
-      }
-    }
-  }
-
-Note that `gzip_types *` is specified. It's one of the important
-configuration. `gzip_types` specifies gzip target data formats by MIME
-types. :doc:`groonga-httpd` returns one of JSON, XML or MessagePack
-format data. But those formats aren't included in the default value of
-`gzip_types`. The default value of `gzip_types` is `text/html`.
-
-To compress response data from :doc:`groonga-httpd` by gzip, you need
-to specify `gzip_types *` or `gzip_types application/json text/xml
-application/x-msgpack` explicitly. `gzip_types *` is recommended.
-There are two reasons for it. The first, groonga may support more
-formats in the future. The second, all requests for the `location` are
-processed by groonga. You don't need to consider about other modules.
-
-POST
-----
-
-You can load your data by POST JSON data. You need follow the
-following rules to use loading by POST.
-
-* `Content-Type` header value must be `application/json`.
-* JSON data is sent as body.
-* Table name is specified by query parameter such as ``table=NAME``.
-
-Here is an example curl command line that loads two users `alice` and
-`bob` to `Users` table::
-
-  % curl --data-binary '[{"_key": "alice"}, {"_key": "bob"}]' -H "Content-Type: application/json" "http://localhost:10041/d/load?table=Users"
-
-HTTPS
------
-
-TODO
-
-Access log
-----------
-
-TODO
-
-Upgrading without downtime
---------------------------
-
-TODO

data/vendor/local/share/doc/groonga/source/server/http/groonga-httpd.txt

@@ -1,8 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-groonga-httpd
-=============
-
-TODO

data/vendor/local/share/doc/groonga/source/server/http/groonga.txt

@@ -1,8 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-groonga
-=======
-
-TODO

data/vendor/local/share/doc/groonga/source/server/http.txt

@@ -1,29 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-HTTP
-====
-
-Groonga provides two HTTP server implementations.
-
-* :doc:`http/groonga`
-* :doc:`http/groonga-httpd`
-
-:doc:`http/groonga` is a simple implemntation. It is fast but doesn't
-have many HTTP features. It is convenient to try groonga because it
-requires just a few command line options to run.
-
-:doc:`http/groonga-httpd` is a `nginx <http://nginx.org/>`_ based
-implementation. It is also fast and has many HTTP features.
-
-.. note::
-
-   :doc:`http/groonga-httpd` is still experimental.
-
-.. toctree::
-   :maxdepth: 2
-
-   http/comparison
-   http/groonga
-   http/groonga-httpd

data/vendor/local/share/doc/groonga/source/server.txt

@@ -1,12 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-Server
-======
-
-.. toctree::
-   :maxdepth: 2
-
-   server/gqtp
-   server/http

data/vendor/local/share/doc/groonga/source/spec/gqtp.txt

@@ -1,214 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-GQTP
-====
-
-GQTP is the acronym of Groonga Query Transfer Protocol. GQTP is the
-original protocol for groonga.
-
-Protocol
---------
-
-GQTP is stateful client server model protocol. The following sequence
-is one processing unit:
-
-* Client sends a request
-* Server receives the request
-* Server processes the request
-* Server sends a response
-* Client receives the response
-
-You can do zero or more processing units in a session.
-
-Both request and response consist of GQTP header and body. GQTP header
-is fixed size data. Body is variable size data and its size is stored
-in GQTP header. The content of body isn't defined in GQTP.
-
-.. _gqtp-header-spec:
-
-GQTP header
-^^^^^^^^^^^
-
-GQTP header consists of the following unsigned integer values:
-
-+----------------+-------+----------------------------+
-|      Name      |  Size |        Description         |
-+================+=======+============================+
-|  ``protocol``  | 1byte | Protocol type.             |
-+----------------+-------+----------------------------+
-| ``query_type`` | 1byte | Content type of body.      |
-+----------------+-------+----------------------------+
-| ``key_length`` | 2byte | Not used.                  |
-+----------------+-------+----------------------------+
-|   ``level``    | 1byte | Not used.                  |
-+----------------+-------+----------------------------+
-|   ``flags``    | 1byte | Flags.                     |
-+----------------+-------+----------------------------+
-|   ``status``   | 2byte | Return code.               |
-+----------------+-------+----------------------------+
-|    ``size``    | 4byte | Body size.                 |
-+----------------+-------+----------------------------+
-|   ``opaque``   | 4byte | Not used.                  |
-+----------------+-------+----------------------------+
-|    ``cas``     | 8byte | Not used.                  |
-+----------------+-------+----------------------------+
-
-All header values are encoded by network byte order.
-
-The following sections describes available values of each header value.
-
-The total size of GQTP header is 24byte.
-
-``protocol``
-""""""""""""
-
-The value is always ``0xc7`` in both request and response GQTP header.
-
-``query_type``
-""""""""""""""
-
-The value is one of the following values:
-
-+-------------+--------+----------------------------+
-|    Name     | Value  |        Description         |
-+=============+========+============================+
-|  ``NONE``   |   0    | Free format.               |
-+-------------+--------+----------------------------+
-|   ``TSV``   |   1    | Tab Separated Values.      |
-+-------------+--------+----------------------------+
-|  ``JSON``   |   2    | JSON.                      |
-+-------------+--------+----------------------------+
-|   ``XML``   |   3    | XML.                       |
-+-------------+--------+----------------------------+
-| ``MSGPACK`` |   4    | MessagePack.               |
-+-------------+--------+----------------------------+
-
-This is not used in request GQTP header.
-
-This is used in response GQTP header. Body is formatted as specified
-type.
-
-``flags``
-"""""""""
-
-The value is bitwise OR of the following values:
-
-+-----------+--------+----------------------------+
-|   Name    | Value  |        Description         |
-+===========+========+============================+
-| ``MORE``  |  0x01  | There are more data.       |
-+-----------+--------+----------------------------+
-| ``TAIL``  |  0x02  | There are no more data.    |
-+-----------+--------+----------------------------+
-| ``HEAD``  |  0x04  | Not used.                  |
-+-----------+--------+----------------------------+
-| ``QUIET`` |  0x08  | Be quiet.                  |
-+-----------+--------+----------------------------+
-| ``QUIT``  |  0x10  | Quit.                      |
-+-----------+--------+----------------------------+
-
-You must specify ``MORE`` or ``TAIL`` flag.
-
-If you use ``MORE`` flag, you should also use ``QUIET`` flag. Because
-you don't need to show a response for your partial request.
-
-Use ``QUIT`` flag to quit this session.
-
-``status``
-""""""""""
-
-Here are available values. The new statuses will be added in the
-future.
-
-* 0: ``SUCCESS``
-* 1: ``END_OF_DATA``
-* 65535: ``UNKNOWN_ERROR``
-* 65534: ``OPERATION_NOT_PERMITTED``
-* 65533: ``NO_SUCH_FILE_OR_DIRECTORY``
-* 65532: ``NO_SUCH_PROCESS``
-* 65531: ``INTERRUPTED_FUNCTION_CALL``
-* 65530: ``INPUT_OUTPUT_ERROR``
-* 65529: ``NO_SUCH_DEVICE_OR_ADDRESS``
-* 65528: ``ARG_LIST_TOO_LONG``
-* 65527: ``EXEC_FORMAT_ERROR``
-* 65526: ``BAD_FILE_DESCRIPTOR``
-* 65525: ``NO_CHILD_PROCESSES``
-* 65524: ``RESOURCE_TEMPORARILY_UNAVAILABLE``
-* 65523: ``NOT_ENOUGH_SPACE``
-* 65522: ``PERMISSION_DENIED``
-* 65521: ``BAD_ADDRESS``
-* 65520: ``RESOURCE_BUSY``
-* 65519: ``FILE_EXISTS``
-* 65518: ``IMPROPER_LINK``
-* 65517: ``NO_SUCH_DEVICE``
-* 65516: ``NOT_A_DIRECTORY``
-* 65515: ``IS_A_DIRECTORY``
-* 65514: ``INVALID_ARGUMENT``
-* 65513: ``TOO_MANY_OPEN_FILES_IN_SYSTEM``
-* 65512: ``TOO_MANY_OPEN_FILES``
-* 65511: ``INAPPROPRIATE_I_O_CONTROL_OPERATION``
-* 65510: ``FILE_TOO_LARGE``
-* 65509: ``NO_SPACE_LEFT_ON_DEVICE``
-* 65508: ``INVALID_SEEK``
-* 65507: ``READ_ONLY_FILE_SYSTEM``
-* 65506: ``TOO_MANY_LINKS``
-* 65505: ``BROKEN_PIPE``
-* 65504: ``DOMAIN_ERROR``
-* 65503: ``RESULT_TOO_LARGE``
-* 65502: ``RESOURCE_DEADLOCK_AVOIDED``
-* 65501: ``NO_MEMORY_AVAILABLE``
-* 65500: ``FILENAME_TOO_LONG``
-* 65499: ``NO_LOCKS_AVAILABLE``
-* 65498: ``FUNCTION_NOT_IMPLEMENTED``
-* 65497: ``DIRECTORY_NOT_EMPTY``
-* 65496: ``ILLEGAL_BYTE_SEQUENCE``
-* 65495: ``SOCKET_NOT_INITIALIZED``
-* 65494: ``OPERATION_WOULD_BLOCK``
-* 65493: ``ADDRESS_IS_NOT_AVAILABLE``
-* 65492: ``NETWORK_IS_DOWN``
-* 65491: ``NO_BUFFER``
-* 65490: ``SOCKET_IS_ALREADY_CONNECTED``
-* 65489: ``SOCKET_IS_NOT_CONNECTED``
-* 65488: ``SOCKET_IS_ALREADY_SHUTDOWNED``
-* 65487: ``OPERATION_TIMEOUT``
-* 65486: ``CONNECTION_REFUSED``
-* 65485: ``RANGE_ERROR``
-* 65484: ``TOKENIZER_ERROR``
-* 65483: ``FILE_CORRUPT``
-* 65482: ``INVALID_FORMAT``
-* 65481: ``OBJECT_CORRUPT``
-* 65480: ``TOO_MANY_SYMBOLIC_LINKS``
-* 65479: ``NOT_SOCKET``
-* 65478: ``OPERATION_NOT_SUPPORTED``
-* 65477: ``ADDRESS_IS_IN_USE``
-* 65476: ``ZLIB_ERROR``
-* 65475: ``LZO_ERROR``
-* 65474: ``STACK_OVER_FLOW``
-* 65473: ``SYNTAX_ERROR``
-* 65472: ``RETRY_MAX``
-* 65471: ``INCOMPATIBLE_FILE_FORMAT``
-* 65470: ``UPDATE_NOT_ALLOWED``
-* 65469: ``TOO_SMALL_OFFSET``
-* 65468: ``TOO_LARGE_OFFSET``
-* 65467: ``TOO_SMALL_LIMIT``
-* 65466: ``CAS_ERROR``
-* 65465: ``UNSUPPORTED_COMMAND_VERSION``
-
-``size``
-""""""""
-
-The size of body. The maximum body size is 4GiB because ``size`` is
-4byte unsigned integer. If you want to send 4GiB or more larger data,
-use ``MORE`` flag.
-
-Example
--------
-
-TODO
-
-See also
---------
-
-TODO

data/vendor/local/share/doc/groonga/source/spec/search.txt

@@ -1,115 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-検索
-====
-
-:doc:`/reference/commands/select` コマンドがqueryパラメータを使ってどのように検索するのかを説明します。
-
-検索の挙動
-----------
-
-検索の挙動には以下の3種類あり、検索結果によって動的に使い分けています。
-
-1. 完全一致検索
-2. 非わかち書き検索
-3. 部分一致検索
-
-どのように検索の挙動を使い分けているかを説明する前に、まず、それぞれの検索の挙動を説明します。
-
-完全一致検索
-^^^^^^^^^^^^
-
-検索対象文書は複数の語彙にトークナイズ(分割)され、それぞれを単位とした語彙表に索引を管理します。
-検索キーワードも同一の方法でトークナイズされます。
-
-このとき、検索キーワードをトークナイズした結果得られる語彙の配列と同一の配列を含む文書を検索する処理を完全一致検索と呼んでいます。
-
-たとえば、TokenMecabトークナイザを使用した索引では「東京都民」という文字列は
-
- 東京 / 都民
-
-という二つの語彙の配列として格納されます。この索引に対して「東京都」というキーワードで検索した時、このキーワードは、
-
- 東京 / 都
-
-という二つの語彙の配列として処理されます。この語彙の並びは、「東京 / 都民」という語彙の並びには一致しませんので、完全一致検索ではヒットしません。
-
-これに対して、TokenBigramトークナイザを使用した索引では「東京都民」という文字列は
-
- 東京 / 京都 / 都民 / 民
-
-という四つの語彙の配列として格納されます。この索引に対して「東京都」というキーワードで検索した時、このキーワードは、
-
- 東京 / 京都
-
-という二つの語彙の配列として処理されます。この語彙の並びは、「東京 / 京都 / 都民」という語彙の並びに含まれますので、完全一致検索でヒットします。
-
-なお、TokenBigramトークナイザでは、アルファベット・数値・記号文字列についてはbigramを生成せず、一つの連続したトークンとして扱います。たとえば、「楽しいbilliard」という文字列は、
-
- 楽し / しい / billiard
-
-という三つの語彙の配列として格納されます。これに対して「bill」というキーワードで検索した時、このキーワードは、
-
- bill
-
-という一つの語彙として処理されます。この語彙の並びは「楽し / しい / billiard」という語彙の並びには含まれないので、完全一致でヒットしません。
-
-これに対して、TokenBigramSplitSymbolAlphaトークナイザではアルファベット文字列についてもbigramを生成し、「楽しいbilliard」という文字列は、
-
- 楽し / しい / いb / bi / il / ll / li / ia / ar / rd / d
-
-という十一の語彙の配列として格納されます。これに対して「bill」というキーワードで検索した時、このキーワードは、
-
- bi / il / ll
-
-という三つの語彙として処理されます。この語彙の並びは「楽し / しい / いb / bi / il / ll / li / ia / ar / rd / d」という語彙の並びに含まれるので、完全一致でヒットします。
-
-非わかち書き検索
-^^^^^^^^^^^^^^^^
-
-非わかち書き検索はパトリシア木で語彙表を構築している場合のみ利用可能です。
-
-非わかち書き検索の挙動はTokenBigramなどN-gram系のトークナイザーを利用している場合とTokenMecabトークナイザーを利用している場合で挙動が変わります。
-
-N-gram系のトークナイザーを利用している場合はキーワードで前方一致検索をします。
-
-例えば、「bill」というキーワードで検索した場合、「bill」も「billiard」もヒットします。
-
-TokenMeCabトークナイザーの場合はわかち書き前のキーワードで前方一致検索をします。
-
-例えば、「スープカレー」というキーワードで検索した場合、「スープカレーバー」（1単語扱い）にヒットしますが、「スープカレー」（"スープ"と"カレー"の2単語扱い）や「スープカレーライス」（"スープ"と"カレーライス"の2単語扱い）にはヒットしません。
-
-部分一致検索
-^^^^^^^^^^^^
-
-部分一致検索はパトリシア木で語彙表を構築していて、かつ、KEY_WITH_SISオプションを指定している場合のみ利用可能です。KEY_WITH_SISオプションが指定されていない場合は非わかち書き検索と同等です。
-
-部分一致検索の挙動はTokenBigramなどN-gram系のトークナイザーを利用している場合とTokenMecabトークナイザーを利用している場合で挙動が変わります。
-
-Bigramの場合は前方一致検索と中間一致検索と後方一致検索を行います。
-
-例えば、「ill」というキーワードで検索した場合、「bill」も「billiard」もヒットします。
-
-TokenMeCabトークナイザーの場合はわかち書き後のキーワードで前方一致検索と中間一致検索と後方一致検索をします。
-
-例えば、「スープカレー」というキーワードで検索した場合、「スープカレー」（"スープ"と"カレー"の2単語扱い）や「スープカレーライス」（"スープ"と"カレーライス"の2単語扱い）、「スープカレーバー」（1単語扱い）にもヒットします。
-
-
-検索の使い分け
---------------
-
-groongaは基本的に完全一致検索のみを行います。完全一致検索でのヒット件数が所定の閾値以下の場合に限り、非わかち書き検索を行い、それでもヒット件数が閾値以下の場合は部分一致検索を行います。（閾値のデフォルト値は0です。）
-
-ただし、すでに検索結果セットが存在する場合はたとえヒット件数が閾値以下でも完全一致検索のみを行います。
-
-例えば、以下のようなクエリの場合は、それぞれの検索でヒット件数が閾値以下の場合は完全一致検索、非わかち書き検索、部分一致検索を順に行います。::
-
-  select Shops --match_column description --query スープカレー
-
-しかし、以下のように全文検索を行う前に検索結果セットが存在する場合は完全一致検索のみを行います。（point > 3で閾値の件数よりヒットしている場合）::
-
-  select Shops --filter '"point > 3 && description @ \"スープカレー\""'
-
-そのため、descriptionに「スープカレーライス」が含まれていても、「スープカレーライス」は「スープカレー」に完全一致しないのでヒットしません。