File: groonga-server-http.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 (233 lines) | stat: -rw-r--r-- 12,591 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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 


<!DOCTYPE html>

<html lang="en">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>7.1.6. Groonga HTTP server &#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="7.1.7. groonga-suggest-create-dataset" href="groonga-suggest-create-dataset.html" />
    <link rel="prev" title="7.1.5. groonga-httpd" href="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/reference/executables/groonga-server-http.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="groonga-suggest-create-dataset.html" title="7.1.7. groonga-suggest-create-dataset"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="groonga-httpd.html" title="7.1.5. 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="../../reference.html" ><span class="section-number">7. </span>Reference manual</a> &#187;</li>
          <li class="nav-item nav-item-2"><a href="../executables.html" accesskey="U"><span class="section-number">7.1. </span>Executables</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href=""><span class="section-number">7.1.6. </span>Groonga HTTP server</a></li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <div class="section" id="groonga-http-server">
<h1><span class="section-number">7.1.6. </span>Groonga HTTP server<a class="headerlink" href="#groonga-http-server" title="Permalink to this headline">¶</a></h1>
<div class="section" id="summary">
<h2><span class="section-number">7.1.6.1. </span>Summary<a class="headerlink" href="#summary" title="Permalink to this headline">¶</a></h2>
<p>You can communicate by HTTP if you specify <code class="docutils literal notranslate"><span class="pre">http</span></code> to <code class="docutils literal notranslate"><span class="pre">--protocol</span></code> option. And output a file that is put under the path, and correspond to specified URI to HTTP request if you specify static page path by <code class="docutils literal notranslate"><span class="pre">--document-root</span></code>.</p>
<p>Groonga has an Web-based administration tool implemented with HTML and JavaScript. If you don’t specify <code class="docutils literal notranslate"><span class="pre">--document-root</span></code>, regarded as administration tool installed path is specified, so you can use administration tool to access <code class="docutils literal notranslate"><span class="pre">http://HOSTNAME:PORT/</span></code> in Web browser.</p>
</div>
<div class="section" id="syntax">
<h2><span class="section-number">7.1.6.2. </span>Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2>
<p>You must specify <code class="docutils literal notranslate"><span class="pre">--protocol</span> <span class="pre">http</span></code>:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>groonga --protocol http -d [options...] DB_PATH
</pre></div>
</div>
</div>
<div class="section" id="usage">
<h2><span class="section-number">7.1.6.3. </span>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
<p>You can use HTTP GET or HTTP POST to send a request. One request runs
only one command. You can’t run multiple commands by one request.</p>
<p>You must use <code class="docutils literal notranslate"><span class="pre">/d/${COMMAND_NAME}</span></code> path for request.</p>
<p>Here is an example URL to run <a class="reference internal" href="../commands/status.html"><span class="doc">status</span></a>:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>http://127.0.0.1:10041/d/status
</pre></div>
</div>
<p>If you use HTTP GET, you must specify parameters as URL “query”.</p>
<p>Here is an example URL to specify <code class="docutils literal notranslate"><span class="pre">3</span></code> as <code class="docutils literal notranslate"><span class="pre">command_version</span></code>:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>http://127.0.0.1:10041/d/status?command_version=3
</pre></div>
</div>
<p>You can also specify multiple parameters:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>http://127.0.0.1:10041/d/status?command_version=3&amp;output_pretty=yes
</pre></div>
</div>
<p>If you use HTTP POST, you can specify parameters by URL “query” and
HTTP request body. If you use HTTP request body, you must specify
<code class="docutils literal notranslate"><span class="pre">application/x-www-form-urlencoded</span></code> as <code class="docutils literal notranslate"><span class="pre">Content-Type</span></code> header
value.</p>
<p>Here is an example HTTP POST request to specify multiple parameters by
HTTP request body:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>POST /d/status HTTP/1.1
Host: 127.0.0.1:10041
Content-Length: 35
Content-Type: application/x-www-form-urlencoded

command_version=3&amp;output_pretty=yes
</pre></div>
</div>
<p>You can mix URL “query” and HTTP request body:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>POST /d/status?command_version=3 HTTP/1.1
Host: 127.0.0.1:10041
Content-Length: 17
Content-Type: application/x-www-form-urlencoded

output_pretty=yes
</pre></div>
</div>
<p>You can also use HTTP POST to specify data for
<a class="reference internal" href="../commands/load.html"><span class="doc">load</span></a>. If you send data by HTTP POST, you
can’t specify parameters as HTTP body. You must specify parameters by
URL “path”.</p>
<p>You must specify suitable HTTP <code class="docutils literal notranslate"><span class="pre">Content-Type</span></code> header value and
<a class="reference internal" href="../commands/load.html"><span class="doc">load</span></a> <code class="docutils literal notranslate"><span class="pre">input_type</span></code> parameter value for
your data. Here are available values:</p>
<table class="docutils align-default">
<colgroup>
<col style="width: 33%" />
<col style="width: 33%" />
<col style="width: 33%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p><code class="docutils literal notranslate"><span class="pre">Content-Type</span></code></p></th>
<th class="head"><p><code class="docutils literal notranslate"><span class="pre">input_type</span></code></p></th>
<th class="head"><p>Description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">application/json</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">json</span></code></p></td>
<td><p>Send JSON data.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">application/x-apache-arrow-streaming</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">apache-arrow</span></code></p></td>
<td><p>Send Apache Arrow data.</p></td>
</tr>
</tbody>
</table>
<p>You can specify <a class="reference internal" href="../command/output_format.html"><span class="doc">Output format</span></a> as URL
“path” extension.</p>
<p>Here is an example HTTP request to get response as JSON:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>http://127.0.0.1:10041/d/status.json
</pre></div>
</div>
<p>Here is an example HTTP request to get response as XML:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>http://127.0.0.1:10041/d/status.xml
</pre></div>
</div>
</div>
<div class="section" id="see-also">
<h2><span class="section-number">7.1.6.4. </span>See also<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
<blockquote>
<div><ul class="simple">
<li><p><a class="reference internal" href="groonga-httpd.html"><span class="doc">groonga-httpd</span></a></p></li>
<li><p><a class="reference internal" href="../commands/load.html"><span class="doc">load</span></a></p></li>
</ul>
</div></blockquote>
</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="#">7.1.6. Groonga HTTP server</a><ul>
<li><a class="reference internal" href="#summary">7.1.6.1. Summary</a></li>
<li><a class="reference internal" href="#syntax">7.1.6.2. Syntax</a></li>
<li><a class="reference internal" href="#usage">7.1.6.3. Usage</a></li>
<li><a class="reference internal" href="#see-also">7.1.6.4. See also</a></li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="groonga-httpd.html"
                        title="previous chapter"><span class="section-number">7.1.5. </span>groonga-httpd</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="groonga-suggest-create-dataset.html"
                        title="next chapter"><span class="section-number">7.1.7. </span>groonga-suggest-create-dataset</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="groonga-suggest-create-dataset.html" title="7.1.7. groonga-suggest-create-dataset"
             >next</a> |</li>
        <li class="right" >
          <a href="groonga-httpd.html" title="7.1.5. 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="../../reference.html" ><span class="section-number">7. </span>Reference manual</a> &#187;</li>
          <li class="nav-item nav-item-2"><a href="../executables.html" ><span class="section-number">7.1. </span>Executables</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href=""><span class="section-number">7.1.6. </span>Groonga HTTP server</a></li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
        &#169; Copyright 2009-2021, Brazil, Inc.
    </div>
  </body>
</html>