[Groonga-commit] groonga/groonga at 5cfab60 [master] doc: document about GQTP server

Back to archive index

Kouhei Sutou null+****@clear*****
Wed Apr 22 16:08:19 JST 2015


Kouhei Sutou	2015-04-22 16:08:19 +0900 (Wed, 22 Apr 2015)

  New Revision: 5cfab60ba421a34eaee21ae2814b9fa78ec1e98e
  https://github.com/groonga/groonga/commit/5cfab60ba421a34eaee21ae2814b9fa78ec1e98e

  Message:
    doc: document about GQTP server

  Modified files:
    doc/source/server/gqtp.rst

  Modified: doc/source/server/gqtp.rst (+38 -6)
===================================================================
--- doc/source/server/gqtp.rst    2015-04-22 16:05:02 +0900 (fb55178)
+++ doc/source/server/gqtp.rst    2015-04-22 16:08:19 +0900 (7ed4e9c)
@@ -5,12 +5,44 @@
 GQTP
 ====
 
-TODO
+Summary
+-------
 
-See :doc:`/reference/executables/groonga`.
+GQTP is the acronym standing for "Groonga Query Transfer Protocol".
 
-..
-   .. toctree::
-      :maxdepth: 2
+GQTP is a protocol designed for Groonga. It's a stateful
+protocol. You can send multiple commands in one session.
 
-      gqtp/groonga
+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``.
-------------- next part --------------
HTML����������������������������...
Download 



More information about the Groonga-commit mailing list
Back to archive index