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.1.0 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 type="text/javascript" src="../_static/jquery.js"></script>
  25         <script type="text/javascript" src="../_static/underscore.js"></script>
  26         <script type="text/javascript" src="../_static/doctools.js"></script>
  27         <script type="text/javascript" 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="Miscellaneous" href="../libmemcached/index_misc.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.1
  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               <ul class="current">
  89 <li class="toctree-l1"><a class="reference internal" href="../libmemcached.html">Introduction</a></li>
  90 <li class="toctree-l1"><a class="reference internal" href="../libmemcached/index.html">libmemcached API</a></li>
  91 <li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil/index.html">libmemcachedutil API</a></li>
  92 <li class="toctree-l1"><a class="reference internal" href="../libhashkit/index.html">libhashkit API</a></li>
  93 <li class="toctree-l1 current"><a class="reference internal" href="index.html">Client Applications</a><ul class="current">
  94 <li class="toctree-l2"><a class="reference internal" href="memexist.html">memexist — Check for the existence of a key</a></li>
  95 <li class="toctree-l2"><a class="reference internal" href="memcat.html">memcat — &quot;cat&quot; data from a server</a></li>
  96 <li class="toctree-l2"><a class="reference internal" href="memcp.html">memcp — &quot;cp&quot; files to a server</a></li>
  97 <li class="toctree-l2"><a class="reference internal" href="memtouch.html">memtouch — &quot;touch&quot; a key</a></li>
  98 <li class="toctree-l2"><a class="reference internal" href="memrm.html">memrm – &quot;rm&quot; a key</a></li>
  99 <li class="toctree-l2"><a class="reference internal" href="memaslap.html">memaslap - Load testing and benchmarking a server</a></li>
 100 <li class="toctree-l2"><a class="reference internal" href="memslap.html">memslap - Load testing and benchmarking a server</a></li>
 101 <li class="toctree-l2"><a class="reference internal" href="memping.html">memping – Ping a server</a></li>
 102 <li class="toctree-l2"><a class="reference internal" href="memstat.html">memstat – Gather statistics from a server</a></li>
 103 <li class="toctree-l2"><a class="reference internal" href="memerror.html">memerror — Translate libmemcached error codes</a></li>
 104 <li class="toctree-l2"><a class="reference internal" href="memparse.html">memparse — Parse and validate an option string</a></li>
 105 <li class="toctree-l2"><a class="reference internal" href="memcapable.html">memcapable — Check a server's capabilities and compatibility</a></li>
 106 <li class="toctree-l2"><a class="reference internal" href="memdump.html">memdump — Dump a server's data</a></li>
 107 <li class="toctree-l2 current"><a class="current reference internal" href="#">memflush — Flush a server (erase all cached data)</a></li>
 108 </ul>
 109 </li>
 110 <li class="toctree-l1"><a class="reference internal" href="../libmemcached/index_misc.html">Miscellaneous</a></li>
 111 </ul>
 112 <ul>
 113 <li class="toctree-l1"><a class="reference internal" href="../changelogs.html">Change Logs</a></li>
 114 <li class="toctree-l1"><a class="reference internal" href="../copyright.html">Copyright</a></li>
 115 </ul>
 116
 117
 118
 119         </div>
 120       </div>
 121     </nav>
 122
 123     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 124
 125
 126       <nav class="wy-nav-top" aria-label="top navigation">
 127
 128           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
 129           <a href="../index.html">libmemcached</a>
 130
 131       </nav>
 132
 133
 134       <div class="wy-nav-content">
 135
 136         <div class="rst-content">
 137
 138
 139
 140
 141
 142
 143
 144
 145
 146
 147
 148
 149
 150
 151
 152
 153
 154 <div role="navigation" aria-label="breadcrumbs navigation">
 155
 156   <ul class="wy-breadcrumbs">
 157
 158       <li><a href="../index.html">Docs</a> &raquo;</li>
 159
 160           <li><a href="index.html">Client Applications</a> &raquo;</li>
 161
 162       <li>memflush</li>
 163
 164
 165       <li class="wy-breadcrumbs-aside">
 166
 167
 168
 169               <a href="https://github.com/m6w6/libmemcached/blob/v1.x/docs/source/bin/memflush.rst" class="fa fa-github"> Edit on GitHub</a>
 170
 171
 172
 173       </li>
 174
 175   </ul>
 176
 177
 178   <hr/>
 179 </div>
 180           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
 181            <div itemprop="articleBody">
 182
 183   <div class="section" id="memflush">
 184 <h1>memflush<a class="headerlink" href="#memflush" title="Permalink to this headline">¶</a></h1>
 185 <div class="section" id="synopsis">
 186 <h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
 187 <p>memflush [options]</p>
 188 <p>Reset a server or list of servers</p>
 189 </div>
 190 <div class="section" id="description">
 191 <h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
 192 <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>
 193 <div class="admonition warning">
 194 <p class="first admonition-title">Warning</p>
 195 <p class="last">This means that all data in the specified servers will be deleted.</p>
 196 </div>
 197 </div>
 198 <div class="section" id="options">
 199 <h2>OPTIONS<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h2>
 200 <dl class="option">
 201 <dt id="cmdoption-memflush-help">
 202 <code class="descname">--help</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-memflush-help" title="Permalink to this definition">¶</a></dt>
 203 <dd><p>Display help.</p>
 204 </dd></dl>
 205
 206 <dl class="option">
 207 <dt id="cmdoption-memflush-version">
 208 <code class="descname">--version</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-memflush-version" title="Permalink to this definition">¶</a></dt>
 209 <dd><p>Display version.</p>
 210 </dd></dl>
 211
 212 <dl class="option">
 213 <dt id="cmdoption-memflush-quiet">
 214 <code class="descname">--quiet</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-memflush-quiet" title="Permalink to this definition">¶</a></dt>
 215 <dd><p>Operate quietly.</p>
 216 </dd></dl>
 217
 218 <dl class="option">
 219 <dt id="cmdoption-memflush-verbose">
 220 <code class="descname">--verbose</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-memflush-verbose" title="Permalink to this definition">¶</a></dt>
 221 <dd><p>Operate more verbosely.</p>
 222 </dd></dl>
 223
 224 <dl class="option">
 225 <dt id="cmdoption-memflush-debug">
 226 <code class="descname">--debug</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-memflush-debug" title="Permalink to this definition">¶</a></dt>
 227 <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>
 228 </dd></dl>
 229
 230 <dl class="option">
 231 <dt id="cmdoption-memflush-servers">
 232 <code class="descname">--servers</code><code class="descclassname"> &lt;list of servers&gt;</code><a class="headerlink" href="#cmdoption-memflush-servers" title="Permalink to this definition">¶</a></dt>
 233 <dd><p>Specify the list of servers as <em>hostname[:port][,hostname[:port]...]</em>.</p>
 234 </dd></dl>
 235
 236 <dl class="option">
 237 <dt id="cmdoption-memflush-binary">
 238 <code class="descname">--binary</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-memflush-binary" title="Permalink to this definition">¶</a></dt>
 239 <dd><p>Enable binary protocol.</p>
 240 </dd></dl>
 241
 242 <dl class="option">
 243 <dt id="cmdoption-memflush-username">
 244 <code class="descname">--username</code><code class="descclassname"> &lt;username&gt;</code><a class="headerlink" href="#cmdoption-memflush-username" title="Permalink to this definition">¶</a></dt>
 245 <dd><p>Use <em>username</em> for SASL authentication.</p>
 246 </dd></dl>
 247
 248 <dl class="option">
 249 <dt id="cmdoption-memflush-password">
 250 <code class="descname">--password</code><code class="descclassname"> &lt;password&gt;</code><a class="headerlink" href="#cmdoption-memflush-password" title="Permalink to this definition">¶</a></dt>
 251 <dd><p>Use <em>password</em> for SASL authentication.</p>
 252 </dd></dl>
 253
 254 <dl class="option">
 255 <dt id="cmdoption-memflush-expire">
 256 <code class="descname">--expire</code><code class="descclassname"> &lt;expiration&gt;</code><a class="headerlink" href="#cmdoption-memflush-expire" title="Permalink to this definition">¶</a></dt>
 257 <dd><p>Use <em>expiration</em> seconds (or a UNIX timestamp).</p>
 258 </dd></dl>
 259
 260 <div class="admonition note">
 261 <p class="first admonition-title">Note</p>
 262 <p>Using an expiration time (period), all keys, which have not bean updated until expiration will cease to exist.</p>
 263 <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>
 264 <blockquote class="last">
 265 <div><p>Its effect is to invalidate all
 266 existing items immediately (by default) or after the expiration
 267 specified.  After invalidation none of the items will be returned in
 268 response to a retrieval command (unless it's stored again under the
 269 same key <em>after</em> flush_all has invalidated the items).</p>
 270 <p>The most precise
 271 definition of what flush_all does is the following: it causes all
 272 items whose update time is earlier than the time at which flush_all
 273 was set to be executed to be ignored for retrieval purposes.</p>
 274 <p>The intent of flush_all with a delay, was that in a setting where you
 275 have a pool of memcached servers, and you need to flush all content,
 276 you have the option of not resetting all memcached servers at the
 277 same time (which could e.g. cause a spike in database load with all
 278 clients suddenly needing to recreate content that would otherwise
 279 have been found in the memcached daemon).</p>
 280 </div></blockquote>
 281 </div>
 282 </div>
 283 <div class="section" id="environment">
 284 <h2>ENVIRONMENT<a class="headerlink" href="#environment" title="Permalink to this headline">¶</a></h2>
 285 <dl class="envvar">
 286 <dt id="envvar-MEMCACHED_SERVERS">
 287 <code class="descname">MEMCACHED_SERVERS</code><a class="headerlink" href="#envvar-MEMCACHED_SERVERS" title="Permalink to this definition">¶</a></dt>
 288 <dd><p>Specify the list of servers.</p>
 289 </dd></dl>
 290
 291 </div>
 292 <div class="section" id="see-also">
 293 <h2>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
 294 <ul class="simple">
 295 <li><a class="reference internal" href="../libmemcached.html"><span class="doc">C/C++ Client Library for memcached</span></a></li>
 296 <li><a class="reference internal" href="../libmemcached/memcached_flush.html"><span class="doc">Wiping clean the contents of a server</span></a></li>
 297 </ul>
 298 </div>
 299 </div>
 300
 301
 302            </div>
 303
 304           </div>
 305           <footer>
 306
 307     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 308
 309         <a href="../libmemcached/index_misc.html" class="btn btn-neutral float-right" title="Miscellaneous" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
 310
 311
 312         <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>
 313
 314     </div>
 315
 316
 317   <hr/>
 318
 319   <div role="contentinfo">
 320     <p>
 321         &copy; <a href="../copyright.html">Copyright</a>
 322
 323     </p>
 324   </div>
 325   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>.
 326
 327 </footer>
 328
 329         </div>
 330       </div>
 331
 332     </section>
 333
 334   </div>
 335
 336
 337
 338   <script type="text/javascript">
 339       jQuery(function () {
 340           SphinxRtdTheme.Navigation.enable(true);
 341       });
 342   </script>
 343
 344
 345
 346
 347
 348
 349 </body>
 350 </html>