git.m6w6.name Git - m6w6/libmemcached/blob - bin/memflush.html

   1
   2
   3 <!DOCTYPE html>
   4 <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
   5 <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
   6 <head>
   7   <meta charset="utf-8">
   8
   9   <meta name="viewport" content="width=device-width, initial-scale=1.0">
  10
  11   <title>memflush &mdash; libmemcached 1.0.99 documentation</title>
  12
  13
  14
  15
  16
  17
  18
  19
  20   <script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
  21
  22
  23       <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
  24         <script src="../_static/jquery.js"></script>
  25         <script src="../_static/underscore.js"></script>
  26         <script src="../_static/doctools.js"></script>
  27         <script src="../_static/language_data.js"></script>
  28
  29     <script type="text/javascript" src="../_static/js/theme.js"></script>
  30
  31
  32
  33
  34   <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
  35   <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
  36     <link rel="index" title="Index" href="../genindex.html" />
  37     <link rel="search" title="Search" href="../search.html" />
  38     <link rel="copyright" title="Copyright" href="../copyright.html" />
  39     <link rel="next" title="Copyright" href="../copyright.html" />
  40     <link rel="prev" title="memdump" href="memdump.html" />
  41 </head>
  42
  43 <body class="wy-body-for-nav">
  44
  45
  46   <div class="wy-grid-for-nav">
  47
  48     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  49       <div class="wy-side-scroll">
  50         <div class="wy-side-nav-search" >
  51
  52
  53
  54             <a href="../index.html" class="icon icon-home"> libmemcached
  55
  56
  57
  58           </a>
  59
  60
  61
  62
  63               <div class="version">
  64                 1.0
  65               </div>
  66
  67
  68
  69
  70 <div role="search">
  71   <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
  72     <input type="text" name="q" placeholder="Search docs" />
  73     <input type="hidden" name="check_keywords" value="yes" />
  74     <input type="hidden" name="area" value="default" />
  75   </form>
  76 </div>
  77
  78
  79         </div>
  80
  81         <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  82
  83
  84
  85
  86
  87
  88               <p class="caption"><span class="caption-text">libmemcached</span></p>
  89 <ul>
  90 <li class="toctree-l1"><a class="reference internal" href="../libmemcached.html">Introduction</a></li>
  91 <li class="toctree-l1"><a class="reference internal" href="../libmemcached/index.html">libmemcached API</a></li>
  92 <li class="toctree-l1"><a class="reference internal" href="../libmemcached/index_misc.html">Misc</a></li>
  93 </ul>
  94 <p class="caption"><span class="caption-text">libmemcachedutil</span></p>
  95 <ul>
  96 <li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil.html">Introduction</a></li>
  97 <li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil/index.html">libmemcachedutil API</a></li>
  98 </ul>
  99 <p class="caption"><span class="caption-text">libhashkit</span></p>
 100 <ul>
 101 <li class="toctree-l1"><a class="reference internal" href="../libhashkit.html">Introduction</a></li>
 102 <li class="toctree-l1"><a class="reference internal" href="../libhashkit/index.html">libhashkit API</a></li>
 103 </ul>
 104 <p class="caption"><span class="caption-text">Client Applications</span></p>
 105 <ul class="current">
 106 <li class="toctree-l1 current"><a class="reference internal" href="index.html">Client Applications</a><ul class="current">
 107 <li class="toctree-l2"><a class="reference internal" href="index.html#data-manipulation">Data Manipulation</a></li>
 108 <li class="toctree-l2"><a class="reference internal" href="index.html#tests-and-analysis">Tests and Analysis</a></li>
 109 <li class="toctree-l2 current"><a class="reference internal" href="index.html#server-administration">Server Administration</a><ul class="current">
 110 <li class="toctree-l3"><a class="reference internal" href="memdump.html">memdump — Dump a server's data</a></li>
 111 <li class="toctree-l3 current"><a class="current reference internal" href="#">memflush — Flush a server (erase all cached data)</a><ul>
 112 <li class="toctree-l4"><a class="reference internal" href="#synopsis">SYNOPSIS</a></li>
 113 <li class="toctree-l4"><a class="reference internal" href="#description">DESCRIPTION</a></li>
 114 <li class="toctree-l4"><a class="reference internal" href="#options">OPTIONS</a></li>
 115 <li class="toctree-l4"><a class="reference internal" href="#environment">ENVIRONMENT</a></li>
 116 <li class="toctree-l4"><a class="reference internal" href="#see-also">SEE ALSO</a></li>
 117 </ul>
 118 </li>
 119 </ul>
 120 </li>
 121 </ul>
 122 </li>
 123 </ul>
 124 <p class="caption"><span class="caption-text">Copyright</span></p>
 125 <ul>
 126 <li class="toctree-l1"><a class="reference internal" href="../copyright.html">Copyright</a></li>
 127 </ul>
 128
 129
 130
 131         </div>
 132       </div>
 133     </nav>
 134
 135     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 136
 137
 138       <nav class="wy-nav-top" aria-label="top navigation">
 139
 140           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
 141           <a href="../index.html">libmemcached</a>
 142
 143       </nav>
 144
 145
 146       <div class="wy-nav-content">
 147
 148         <div class="rst-content">
 149
 150
 151
 152
 153
 154
 155
 156
 157
 158
 159
 160
 161
 162
 163
 164
 165
 166 <div role="navigation" aria-label="breadcrumbs navigation">
 167
 168   <ul class="wy-breadcrumbs">
 169
 170       <li><a href="../index.html">Docs</a> &raquo;</li>
 171
 172           <li><a href="index.html">Client Applications</a> &raquo;</li>
 173
 174       <li>memflush</li>
 175
 176
 177       <li class="wy-breadcrumbs-aside">
 178
 179
 180
 181       </li>
 182
 183   </ul>
 184
 185
 186   <hr/>
 187 </div>
 188           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
 189            <div itemprop="articleBody">
 190
 191   <div class="section" id="memflush">
 192 <h1>memflush<a class="headerlink" href="#memflush" title="Permalink to this headline">¶</a></h1>
 193 <div class="section" id="synopsis">
 194 <h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
 195 <p>memflush [options]</p>
 196 <p>Reset a server or list of servers</p>
 197 </div>
 198 <div class="section" id="description">
 199 <h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
 200 <p><strong class="program">memflush</strong>  resets the contents of <em class="manpage"><a class="manpage reference external" href="https://linux.die.net/man/1/memcached">memcached(1)</a></em> servers.</p>
 201 <div class="admonition warning">
 202 <p class="admonition-title">Warning</p>
 203 <p>This means that all data in the specified servers will be deleted.</p>
 204 </div>
 205 </div>
 206 <div class="section" id="options">
 207 <h2>OPTIONS<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h2>
 208 <dl class="std option">
 209 <dt id="cmdoption-memflush-help">
 210 <code class="sig-name descname">--help</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-memflush-help" title="Permalink to this definition">¶</a></dt>
 211 <dd><p>Display help.</p>
 212 </dd></dl>
 213
 214 <dl class="std option">
 215 <dt id="cmdoption-memflush-version">
 216 <code class="sig-name descname">--version</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-memflush-version" title="Permalink to this definition">¶</a></dt>
 217 <dd><p>Display version.</p>
 218 </dd></dl>
 219
 220 <dl class="std option">
 221 <dt id="cmdoption-memflush-quiet">
 222 <code class="sig-name descname">--quiet</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-memflush-quiet" title="Permalink to this definition">¶</a></dt>
 223 <dd><p>Operate quietly.</p>
 224 </dd></dl>
 225
 226 <dl class="std option">
 227 <dt id="cmdoption-memflush-verbose">
 228 <code class="sig-name descname">--verbose</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-memflush-verbose" title="Permalink to this definition">¶</a></dt>
 229 <dd><p>Operate more verbosely.</p>
 230 </dd></dl>
 231
 232 <dl class="std option">
 233 <dt id="cmdoption-memflush-debug">
 234 <code class="sig-name descname">--debug</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-memflush-debug" title="Permalink to this definition">¶</a></dt>
 235 <dd><p>See <a class="reference internal" href="#cmdoption-memflush-verbose"><code class="xref std std-option docutils literal notranslate"><span class="pre">--verbose</span></code></a>.</p>
 236 </dd></dl>
 237
 238 <dl class="std option">
 239 <dt id="cmdoption-memflush-servers">
 240 <code class="sig-name descname">--servers</code><code class="sig-prename descclassname"> &lt;list of servers&gt;</code><a class="headerlink" href="#cmdoption-memflush-servers" title="Permalink to this definition">¶</a></dt>
 241 <dd><p>Specify the list of servers as <em>hostname[:port][,hostname[:port]...]</em>.</p>
 242 </dd></dl>
 243
 244 <dl class="std option">
 245 <dt id="cmdoption-memflush-binary">
 246 <code class="sig-name descname">--binary</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-memflush-binary" title="Permalink to this definition">¶</a></dt>
 247 <dd><p>Enable binary protocol.</p>
 248 </dd></dl>
 249
 250 <dl class="std option">
 251 <dt id="cmdoption-memflush-username">
 252 <code class="sig-name descname">--username</code><code class="sig-prename descclassname"> &lt;username&gt;</code><a class="headerlink" href="#cmdoption-memflush-username" title="Permalink to this definition">¶</a></dt>
 253 <dd><p>Use <em>username</em> for SASL authentication.</p>
 254 </dd></dl>
 255
 256 <dl class="std option">
 257 <dt id="cmdoption-memflush-password">
 258 <code class="sig-name descname">--password</code><code class="sig-prename descclassname"> &lt;password&gt;</code><a class="headerlink" href="#cmdoption-memflush-password" title="Permalink to this definition">¶</a></dt>
 259 <dd><p>Use <em>password</em> for SASL authentication.</p>
 260 </dd></dl>
 261
 262 <dl class="std option">
 263 <dt id="cmdoption-memflush-expire">
 264 <code class="sig-name descname">--expire</code><code class="sig-prename descclassname"> &lt;expiration&gt;</code><a class="headerlink" href="#cmdoption-memflush-expire" title="Permalink to this definition">¶</a></dt>
 265 <dd><p>Use <em>expiration</em> seconds (or a UNIX timestamp).</p>
 266 </dd></dl>
 267
 268 <div class="admonition note">
 269 <p class="admonition-title">Note</p>
 270 <p>Using an expiration time (period), all keys, which have not bean updated until expiration will cease to exist.</p>
 271 <p>Quoting the <a class="reference external" href="https://github.com/memcached/memcached/blob/master/doc/protocol.txt">memcached protocol documentation</a>, it states:</p>
 272 <blockquote>
 273 <div><p>Its effect is to invalidate all
 274 existing items immediately (by default) or after the expiration
 275 specified.  After invalidation none of the items will be returned in
 276 response to a retrieval command (unless it's stored again under the
 277 same key <em>after</em> flush_all has invalidated the items).</p>
 278 <p>The most precise
 279 definition of what flush_all does is the following: it causes all
 280 items whose update time is earlier than the time at which flush_all
 281 was set to be executed to be ignored for retrieval purposes.</p>
 282 <p>The intent of flush_all with a delay, was that in a setting where you
 283 have a pool of memcached servers, and you need to flush all content,
 284 you have the option of not resetting all memcached servers at the
 285 same time (which could e.g. cause a spike in database load with all
 286 clients suddenly needing to recreate content that would otherwise
 287 have been found in the memcached daemon).</p>
 288 </div></blockquote>
 289 </div>
 290 </div>
 291 <div class="section" id="environment">
 292 <h2>ENVIRONMENT<a class="headerlink" href="#environment" title="Permalink to this headline">¶</a></h2>
 293 <dl class="std envvar">
 294 <dt id="envvar-MEMCACHED_SERVERS">
 295 <code class="sig-name descname">MEMCACHED_SERVERS</code><a class="headerlink" href="#envvar-MEMCACHED_SERVERS" title="Permalink to this definition">¶</a></dt>
 296 <dd><p>Specify the list of servers.</p>
 297 </dd></dl>
 298
 299 </div>
 300 <div class="section" id="see-also">
 301 <h2>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
 302 <ul class="simple">
 303 <li><p><a class="reference internal" href="../libmemcached.html"><span class="doc">C/C++ Client Library for memcached</span></a></p></li>
 304 <li><p><a class="reference internal" href="../libmemcached/memcached_flush.html"><span class="doc">Wiping clean the contents of a server</span></a></p></li>
 305 </ul>
 306 </div>
 307 </div>
 308
 309
 310            </div>
 311
 312           </div>
 313           <footer>
 314
 315     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 316
 317         <a href="../copyright.html" class="btn btn-neutral float-right" title="Copyright" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
 318
 319
 320         <a href="memdump.html" class="btn btn-neutral float-left" title="memdump" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
 321
 322     </div>
 323
 324
 325   <hr/>
 326
 327   <div role="contentinfo">
 328     <p>
 329         &copy; <a href="../copyright.html">Copyright</a>
 330
 331     </p>
 332   </div>
 333   Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
 334
 335 </footer>
 336
 337         </div>
 338       </div>
 339
 340     </section>
 341
 342   </div>
 343
 344
 345
 346   <script type="text/javascript">
 347       jQuery(function () {
 348           SphinxRtdTheme.Navigation.enable(true);
 349       });
 350   </script>
 351
 352
 353
 354
 355
 356
 357 </body>
 358 </html>