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
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
|
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>4.2. Remote access — 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="4.3. Various data types" href="data.html" />
<link rel="prev" title="4.1. Basic operations" href="introduction.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/tutorial/network.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="data.html" title="4.3. Various data types"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="introduction.html" title="4.1. Basic operations"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Groonga v10.1.1-31-g1e46ba6 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="../tutorial.html" accesskey="U"><span class="section-number">4. </span>Tutorial</a> »</li>
<li class="nav-item nav-item-this"><a href=""><span class="section-number">4.2. </span>Remote access</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="remote-access">
<h1><span class="section-number">4.2. </span>Remote access<a class="headerlink" href="#remote-access" title="Permalink to this headline">¶</a></h1>
<p>You can use Groonga as a server which allows remote access. Groonga supports the original protocol (GQTP), the memcached binary protocol and HTTP.</p>
<div class="section" id="hypertext-transfer-protocol-http">
<h2><span class="section-number">4.2.1. </span>Hypertext transfer protocol (HTTP)<a class="headerlink" href="#hypertext-transfer-protocol-http" title="Permalink to this headline">¶</a></h2>
<div class="section" id="how-to-run-an-http-server">
<h3><span class="section-number">4.2.1.1. </span>How to run an HTTP server<a class="headerlink" href="#how-to-run-an-http-server" title="Permalink to this headline">¶</a></h3>
<p>Groonga supports the hypertext transfer protocol (HTTP). The following form shows how to run Groonga as an HTTP server daemon.</p>
<p>Form:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>groonga [-p PORT_NUMBER] -d --protocol http DB_PATH
</pre></div>
</div>
<p>The <cite>–protocol</cite> option and its argument specify the protocol of the server. “http” specifies to use HTTP. If the <cite>-p</cite> option is not specified, Groonga uses the default port number 10041.</p>
<p>The following command runs an HTTP server that listens on the port number 80.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>% sudo groonga -p 80 -d --protocol http /tmp/groonga-databases/introduction.db
%
</pre></div>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>You must have root privileges if you listen on the port number 80 (well known port).
There is no such a limitation about the port number 1024 or over.</p>
</div>
</div>
<div class="section" id="how-to-send-a-command-to-an-http-server">
<h3><span class="section-number">4.2.1.2. </span>How to send a command to an HTTP server<a class="headerlink" href="#how-to-send-a-command-to-an-http-server" title="Permalink to this headline">¶</a></h3>
<p>You can send a command to an HTTP server by sending a GET request to /d/COMMAND_NAME. Command parameters can be passed as parameters of the GET request. The format is “?NAME_1=VALUE_1&NAME_2=VALUE_2&…”.</p>
<p>The following example shows how to send commands to an HTTP server.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>http://HOST_NAME_OR_IP_ADDRESS[:PORT_NUMBER]/d/status
Executed command:
status
# [
# [
# 0,
# 1337566253.89858,
# 0.000355720520019531
# ],
# {
# "uptime": 0,
# "max_command_version": 3,
# "start_time": 1514346072,
# "cache_hit_rate": 0.0,
# "version": "7.0.9",
# "alloc_count": 13344,
# "command_version": 1,
# "starttime": 1514346072,
# "default_command_version": 1,
# "n_queries": 0
# }
# ]
http://HOST_NAME_OR_IP_ADDRESS[:PORT_NUMBER]/d/select?table=Site&query=title:@this
Executed command:
select --table Site --query title:@this
# [
# [
# 0,
# 1337566253.89858,
# 0.000355720520019531
# ],
# [
# [
# [
# 1
# ],
# [
# [
# "_id",
# "UInt32"
# ],
# [
# "_key",
# "ShortText"
# ],
# [
# "country",
# "SiteCountry"
# ],
# [
# "domain",
# "SiteDomain"
# ],
# [
# "link",
# "Site"
# ],
# [
# "links",
# "Site"
# ],
# [
# "location",
# "WGS84GeoPoint"
# ],
# [
# "title",
# "ShortText"
# ]
# ],
# [
# 1,
# "http://example.org/",
# "japan",
# ".org",
# "http://example.net/",
# [
# "http://example.net/",
# "http://example.org/",
# "http://example.com/"
# ],
# "128452975x503157902",
# "This is test record 1!"
# ]
# ]
# ]
# ]
</pre></div>
</div>
</div>
</div>
<div class="section" id="administration-tool-http">
<h2><span class="section-number">4.2.2. </span>Administration tool (HTTP)<a class="headerlink" href="#administration-tool-http" title="Permalink to this headline">¶</a></h2>
<p>An HTTP server of Groonga provides a browser based administration tool that makes database management easy. After starting an HTTP server, you can use the administration tool by accessing <a class="reference external" href="http://HOST_NAME_OR_IP_ADDRESS[:PORT_NUMBER]/">http://HOST_NAME_OR_IP_ADDRESS[:PORT_NUMBER]/</a>. Note that Javascript must be enabled for the tool to work properly.</p>
</div>
<div class="section" id="security-issues">
<h2><span class="section-number">4.2.3. </span>Security issues<a class="headerlink" href="#security-issues" title="Permalink to this headline">¶</a></h2>
<p>Groonga servers don’t support user authentication. Everyone can view and modify databases hosted by Groonga servers. You are recommended to restrict IP addresses that can access Groonga servers. You can use iptables or similar for this purpose.</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="#">4.2. Remote access</a><ul>
<li><a class="reference internal" href="#hypertext-transfer-protocol-http">4.2.1. Hypertext transfer protocol (HTTP)</a><ul>
<li><a class="reference internal" href="#how-to-run-an-http-server">4.2.1.1. How to run an HTTP server</a></li>
<li><a class="reference internal" href="#how-to-send-a-command-to-an-http-server">4.2.1.2. How to send a command to an HTTP server</a></li>
</ul>
</li>
<li><a class="reference internal" href="#administration-tool-http">4.2.2. Administration tool (HTTP)</a></li>
<li><a class="reference internal" href="#security-issues">4.2.3. Security issues</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="introduction.html"
title="previous chapter"><span class="section-number">4.1. </span>Basic operations</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="data.html"
title="next chapter"><span class="section-number">4.3. </span>Various data types</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="data.html" title="4.3. Various data types"
>next</a> |</li>
<li class="right" >
<a href="introduction.html" title="4.1. Basic operations"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Groonga v10.1.1-31-g1e46ba6 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="../tutorial.html" ><span class="section-number">4. </span>Tutorial</a> »</li>
<li class="nav-item nav-item-this"><a href=""><span class="section-number">4.2. </span>Remote access</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2009-2021, Brazil, Inc.
</div>
</body>
</html>
|
