rroonga 7.0.2-x64-mingw32 → 7.1.1-x64-mingw32

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

@@ -1,15 +0,0 @@
-.. -*- rst -*-
-.. Groonga Project
-
-.. highlightlang:: none
-
-Server
-======
-
-.. toctree::
-   :maxdepth: 2
-
-   server/package
-   server/http
-   server/gqtp
-   server/memcached

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

@@ -1,48 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-GQTP
-====
-
-Summary
--------
-
-GQTP is the acronym standing for "Groonga Query Transfer Protocol".
-
-GQTP is a protocol designed for Groonga. It's a stateful
-protocol. You can send multiple commands in one session.
-
-GQTP will be faster rather than :doc:`/server/http` when you send many
-light commands like :doc:`/reference/commands/status`. GQTP will be
-almost same performance as HTTP when you send heavy commands like
-:doc:`/reference/commands/select`.
-
-We recommend that you use HTTP for many cases. Because there are many
-HTTP client libraries.
-
-If you want to use GQTP, you can use the following libraries:
-
-  * Ruby: `groonga-client <https://github.com/ranguba/groonga-client>`_
-  * Python: `poyonga <https://github.com/hhatto/poyonga>`_
-  * Go: `goroo <https://github.com/hhatto/goroo>`_
-  * PHP: `proonga <https://github.com/Yujiro3/proonga>`_
-  * C/C++: Groonga (Groonga can be also used as library)
-
-It's not a library but you can use
-:doc:`/reference/executables/groonga` as a GQTP client.
-
-How to run
-----------
-
-:doc:`/reference/executables/groonga` is a GQTP server implementation.
-You can run a Groonga server by the following command line::
-
-  groonga --protocol gqtp -s [options] DB_PATH
-
-You can run a Groonga server as a daemon by the following command
-line::
-
-  groonga --protocol gqtp -d [options] DB_PATH
-
-See :doc:`/reference/executables/groonga` for available ``options``.

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

@@ -1,25 +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.
-
-.. toctree::
-   :maxdepth: 2
-
-   http/comparison
-   http/groonga
-   http/groonga-httpd

data/vendor/local/share/doc/groonga/en/html/_sources/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                      | o                    |
-+----------------------------+------------------------+----------------------+
-|      Multi databases       | x                      | o                    |
-+----------------------------+------------------------+----------------------+
-|       Authentication       | x                      | o                    |
-+----------------------------+------------------------+----------------------+
-|      Gzip compression      | x                      | o                    |
-+----------------------------+------------------------+----------------------+
-|            POST            | o                      | 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/en/html/_sources/server/http/groonga-httpd.txt

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

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

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

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

@@ -1,16 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-Memcached binary protocol
-=========================
-
-Groonga supports the memcached binary protocol. The following form shows how to run Groonga as a memcached binary protocol server daemon.
-
-Form::
-
-  groonga [-p PORT_NUMBER] -d --protocol memcached DB_PATH
-
-The `--protocol` option and its argument specify the protocol of the server. "memcached" specifies to use the memcached binary protocol.
-
-You don't need to create a table. When Groonga receives a request, it creates a table automatically. The table name will be `Memcache` .

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

