File: gqtp.html

package info (click to toggle)
groonga 11.0.0-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 121,576 kB
  • sloc: ansic: 801,209; javascript: 62,121; ruby: 46,206; cpp: 33,790; xml: 24,951; yacc: 13,333; sh: 7,776; python: 3,266; makefile: 2,315; perl: 133
file content (164 lines) | stat: -rw-r--r-- 7,957 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164


<!DOCTYPE html>

<html lang="en">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>5.3. GQTP &#8212; Groonga v10.1.1-31-g1e46ba6 documentation</title>
    <link rel="stylesheet" href="../_static/groonga.css" type="text/css" />
    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
    
    <script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
    <script src="../_static/jquery.js"></script>
    <script src="../_static/underscore.js"></script>
    <script src="../_static/doctools.js"></script>
    <script src="../_static/language_data.js"></script>
    
    <link rel="shortcut icon" href="../_static/favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="5.4. Memcached binary protocol" href="memcached.html" />
    <link rel="prev" title="5.2.3. groonga-httpd" href="http/groonga-httpd.html" /> 
  </head><body>
<div class="header">
  <h1 class="title">
    <a id="top-link" href="../index.html">
      <span class="project">groonga</span>
      <span class="separator">-</span>
      <span class="description">An open-source fulltext search engine and column store.</span>
    </a>
  </h1>

  <div class="other-language-links">
    <ul>
      <li><a href="../../../ja/html/server/gqtp.html">日本語</a></li>
    </ul>
  </div>
</div>
  

    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="memcached.html" title="5.4. Memcached binary protocol"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="http/groonga-httpd.html" title="5.2.3. groonga-httpd"
             accesskey="P">previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../index.html">Groonga v10.1.1-31-g1e46ba6 documentation</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="../server.html" accesskey="U"><span class="section-number">5. </span>Server</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href=""><span class="section-number">5.3. </span>GQTP</a></li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <div class="section" id="gqtp">
<h1><span class="section-number">5.3. </span>GQTP<a class="headerlink" href="#gqtp" title="Permalink to this headline">¶</a></h1>
<div class="section" id="summary">
<h2><span class="section-number">5.3.1. </span>Summary<a class="headerlink" href="#summary" title="Permalink to this headline">¶</a></h2>
<p>GQTP is the acronym standing for “Groonga Query Transfer Protocol”.</p>
<p>GQTP is a protocol designed for Groonga. It’s a stateful
protocol. You can send multiple commands in one session.</p>
<p>GQTP will be faster rather than <a class="reference internal" href="http.html"><span class="doc">HTTP</span></a> when you send many
light commands like <a class="reference internal" href="../reference/commands/status.html"><span class="doc">status</span></a>. GQTP will be
almost same performance as HTTP when you send heavy commands like
<a class="reference internal" href="../reference/commands/select.html"><span class="doc">select</span></a>.</p>
<p>We recommend that you use HTTP for many cases. Because there are many
HTTP client libraries.</p>
<p>If you want to use GQTP, you can use the following libraries:</p>
<blockquote>
<div><ul class="simple">
<li><p>Ruby: <a class="reference external" href="https://github.com/ranguba/groonga-client">groonga-client</a></p></li>
<li><p>Python: <a class="reference external" href="https://github.com/hhatto/poyonga">poyonga</a></p></li>
<li><p>Go: <a class="reference external" href="https://github.com/hhatto/goroo">goroo</a></p></li>
<li><p>PHP: <a class="reference external" href="https://github.com/Yujiro3/proonga">proonga</a></p></li>
<li><p>C/C++: Groonga (Groonga can be also used as library)</p></li>
</ul>
</div></blockquote>
<p>It’s not a library but you can use
<a class="reference internal" href="../reference/executables/groonga.html"><span class="doc">groonga executable file</span></a> as a GQTP client.</p>
</div>
<div class="section" id="how-to-run">
<h2><span class="section-number">5.3.2. </span>How to run<a class="headerlink" href="#how-to-run" title="Permalink to this headline">¶</a></h2>
<p><a class="reference internal" href="../reference/executables/groonga.html"><span class="doc">groonga executable file</span></a> is a GQTP server implementation.
You can run a Groonga server by the following command line:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>groonga --protocol gqtp -s [options] DB_PATH
</pre></div>
</div>
<p>You can run a Groonga server as a daemon by the following command
line:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>groonga --protocol gqtp -d [options] DB_PATH
</pre></div>
</div>
<p>See <a class="reference internal" href="../reference/executables/groonga.html"><span class="doc">groonga executable file</span></a> for available <code class="docutils literal notranslate"><span class="pre">options</span></code>.</p>
</div>
</div>


            <div class="clearer"></div>
          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
  <h3><a href="../index.html">Table of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">5.3. GQTP</a><ul>
<li><a class="reference internal" href="#summary">5.3.1. Summary</a></li>
<li><a class="reference internal" href="#how-to-run">5.3.2. How to run</a></li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="http/groonga-httpd.html"
                        title="previous chapter"><span class="section-number">5.2.3. </span>groonga-httpd</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="memcached.html"
                        title="next chapter"><span class="section-number">5.4. </span>Memcached binary protocol</a></p>
<div id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" />
      <input type="submit" value="Go" />
    </form>
    </div>
</div>
<script>$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="memcached.html" title="5.4. Memcached binary protocol"
             >next</a> |</li>
        <li class="right" >
          <a href="http/groonga-httpd.html" title="5.2.3. groonga-httpd"
             >previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../index.html">Groonga v10.1.1-31-g1e46ba6 documentation</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="../server.html" ><span class="section-number">5. </span>Server</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href=""><span class="section-number">5.3. </span>GQTP</a></li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
        &#169; Copyright 2009-2021, Brazil, Inc.
    </div>
  </body>
</html>