File: command.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 (194 lines) | stat: -rw-r--r-- 17,983 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
 


<!DOCTYPE html>

<html lang="en">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>7.3. Command &#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.3.1. Command version" href="command/command_version.html" />
    <link rel="prev" title="7.2. Output" href="output.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/command.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="command/command_version.html" title="7.3.1. Command version"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="output.html" title="7.2. Output"
             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" accesskey="U"><span class="section-number">7. </span>Reference manual</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href=""><span class="section-number">7.3. </span>Command</a></li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <div class="section" id="command">
<h1><span class="section-number">7.3. </span>Command<a class="headerlink" href="#command" title="Permalink to this headline">¶</a></h1>
<p>Command is the most important processing unit in query API. You
request a processing to groonga by a command.</p>
<p>This section describes about command and built-in commands.</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="command/command_version.html">7.3.1. Command version</a></li>
<li class="toctree-l1"><a class="reference internal" href="command/output_format.html">7.3.2. Output format</a></li>
<li class="toctree-l1"><a class="reference internal" href="command/pretty_print.html">7.3.3. Pretty print</a></li>
<li class="toctree-l1"><a class="reference internal" href="command/request_id.html">7.3.4. Request ID</a></li>
<li class="toctree-l1"><a class="reference internal" href="command/request_timeout.html">7.3.5. Request timeout</a></li>
<li class="toctree-l1"><a class="reference internal" href="command/return_code.html">7.3.6. Return code</a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/cache_limit.html">7.3.7. <code class="docutils literal notranslate"><span class="pre">cache_limit</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/check.html">7.3.8. <code class="docutils literal notranslate"><span class="pre">check</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/clearlock.html">7.3.9. <code class="docutils literal notranslate"><span class="pre">clearlock</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/column_copy.html">7.3.10. <code class="docutils literal notranslate"><span class="pre">column_copy</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/column_create.html">7.3.11. <code class="docutils literal notranslate"><span class="pre">column_create</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/column_list.html">7.3.12. <code class="docutils literal notranslate"><span class="pre">column_list</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/column_remove.html">7.3.13. <code class="docutils literal notranslate"><span class="pre">column_remove</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/column_rename.html">7.3.14. <code class="docutils literal notranslate"><span class="pre">column_rename</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/config_delete.html">7.3.15. <code class="docutils literal notranslate"><span class="pre">config_delete</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/config_get.html">7.3.16. <code class="docutils literal notranslate"><span class="pre">config_get</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/config_set.html">7.3.17. <code class="docutils literal notranslate"><span class="pre">config_set</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/database_unmap.html">7.3.18. <code class="docutils literal notranslate"><span class="pre">database_unmap</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/define_selector.html">7.3.19. <code class="docutils literal notranslate"><span class="pre">define_selector</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/defrag.html">7.3.20. <code class="docutils literal notranslate"><span class="pre">defrag</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/delete.html">7.3.21. <code class="docutils literal notranslate"><span class="pre">delete</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/dump.html">7.3.22. <code class="docutils literal notranslate"><span class="pre">dump</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/index_column_diff.html">7.3.23. <code class="docutils literal notranslate"><span class="pre">index_column_diff</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/io_flush.html">7.3.24. <code class="docutils literal notranslate"><span class="pre">io_flush</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/load.html">7.3.25. <code class="docutils literal notranslate"><span class="pre">load</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/lock_acquire.html">7.3.26. <code class="docutils literal notranslate"><span class="pre">lock_acquire</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/lock_clear.html">7.3.27. <code class="docutils literal notranslate"><span class="pre">lock_clear</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/lock_release.html">7.3.28. <code class="docutils literal notranslate"><span class="pre">lock_release</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/log_level.html">7.3.29. <code class="docutils literal notranslate"><span class="pre">log_level</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/log_put.html">7.3.30. <code class="docutils literal notranslate"><span class="pre">log_put</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/log_reopen.html">7.3.31. <code class="docutils literal notranslate"><span class="pre">log_reopen</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/logical_count.html">7.3.32. <code class="docutils literal notranslate"><span class="pre">logical_count</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/logical_parameters.html">7.3.33. <code class="docutils literal notranslate"><span class="pre">logical_parameters</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/logical_range_filter.html">7.3.34. <code class="docutils literal notranslate"><span class="pre">logical_range_filter</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/logical_select.html">7.3.35. <code class="docutils literal notranslate"><span class="pre">logical_select</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/logical_shard_list.html">7.3.36. <code class="docutils literal notranslate"><span class="pre">logical_shard_list</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/logical_table_remove.html">7.3.37. <code class="docutils literal notranslate"><span class="pre">logical_table_remove</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/normalize.html">7.3.38. <code class="docutils literal notranslate"><span class="pre">normalize</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/normalizer_list.html">7.3.39. <code class="docutils literal notranslate"><span class="pre">normalizer_list</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/object_exist.html">7.3.40. <code class="docutils literal notranslate"><span class="pre">object_exist</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/object_inspect.html">7.3.41. <code class="docutils literal notranslate"><span class="pre">object_inspect</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/object_list.html">7.3.42. <code class="docutils literal notranslate"><span class="pre">object_list</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/object_remove.html">7.3.43. <code class="docutils literal notranslate"><span class="pre">object_remove</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/plugin_register.html">7.3.44. <code class="docutils literal notranslate"><span class="pre">plugin_register</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/plugin_unregister.html">7.3.45. <code class="docutils literal notranslate"><span class="pre">plugin_unregister</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/query_expand.html">7.3.46. <code class="docutils literal notranslate"><span class="pre">query_expand</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/quit.html">7.3.47. <code class="docutils literal notranslate"><span class="pre">quit</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/range_filter.html">7.3.48. <code class="docutils literal notranslate"><span class="pre">range_filter</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/reference_acquire.html">7.3.49. <code class="docutils literal notranslate"><span class="pre">reference_acquire</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/reference_release.html">7.3.50. <code class="docutils literal notranslate"><span class="pre">reference_release</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/register.html">7.3.51. <code class="docutils literal notranslate"><span class="pre">register</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/reindex.html">7.3.52. <code class="docutils literal notranslate"><span class="pre">reindex</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/request_cancel.html">7.3.53. <code class="docutils literal notranslate"><span class="pre">request_cancel</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/ruby_eval.html">7.3.54. <code class="docutils literal notranslate"><span class="pre">ruby_eval</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/ruby_load.html">7.3.55. <code class="docutils literal notranslate"><span class="pre">ruby_load</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/schema.html">7.3.56. <code class="docutils literal notranslate"><span class="pre">schema</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/select.html">7.3.57. <code class="docutils literal notranslate"><span class="pre">select</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/shutdown.html">7.3.58. <code class="docutils literal notranslate"><span class="pre">shutdown</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/status.html">7.3.59. <code class="docutils literal notranslate"><span class="pre">status</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/suggest.html">7.3.60. <code class="docutils literal notranslate"><span class="pre">suggest</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/table_copy.html">7.3.61. <code class="docutils literal notranslate"><span class="pre">table_copy</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/table_create.html">7.3.62. <code class="docutils literal notranslate"><span class="pre">table_create</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/table_list.html">7.3.63. <code class="docutils literal notranslate"><span class="pre">table_list</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/table_remove.html">7.3.64. <code class="docutils literal notranslate"><span class="pre">table_remove</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/table_rename.html">7.3.65. <code class="docutils literal notranslate"><span class="pre">table_rename</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/table_tokenize.html">7.3.66. <code class="docutils literal notranslate"><span class="pre">table_tokenize</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/thread_limit.html">7.3.67. <code class="docutils literal notranslate"><span class="pre">thread_limit</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/tokenize.html">7.3.68. <code class="docutils literal notranslate"><span class="pre">tokenize</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/tokenizer_list.html">7.3.69. <code class="docutils literal notranslate"><span class="pre">tokenizer_list</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/truncate.html">7.3.70. <code class="docutils literal notranslate"><span class="pre">truncate</span></code></a></li>
</ul>
</div>
</div>


            <div class="clearer"></div>
          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
  <h4>Previous topic</h4>
  <p class="topless"><a href="output.html"
                        title="previous chapter"><span class="section-number">7.2. </span>Output</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="command/command_version.html"
                        title="next chapter"><span class="section-number">7.3.1. </span>Command version</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="command/command_version.html" title="7.3.1. Command version"
             >next</a> |</li>
        <li class="right" >
          <a href="output.html" title="7.2. Output"
             >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-this"><a href=""><span class="section-number">7.3. </span>Command</a></li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
        &#169; Copyright 2009-2021, Brazil, Inc.
    </div>
  </body>
</html>