@@ -1,209 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-Server packages
-===============
-
-The package ``groonga`` is the minimum set of fulltext search engine.
-If you want to use groonga for server use, you can install
-additional preconfigured packages.
-
-There are two packages for server use.
-
-* ``groonga-httpd`` (nginx and HTTP protocol based server package)
-* ``groonga-server-gqtp`` (:doc:`/spec/gqtp` protocol based server package)
-
-There is the reason why groonga supports not only GQTP but also two HTTP server
-packages. :doc:`/spec/gqtp` - Groonga Query Transfer Protocol is desined to reduce overheads
-and improve performance. But, GQTP is less support of client library than HTTP protocol does.
-As HTTP is matured protocol, you can take advantage of existing tool and there are many client
-library (See `related projects <http://groonga.org/related-projects.html>`_ for details).
-If you use ``groonga-httpd`` package, you can also take benefits of nginx functionality.
-
-We recommend to use ``groonga-httpd`` at first, because it provides fullfilling server functionality.
-If you have performance issues which is derived from protocol overheads, consider to use ``groonga-server-gqtp``.
-
- .. note::
-
-   In the previous versions, there is a ``groonga-server-http`` package (simple HTTP protocol
-   based server package). It is now marked as obsolete, please use ``groonga-httpd`` packages
-   instead. ``groonga-server-http`` package became a transitional package for ``groonga-httpd``.
-
-groonga-httpd
--------------
-
-``groonga-httpd`` is a nginx and HTTP protocol based server package.
-
-Preconfigured setting:
-
-+--------------------+---------------------------------------+
-| Item               | Default value                         |
-+====================+=======================================+
-| Port number        | 10041                                 |
-+--------------------+---------------------------------------+
-| Access log path    | /var/log/groonga/httpd/acccess.log    |
-+--------------------+---------------------------------------+
-| Error log path     | /var/log/groonga/http-query.log       |
-+--------------------+---------------------------------------+
-| Database           | /var/lib/groonga/db/*                 |
-+--------------------+---------------------------------------+
-| Configuration file | /etc/groonga/httpd/groonga-httpd.conf |
-+--------------------+---------------------------------------+
-
-Start HTTP server
-^^^^^^^^^^^^^^^^^
-
-Starting groonga HTTP server(Debian/Ubuntu/CentOS)::
-
-  % sudo service groonga-httpd start
- 
-Starting groonga HTTP server(Fedora)::
-
-  % sudo systemctl start groonga-httpd
- 
-Stop HTTP server
-^^^^^^^^^^^^^^^^
-
-Stopping groonga HTTP server(Debian/Ubuntu/CentOS)::
-
-  % sudo service groonga-httpd stop
- 
-Starting groonga HTTP server(Fedora)::
-
-  % sudo systemctl stop groonga-httpd
-
-Restart HTTP server
-^^^^^^^^^^^^^^^^^^^
-
-Restarting groonga HTTP server(Debian/Ubuntu/CentOS)::
-
-  % sudo service groonga-httpd restart
- 
-Restarting groonga HTTP server(Fedora)::
-
-  % sudo systemctl restart groonga-httpd
-
-groonga-server-gqtp
--------------------
-
-``groonga-server-gqtp`` is a :doc:`/spec/gqtp` protocol based server package.
-
-+--------------------+---------------------------------------+
-| Item               | Default value                         |
-+====================+=======================================+
-| Port number        | 10043                                 |
-+--------------------+---------------------------------------+
-| :ref:`process-log` | /var/log/groonga/groonga-gqtp.log     |
-+--------------------+---------------------------------------+
-| :ref:`query-log`   | /var/log/groonga/gqtp-query.log       |
-+--------------------+---------------------------------------+
-| Database           | /var/lib/groonga/db/*                 |
-+--------------------+---------------------------------------+
-
-Configuration file for server setting (Debian/Ubuntu)::
-
-  /etc/default/groonga/groonga-server-gqtp
-
-Configuration file for server setting (CentOS)::
-
-  /etc/sysconfig/groonga-server-gqtp
-
-Start GQTP server
-^^^^^^^^^^^^^^^^^
-
-Starting groonga GQTP server(Debian/Ubuntu/CentOS)::
-
-  % sudo service groonga-server-gqtp start
- 
-Starting groonga GQTP server(Fedora)::
-
-  % sudo systemctl start groonga-server-gqtp
-
-Stop GQTP server
-^^^^^^^^^^^^^^^^
-
-Stopping groonga GQTP server(Debian/Ubuntu/CentOS)::
-
-  % sudo service groonga-server-http stop
- 
-Stopping groonga GQTP server(Fedora)::
-
-  % sudo systemctl stop groonga-server-gqtp
-
-Restart GQTP server
-^^^^^^^^^^^^^^^^^^^
-
-Restarting groonga HTTP server(Debian/Ubuntu/CentOS)::
-
-  % sudo service groonga-server-gqtp restart
- 
-Restarting groonga HTTP server(Fedora)::
-
-  % sudo systemctl restart groonga-server-gqtp
-
-groonga-server-http
--------------------
-
-``groonga-server-http`` is a simple HTTP protocol based server package.
-
- .. note::
-
-   ``groonga-server-http`` package is the transitional package since Groonga 4.0.8.
-   Please use ``groonga-httpd`` instead.
-
-Preconfigured setting:
-
-+--------------------+---------------------------------------+
-| Item               | Default value                         |
-+====================+=======================================+
-| Port number        | 10041                                 |
-+--------------------+---------------------------------------+
-| :ref:`process-log` | /var/log/groonga/groonga-http.log     |
-+--------------------+---------------------------------------+
-| :ref:`query-log`   | /var/log/groonga/http-query.log       |
-+--------------------+---------------------------------------+
-| Database           | /var/lib/groonga/db/*                 |
-+--------------------+---------------------------------------+
-
-Configuration file for server setting (Debian/Ubuntu)::
-
-  /etc/default/groonga/groonga-server-http
-
-Configuration file for server setting (CentOS)::
-
-  /etc/sysconfig/groonga-server-http
-
-Start HTTP server
-^^^^^^^^^^^^^^^^^
-
-Starting groonga HTTP server(Debian/Ubuntu/CentOS)::
-
-  % sudo service groonga-server-http start
- 
-Starting groonga HTTP server(Fedora)::
-
-  % sudo systemctl start groonga-server-http
- 
-Stop HTTP server
-^^^^^^^^^^^^^^^^
-
-Stopping groonga HTTP server(Debian/Ubuntu/CentOS)::
-
-  % sudo service groonga-server-http stop
- 
-Stopping groonga HTTP server(Fedora)::
-
-  % sudo systemctl stop groonga-server-http
-
-Restart HTTP server
-^^^^^^^^^^^^^^^^^^^
-
-Restarting groonga HTTP server(Debian/Ubuntu/CentOS)::
-
-  % sudo service groonga-server-http restart
- 
-Restarting groonga HTTP server(Fedora)::
-
-  % sudo systemctl restart groonga-server-http
-