File: configuration.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 (162 lines) | stat: -rw-r--r-- 7,773 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


<!DOCTYPE html>

<html lang="en">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>7.18. Configuration &#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.19. Alias" href="alias.html" />
    <link rel="prev" title="7.17.2. Prefix RK search" href="operations/prefix_rk_search.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/configuration.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="alias.html" title="7.19. Alias"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="operations/prefix_rk_search.html" title="7.17.2. Prefix RK search"
             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.18. </span>Configuration</a></li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <div class="section" id="configuration">
<h1><span class="section-number">7.18. </span>Configuration<a class="headerlink" href="#configuration" title="Permalink to this headline">¶</a></h1>
<div class="versionadded">
<p><span class="versionmodified added">New in version 5.1.2.</span></p>
</div>
<p>Groonga can manage configuration items in each database. These
configuration items are persistent. It means that these configuration
items are usable after a Groonga process exits.</p>
<div class="section" id="summary">
<h2><span class="section-number">7.18.1. </span>Summary<a class="headerlink" href="#summary" title="Permalink to this headline">¶</a></h2>
<p>You can change some Groonga behaviors such as <a class="reference internal" href="../spec/search.html"><span class="doc">検索</span></a> by
some ways such as request parameter
(<a class="reference internal" href="commands/select.html#select-match-escalation-threshold"><span class="std std-ref">match_escalation_threshold</span></a>) and build parameter
(<a class="reference internal" href="../install/others.html#install-configure-with-match-escalation-threshold"><span class="std std-ref">--with-match-escalation-threshold=NUMBER</span></a>).</p>
<p>Configuration is one of these ways. You can change some Groonga
behaviors per database by configuration.</p>
<p>A configuration item consists of key and value. Both of key and value
are string. The max key size is 4KiB. The max value size is 4091B (=
4KiB - 5B).</p>
<p>You can set a configuration item by
<a class="reference internal" href="commands/config_set.html"><span class="doc">config_set</span></a>.</p>
<p>You can get a configuration item by
<a class="reference internal" href="commands/config_get.html"><span class="doc">config_get</span></a>.</p>
<p>You can delete a configuration item by
<a class="reference internal" href="commands/config_delete.html"><span class="doc">config_delete</span></a>.</p>
<p>You can confirm all configuration items by
<a class="reference internal" href="commands/dump.html"><span class="doc">dump</span></a>.</p>
</div>
<div class="section" id="commands">
<span id="configuration-commands"></span><h2><span class="section-number">7.18.2. </span>Commands<a class="headerlink" href="#commands" title="Permalink to this headline">¶</a></h2>
<blockquote>
<div><ul class="simple">
<li><p><a class="reference internal" href="commands/config_delete.html"><span class="doc">config_delete</span></a></p></li>
<li><p><a class="reference internal" href="commands/config_get.html"><span class="doc">config_get</span></a></p></li>
<li><p><a class="reference internal" href="commands/config_set.html"><span class="doc">config_set</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.18. Configuration</a><ul>
<li><a class="reference internal" href="#summary">7.18.1. Summary</a></li>
<li><a class="reference internal" href="#commands">7.18.2. Commands</a></li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="operations/prefix_rk_search.html"
                        title="previous chapter"><span class="section-number">7.17.2. </span>Prefix RK search</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="alias.html"
                        title="next chapter"><span class="section-number">7.19. </span>Alias</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="alias.html" title="7.19. Alias"
             >next</a> |</li>
        <li class="right" >
          <a href="operations/prefix_rk_search.html" title="7.17.2. Prefix RK search"
             >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.18. </span>Configuration</a></li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
        &#169; Copyright 2009-2021, Brazil, Inc.
    </div>
  </body>
</html>