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]-->
9 <meta name=
"viewport" content=
"width=device-width, initial-scale=1.0">
11 <title>Deleting data from a server
— libmemcached
1.0.99 documentation
</title>
20 <script type=
"text/javascript" src=
"../_static/js/modernizr.min.js"></script>
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>
29 <script type=
"text/javascript" src=
"../_static/js/theme.js"></script>
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" />
43 <body class=
"wy-body-for-nav">
46 <div class=
"wy-grid-for-nav">
48 <nav data-toggle=
"wy-nav-shift" class=
"wy-nav-side">
49 <div class=
"wy-side-scroll">
50 <div class=
"wy-side-nav-search" >
54 <a href=
"../index.html" class=
"icon icon-home"> libmemcached
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" />
81 <div class=
"wy-menu wy-menu-vertical" data-spy=
"affix" role=
"navigation" aria-label=
"main navigation">
88 <p class=
"caption"><span class=
"caption-text">libmemcached
</span></p>
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><ul class=
"current">
93 <li class=
"toctree-l3"><a class=
"reference internal" href=
"memcached_create.html">Creating and destroying a memcached_st
</a></li>
94 <li class=
"toctree-l3"><a class=
"reference internal" href=
"memcached_get.html">Retrieving data from the server
</a></li>
95 <li class=
"toctree-l3"><a class=
"reference internal" href=
"memcached_set.html">Storing data on the server
</a></li>
96 <li class=
"toctree-l3 current"><a class=
"current reference internal" href=
"#">Deleting data from a server
</a></li>
97 <li class=
"toctree-l3"><a class=
"reference internal" href=
"memcached_quit.html">Disconnecting a client from a server
</a></li>
100 <li class=
"toctree-l2"><a class=
"reference internal" href=
"index_data.html">Working with Data
</a></li>
101 <li class=
"toctree-l2"><a class=
"reference internal" href=
"index_errors.html">Messages and Errors
</a></li>
102 <li class=
"toctree-l2"><a class=
"reference internal" href=
"index_advanced.html">Advanced Topics
</a></li>
103 <li class=
"toctree-l2"><a class=
"reference internal" href=
"index_deprecated.html">Deprecated Functionality
</a></li>
106 <li class=
"toctree-l1"><a class=
"reference internal" href=
"index_misc.html">Misc
</a></li>
108 <p class=
"caption"><span class=
"caption-text">libmemcachedutil
</span></p>
110 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libmemcachedutil.html">Introduction
</a></li>
111 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libmemcachedutil/index.html">libmemcachedutil API
</a></li>
113 <p class=
"caption"><span class=
"caption-text">libhashkit
</span></p>
115 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libhashkit.html">Introduction
</a></li>
116 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libhashkit/index.html">libhashkit API
</a></li>
118 <p class=
"caption"><span class=
"caption-text">Client Applications
</span></p>
120 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../bin/index.html">Client Applications
</a></li>
122 <p class=
"caption"><span class=
"caption-text">Copyright
</span></p>
124 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../copyright.html">Copyright
</a></li>
133 <section data-toggle=
"wy-nav-shift" class=
"wy-nav-content-wrap">
136 <nav class=
"wy-nav-top" aria-label=
"top navigation">
138 <i data-toggle=
"wy-nav-top" class=
"fa fa-bars"></i>
139 <a href=
"../index.html">libmemcached
</a>
144 <div class=
"wy-nav-content">
146 <div class=
"rst-content">
164 <div role=
"navigation" aria-label=
"breadcrumbs navigation">
166 <ul class=
"wy-breadcrumbs">
168 <li><a href=
"../index.html">Docs
</a> »</li>
170 <li><a href=
"index.html">libmemcached API
</a> »</li>
172 <li><a href=
"index_basics.html">Basics
</a> »</li>
174 <li>Deleting data from a server
</li>
177 <li class=
"wy-breadcrumbs-aside">
188 <div role=
"main" class=
"document" itemscope=
"itemscope" itemtype=
"http://schema.org/Article">
189 <div itemprop=
"articleBody">
191 <div class=
"section" id=
"deleting-data-from-a-server">
192 <h1>Deleting data from a server
<a class=
"headerlink" href=
"#deleting-data-from-a-server" title=
"Permalink to this headline">¶
</a></h1>
193 <div class=
"section" id=
"synopsis">
194 <span id=
"index-0"></span><h2>SYNOPSIS
<a class=
"headerlink" href=
"#synopsis" title=
"Permalink to this headline">¶
</a></h2>
195 <p>#include
<libmemcached/memcached.h
></p>
196 <dl class=
"function">
197 <dt id=
"_CPPv416memcached_deleteP12memcached_stPKc6size_t6time_t">
198 <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>
201 <dl class=
"function">
202 <dt id=
"_CPPv423memcached_delete_by_keyP12memcached_stPKc6size_tPKc6size_t6time_t">
203 <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>
206 <p>Compile and link with -lmemcached
</p>
208 <div class=
"section" id=
"description">
209 <h2>DESCRIPTION
<a class=
"headerlink" href=
"#description" title=
"Permalink to this headline">¶
</a></h2>
210 <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.
211 <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
212 to find the given value.
</p>
213 <p>Expiration works by placing the item into a delete queue, which means that
214 it won’t be possible to retrieve it by the “get” command. The “add” and
215 “replace” commands with this key will also fail (the “set” command will
216 succeed, however). After the time passes, the item is finally deleted from server memory.
</p>
217 <p>Please note the the memcached server removed tests for expiration in
220 <div class=
"section" id=
"return">
221 <h2>RETURN
<a class=
"headerlink" href=
"#return" title=
"Permalink to this headline">¶
</a></h2>
222 <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
223 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>.
224 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
226 <p>If you are using the non-blocking mode of the library, success only
227 means that the message was queued for delivery.
</p>
229 <div class=
"section" id=
"see-also">
230 <h2>SEE ALSO
<a class=
"headerlink" href=
"#see-also" title=
"Permalink to this headline">¶
</a></h2>
240 <div class=
"rst-footer-buttons" role=
"navigation" aria-label=
"footer navigation">
242 <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>
245 <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>
252 <div role=
"contentinfo">
254 © <a href=
"../copyright.html">Copyright
</a>
258 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>.
271 <script type=
"text/javascript">
273 SphinxRtdTheme.Navigation.enable(true);