File: cache_limit.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 (206 lines) | stat: -rw-r--r-- 11,171 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
 


<!DOCTYPE html>

<html lang="en">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>7.3.7. cache_limit &#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.8. check" href="check.html" />
    <link rel="prev" title="7.3.6. Return code" href="../command/return_code.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/commands/cache_limit.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="check.html" title="7.3.8. check"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="../command/return_code.html" title="7.3.6. Return code"
             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="../command.html" accesskey="U"><span class="section-number">7.3. </span>Command</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href=""><span class="section-number">7.3.7. </span><code class="docutils literal notranslate"><span class="pre">cache_limit</span></code></a></li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <div class="section" id="cache-limit">
<h1><span class="section-number">7.3.7. </span><code class="docutils literal notranslate"><span class="pre">cache_limit</span></code><a class="headerlink" href="#cache-limit" title="Permalink to this headline">¶</a></h1>
<div class="section" id="summary">
<h2><span class="section-number">7.3.7.1. </span>Summary<a class="headerlink" href="#summary" title="Permalink to this headline">¶</a></h2>
<p><code class="docutils literal notranslate"><span class="pre">cache_limit</span></code> gets or sets the max number of query cache
entries. Query cache is used only by <a class="reference internal" href="select.html"><span class="doc">select</span></a> command.</p>
<p>If the max number of query cache entries is 100, the recent 100
<code class="docutils literal notranslate"><span class="pre">select</span></code> commands are only cached. The cache expire algorithm is LRU
(least recently used).</p>
</div>
<div class="section" id="syntax">
<h2><span class="section-number">7.3.7.2. </span>Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2>
<p>This command takes only one optional parameter:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>cache_limit [max=null]
</pre></div>
</div>
</div>
<div class="section" id="usage">
<h2><span class="section-number">7.3.7.3. </span>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
<p>You can get the current max number of cache entries by executing
<code class="docutils literal notranslate"><span class="pre">cache_limit</span></code> without parameter.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>cache_limit
# [[0, 1337566253.89858, 0.000355720520019531], 100]
</pre></div>
</div>
<p>You can set the max number of cache entries by executing <code class="docutils literal notranslate"><span class="pre">cache_limit</span></code>
with <code class="docutils literal notranslate"><span class="pre">max</span></code> parameter.</p>
<p>Here is an example that sets <code class="docutils literal notranslate"><span class="pre">10</span></code> as the max number of cache
entries.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>cache_limit 10
# [[0, 1337566253.89858, 0.000355720520019531], 100]
cache_limit
# [[0, 1337566253.89858, 0.000355720520019531], 10]
</pre></div>
</div>
<p>If <code class="docutils literal notranslate"><span class="pre">max</span></code> parameter is used, the return value is the max number of
cache entries before <code class="docutils literal notranslate"><span class="pre">max</span></code> parameter is set.</p>
</div>
<div class="section" id="parameters">
<h2><span class="section-number">7.3.7.4. </span>Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></h2>
<p>This section describes all parameters.</p>
<div class="section" id="max">
<h3><span class="section-number">7.3.7.4.1. </span><code class="docutils literal notranslate"><span class="pre">max</span></code><a class="headerlink" href="#max" title="Permalink to this headline">¶</a></h3>
<p>Specifies the max number of query cache entries as a number.</p>
<p>If <code class="docutils literal notranslate"><span class="pre">max</span></code> parameter isn’t specified, the current max number of query
cache entries isn’t changed. <code class="docutils literal notranslate"><span class="pre">cache_limit</span></code> just returns the current
max number of query cache entries.</p>
</div>
</div>
<div class="section" id="return-value">
<h2><span class="section-number">7.3.7.5. </span>Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2>
<p><code class="docutils literal notranslate"><span class="pre">cache_limit</span></code> returns the current max number of query cache entries:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>[HEADER, N_ENTRIES]
</pre></div>
</div>
<p><code class="docutils literal notranslate"><span class="pre">HEADER</span></code></p>
<blockquote>
<div><p>See <a class="reference internal" href="../command/output_format.html"><span class="doc">Output format</span></a> about <code class="docutils literal notranslate"><span class="pre">HEADER</span></code>.</p>
</div></blockquote>
<p><code class="docutils literal notranslate"><span class="pre">N_ENTRIES</span></code></p>
<blockquote>
<div><p><code class="docutils literal notranslate"><span class="pre">N_ENTRIES</span></code> is the current max number of query cache entries. It
is a number.</p>
</div></blockquote>
</div>
<div class="section" id="see-also">
<h2><span class="section-number">7.3.7.6. </span>See also<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><p><a class="reference internal" href="select.html"><span class="doc">select</span></a></p></li>
</ul>
</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.3.7. <code class="docutils literal notranslate"><span class="pre">cache_limit</span></code></a><ul>
<li><a class="reference internal" href="#summary">7.3.7.1. Summary</a></li>
<li><a class="reference internal" href="#syntax">7.3.7.2. Syntax</a></li>
<li><a class="reference internal" href="#usage">7.3.7.3. Usage</a></li>
<li><a class="reference internal" href="#parameters">7.3.7.4. Parameters</a><ul>
<li><a class="reference internal" href="#max">7.3.7.4.1. <code class="docutils literal notranslate"><span class="pre">max</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#return-value">7.3.7.5. Return value</a></li>
<li><a class="reference internal" href="#see-also">7.3.7.6. See also</a></li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="../command/return_code.html"
                        title="previous chapter"><span class="section-number">7.3.6. </span>Return code</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="check.html"
                        title="next chapter"><span class="section-number">7.3.8. </span><code class="docutils literal notranslate"><span class="pre">check</span></code></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="check.html" title="7.3.8. check"
             >next</a> |</li>
        <li class="right" >
          <a href="../command/return_code.html" title="7.3.6. Return code"
             >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="../command.html" ><span class="section-number">7.3. </span>Command</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href=""><span class="section-number">7.3.7. </span><code class="docutils literal notranslate"><span class="pre">cache_limit</span></code></a></li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
        &#169; Copyright 2009-2021, Brazil, Inc.
    </div>
  </body>
</html>