git.m6w6.name Git - m6w6/libmemcached/blob - libmemcached/memcached_delete.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>Deleting data from a server &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="Disconnecting a client from a server" href="memcached_quit.html" />
  40     <link rel="prev" title="Storing data on the server" href="memcached_set.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 class="current">
  90 <li class="toctree-l1"><a class="reference internal" href="../libmemcached.html">Introduction</a></li>
  91 <li class="toctree-l1 current"><a class="reference internal" href="index.html">libmemcached API</a><ul class="current">
  92 <li class="toctree-l2 current"><a class="reference internal" href="index_basics.html">Basics</a></li>
  93 <li class="toctree-l2"><a class="reference internal" href="index_data.html">Working with Data</a></li>
  94 <li class="toctree-l2"><a class="reference internal" href="index_errors.html">Messages and Errors</a></li>
  95 <li class="toctree-l2"><a class="reference internal" href="index_advanced.html">Advanced Topics</a></li>
  96 <li class="toctree-l2"><a class="reference internal" href="index_deprecated.html">Deprecated Functionality</a></li>
  97 </ul>
  98 </li>
  99 <li class="toctree-l1"><a class="reference internal" href="index_misc.html">Misc</a><ul>
 100 <li class="toctree-l2"><a class="reference internal" href="configuration.html">Configuration</a></li>
 101 <li class="toctree-l2"><a class="reference internal" href="constants.html">Constants</a></li>
 102 <li class="toctree-l2"><a class="reference internal" href="examples.html">Examples</a></li>
 103 <li class="toctree-l2"><a class="reference internal" href="versioning.html">Versioning</a></li>
 104 </ul>
 105 </li>
 106 </ul>
 107 <p class="caption"><span class="caption-text">libmemcachedutil</span></p>
 108 <ul>
 109 <li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil.html">Introduction</a></li>
 110 <li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil/index.html">libmemcachedutil API</a><ul>
 111 <li class="toctree-l2"><a class="reference internal" href="../libmemcachedutil/memcached_pool.html">Working with memcached pools</a></li>
 112 </ul>
 113 </li>
 114 </ul>
 115 <p class="caption"><span class="caption-text">libhashkit</span></p>
 116 <ul>
 117 <li class="toctree-l1"><a class="reference internal" href="../libhashkit.html">Introduction</a></li>
 118 <li class="toctree-l1"><a class="reference internal" href="../libhashkit/index.html">libhashkit API</a><ul>
 119 <li class="toctree-l2"><a class="reference internal" href="../libhashkit/hashkit_create.html">Creating a hashkit structure</a></li>
 120 <li class="toctree-l2"><a class="reference internal" href="../libhashkit/hashkit_function.html">Set Hash Function</a></li>
 121 <li class="toctree-l2"><a class="reference internal" href="../libhashkit/hashkit_functions.html">Available Hashes</a></li>
 122 <li class="toctree-l2"><a class="reference internal" href="../libhashkit/hashkit_value.html">Generate hash value</a></li>
 123 </ul>
 124 </li>
 125 </ul>
 126 <p class="caption"><span class="caption-text">Client Applications</span></p>
 127 <ul>
 128 <li class="toctree-l1"><a class="reference internal" href="../bin/index.html">Client Applications</a><ul>
 129 <li class="toctree-l2"><a class="reference internal" href="../bin/memcapable.html">memcapable - Checking a Memcached server capabilities and compatibility</a></li>
 130 <li class="toctree-l2"><a class="reference internal" href="../bin/memcat.html">memcat - “cat” data from a server</a></li>
 131 <li class="toctree-l2"><a class="reference internal" href="../bin/memcp.html">memcp - Copy data to a server</a></li>
 132 <li class="toctree-l2"><a class="reference internal" href="../bin/memdump.html">memdump - Dumping your server</a></li>
 133 <li class="toctree-l2"><a class="reference internal" href="../bin/memerror.html">memerror - translate an error code to a string</a></li>
 134 <li class="toctree-l2"><a class="reference internal" href="../bin/memflush.html">memflush - flush all data from a server</a></li>
 135 <li class="toctree-l2"><a class="reference internal" href="../bin/memrm.html">memrm - Remove data from a server</a></li>
 136 <li class="toctree-l2"><a class="reference internal" href="../bin/memslap.html">memslap - Load testing  and benchmarking a server</a></li>
 137 <li class="toctree-l2"><a class="reference internal" href="../bin/memaslap.html">memaslap - Load testing  and benchmarking a server</a></li>
 138 <li class="toctree-l2"><a class="reference internal" href="../bin/memstat.html">memstat - Gather statistics from a server</a></li>
 139 <li class="toctree-l2"><a class="reference internal" href="../bin/memexist.html">memexist - Check for the existence of a key</a></li>
 140 <li class="toctree-l2"><a class="reference internal" href="../bin/memparse.html">memparse - Parse an option string</a></li>
 141 <li class="toctree-l2"><a class="reference internal" href="../bin/memping.html">memping - Test to see if a server is available.</a></li>
 142 <li class="toctree-l2"><a class="reference internal" href="../bin/memtouch.html">memtouch - Touches a key.</a></li>
 143 </ul>
 144 </li>
 145 </ul>
 146
 147
 148
 149         </div>
 150       </div>
 151     </nav>
 152
 153     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 154
 155
 156       <nav class="wy-nav-top" aria-label="top navigation">
 157
 158           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
 159           <a href="../index.html">libmemcached</a>
 160
 161       </nav>
 162
 163
 164       <div class="wy-nav-content">
 165
 166         <div class="rst-content">
 167
 168
 169
 170
 171
 172
 173
 174
 175
 176
 177
 178
 179
 180
 181
 182
 183
 184 <div role="navigation" aria-label="breadcrumbs navigation">
 185
 186   <ul class="wy-breadcrumbs">
 187
 188       <li><a href="../index.html">Docs</a> &raquo;</li>
 189
 190           <li><a href="index.html">libmemcached API</a> &raquo;</li>
 191
 192           <li><a href="index_basics.html">Basics</a> &raquo;</li>
 193
 194       <li>Deleting data from a server</li>
 195
 196
 197       <li class="wy-breadcrumbs-aside">
 198
 199
 200
 201       </li>
 202
 203   </ul>
 204
 205
 206   <hr/>
 207 </div>
 208           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
 209            <div itemprop="articleBody">
 210
 211   <div class="section" id="deleting-data-from-a-server">
 212 <h1>Deleting data from a server<a class="headerlink" href="#deleting-data-from-a-server" title="Permalink to this headline">¶</a></h1>
 213 <div class="section" id="synopsis">
 214 <span id="index-0"></span><h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
 215 <p>#include &lt;libmemcached/memcached.h&gt;</p>
 216 <dl class="function">
 217 <dt id="_CPPv416memcached_deleteP12memcached_stPKc6size_t6time_t">
 218 <span id="_CPPv316memcached_deleteP12memcached_stPKc6size_t6time_t"></span><span id="_CPPv216memcached_deleteP12memcached_stPKc6size_t6time_t"></span><span id="memcached_delete__memcached_stP.cCP.s.time_t"></span><a class="reference internal" href="memcached_return_t.html#_CPPv418memcached_return_t" title="memcached_return_t">memcached_return_t</a> <code class="sig-name descname">memcached_delete</code><span class="sig-paren">(</span><a class="reference internal" href="memcached_create.html#_CPPv412memcached_st" title="memcached_st">memcached_st</a> *<em>ptr</em>, <em class="property">const</em> char *<em>key</em>, size_t <em>key_length</em>, time_t <em>expiration</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv416memcached_deleteP12memcached_stPKc6size_t6time_t" title="Permalink to this definition">¶</a><br /></dt>
 219 <dd></dd></dl>
 220
 221 <dl class="function">
 222 <dt id="_CPPv423memcached_delete_by_keyP12memcached_stPKc6size_tPKc6size_t6time_t">
 223 <span id="_CPPv323memcached_delete_by_keyP12memcached_stPKc6size_tPKc6size_t6time_t"></span><span id="_CPPv223memcached_delete_by_keyP12memcached_stPKc6size_tPKc6size_t6time_t"></span><span id="memcached_delete_by_key__memcached_stP.cCP.s.cCP.s.time_t"></span><a class="reference internal" href="memcached_return_t.html#_CPPv418memcached_return_t" title="memcached_return_t">memcached_return_t</a> <code class="sig-name descname">memcached_delete_by_key</code><span class="sig-paren">(</span><a class="reference internal" href="memcached_create.html#_CPPv412memcached_st" title="memcached_st">memcached_st</a> *<em>ptr</em>, <em class="property">const</em> char *<em>group_key</em>, size_t <em>group_key_length</em>, <em class="property">const</em> char *<em>key</em>, size_t <em>key_length</em>, time_t <em>expiration</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv423memcached_delete_by_keyP12memcached_stPKc6size_tPKc6size_t6time_t" title="Permalink to this definition">¶</a><br /></dt>
 224 <dd></dd></dl>
 225
 226 <p>Compile and link with -lmemcached</p>
 227 </div>
 228 <div class="section" id="description">
 229 <h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
 230 <p><a class="reference internal" href="#_CPPv416memcached_deleteP12memcached_stPKc6size_t6time_t" title="memcached_delete"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_delete()</span></code></a> is used to delete a particular key.
 231 <a class="reference internal" href="#_CPPv423memcached_delete_by_keyP12memcached_stPKc6size_tPKc6size_t6time_t" title="memcached_delete_by_key"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_delete_by_key()</span></code></a> works the same, but it takes a master key
 232 to find the given value.</p>
 233 <p>Expiration works by placing the item into a delete queue, which means that
 234 it won’t be possible to retrieve it by the “get” command. The “add” and
 235 “replace” commands with this key will also fail (the “set” command will
 236 succeed, however). After the time passes, the item is finally deleted from server memory.</p>
 237 <p>Please note the the memcached server removed tests for expiration in
 238 the 1.4 version.</p>
 239 </div>
 240 <div class="section" id="return">
 241 <h2>RETURN<a class="headerlink" href="#return" title="Permalink to this headline">¶</a></h2>
 242 <p>A value of type <a class="reference internal" href="memcached_return_t.html#_CPPv418memcached_return_t" title="memcached_return_t"><code class="xref cpp cpp-type docutils literal notranslate"><span class="pre">memcached_return_t</span></code></a> is returned
 243 On success that value will be <a class="reference internal" href="memcached_return_t.html#_CPPv4N18memcached_return_t17MEMCACHED_SUCCESSE" title="MEMCACHED_SUCCESS"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_SUCCESS</span></code></a>.
 244 Use <a class="reference internal" href="memcached_strerror.html#_CPPv418memcached_strerrorP12memcached_st18memcached_return_t" title="memcached_strerror"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_strerror()</span></code></a> to translate this value to a printable
 245 string.</p>
 246 <p>If you are using the non-blocking mode of the library, success only
 247 means that the message was queued for delivery.</p>
 248 </div>
 249 <div class="section" id="see-also">
 250 <h2>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
 251 </div>
 252 </div>
 253
 254
 255            </div>
 256
 257           </div>
 258           <footer>
 259
 260     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 261
 262         <a href="memcached_quit.html" class="btn btn-neutral float-right" title="Disconnecting a client from a server" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
 263
 264
 265         <a href="memcached_set.html" class="btn btn-neutral float-left" title="Storing data on the server" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
 266
 267     </div>
 268
 269
 270   <hr/>
 271
 272   <div role="contentinfo">
 273     <p>
 274         &copy; <a href="../copyright.html">Copyright</a>
 275
 276     </p>
 277   </div>
 278   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>.
 279
 280 </footer>
 281
 282         </div>
 283       </div>
 284
 285     </section>
 286
 287   </div>
 288
 289
 290
 291   <script type="text/javascript">
 292       jQuery(function () {
 293           SphinxRtdTheme.Navigation.enable(true);
 294       });
 295   </script>
 296
 297
 298
 299
 300
 301
 302 </body>
 303 </html>