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

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