Deploy to GitHub pages
[awesomized/libmemcached] / 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.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="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.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 current"><a class="reference internal" href="index.html">libmemcached API</a><ul class="current">
91 <li class="toctree-l2 current"><a class="reference internal" href="index_basics.html">Basics</a><ul class="current">
92 <li class="toctree-l3"><a class="reference internal" href="memcached_create.html">Creating and destroying a memcached_st</a></li>
93 <li class="toctree-l3"><a class="reference internal" href="memcached_get.html">Retrieving data from the server</a></li>
94 <li class="toctree-l3"><a class="reference internal" href="memcached_set.html">Storing data on the server</a></li>
95 <li class="toctree-l3 current"><a class="current reference internal" href="#">Deleting data from a server</a></li>
96 <li class="toctree-l3"><a class="reference internal" href="memcached_quit.html">Disconnecting a client from a server</a></li>
97 </ul>
98 </li>
99 <li class="toctree-l2"><a class="reference internal" href="index_data.html">Working with Data</a></li>
100 <li class="toctree-l2"><a class="reference internal" href="index_errors.html">Messages and Errors</a></li>
101 <li class="toctree-l2"><a class="reference internal" href="index_advanced.html">Advanced Topics</a></li>
102 <li class="toctree-l2"><a class="reference internal" href="index_deprecated.html">Deprecated Functionality</a></li>
103 </ul>
104 </li>
105 <li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil/index.html">libmemcachedutil API</a></li>
106 <li class="toctree-l1"><a class="reference internal" href="../libhashkit/index.html">libhashkit API</a></li>
107 <li class="toctree-l1"><a class="reference internal" href="../bin/index.html">Client Applications</a></li>
108 <li class="toctree-l1"><a class="reference internal" href="index_misc.html">Miscellaneous</a></li>
109 </ul>
110 <ul>
111 <li class="toctree-l1"><a class="reference internal" href="../changelogs.html">Change Logs</a></li>
112 <li class="toctree-l1"><a class="reference internal" href="../copyright.html">Copyright</a></li>
113 </ul>
114
115
116
117 </div>
118 </div>
119 </nav>
120
121 <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
122
123
124 <nav class="wy-nav-top" aria-label="top navigation">
125
126 <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
127 <a href="../index.html">libmemcached</a>
128
129 </nav>
130
131
132 <div class="wy-nav-content">
133
134 <div class="rst-content">
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152 <div role="navigation" aria-label="breadcrumbs navigation">
153
154 <ul class="wy-breadcrumbs">
155
156 <li><a href="../index.html">Docs</a> &raquo;</li>
157
158 <li><a href="index.html">libmemcached API</a> &raquo;</li>
159
160 <li><a href="index_basics.html">Basics</a> &raquo;</li>
161
162 <li>Deleting data from a server</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/libmemcached/memcached_delete.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="deleting-data-from-a-server">
184 <h1>Deleting data from a server<a class="headerlink" href="#deleting-data-from-a-server" 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 <dl class="docutils">
188 <dt>#include &lt;libmemcached/memcached.h&gt;</dt>
189 <dd>Compile and link with -lmemcached</dd>
190 </dl>
191 <dl class="function">
192 <dt id="_CPPv416memcached_deleteP12memcached_stPKc6size_t6time_t">
193 <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="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>
194 <dd></dd></dl>
195
196 <dl class="function">
197 <dt id="_CPPv423memcached_delete_by_keyP12memcached_stPKc6size_tPKc6size_t6time_t">
198 <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="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>
199 <dd><table class="docutils field-list" frame="void" rules="none">
200 <col class="field-name" />
201 <col class="field-body" />
202 <tbody valign="top">
203 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
204 <li><strong>ptr</strong> -- pointer to initialized <a class="reference internal" href="memcached_create.html#_CPPv412memcached_st" title="memcached_st"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_st</span></code></a> struct</li>
205 <li><strong>group_key</strong> -- key namespace</li>
206 <li><strong>group_key_length</strong> -- length of the <a class="reference internal" href="#_CPPv423memcached_delete_by_keyP12memcached_stPKc6size_tPKc6size_t6time_t" title="memcached_delete_by_key::group_key"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">group_key</span></code></a> without any terminating zero</li>
207 <li><strong>key</strong> -- the key to delete</li>
208 <li><strong>key_length</strong> -- the length og the <a class="reference internal" href="#_CPPv423memcached_delete_by_keyP12memcached_stPKc6size_tPKc6size_t6time_t" title="memcached_delete_by_key::key"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">key</span></code></a> without any terminating zero</li>
209 <li><strong>expiration</strong> -- obsolete since <em class="manpage"><a class="manpage reference external" href="https://linux.die.net/man/1/memcached">memcached(1)</a></em> version 1.4</li>
210 </ul>
211 </td>
212 </tr>
213 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><a class="reference internal" href="memcached_return_t.html#_CPPv418memcached_return_t" title="memcached_return_t"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_return_t</span></code></a> indicating success</p>
214 </td>
215 </tr>
216 </tbody>
217 </table>
218 </dd></dl>
219
220 </div>
221 <div class="section" id="description">
222 <h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
223 <p><a class="reference internal" href="#_CPPv416memcached_deleteP12memcached_stPKc6size_t6time_t" title="memcached_delete"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_delete()</span></code></a> is used to delete a particular key. <a class="reference internal" href="#_CPPv423memcached_delete_by_keyP12memcached_stPKc6size_tPKc6size_t6time_t" title="memcached_delete_by_key"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_delete_by_key()</span></code></a>
224 works the same, but it takes a master key to find the given value.</p>
225 <p>Expiration works by placing the item into a delete queue, which means that it
226 won't be possible to retrieve it by the &quot;get&quot; command. The &quot;add&quot; and &quot;replace&quot;
227 commands with this key will also fail (the &quot;set&quot; command will succeed, however).
228 After the time passes, the item is finally deleted from server memory.</p>
229 <p>Please note the the memcached server removed tests for expiration in the 1.4
230 version.</p>
231 </div>
232 <div class="section" id="return-value">
233 <h2>RETURN VALUE<a class="headerlink" href="#return-value" title="Permalink to this headline"></a></h2>
234 <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-any docutils literal notranslate"><span class="pre">memcached_return_t</span></code></a> is returned
235 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>.
236 Use <a class="reference internal" href="memcached_strerror.html#_CPPv418memcached_strerrorP12memcached_st18memcached_return_t" title="memcached_strerror"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_strerror()</span></code></a> to translate this value to a printable string.</p>
237 <p>If you are using the non-blocking mode of the library, success only means that
238 the message was queued for delivery.</p>
239 </div>
240 <div class="section" id="see-also">
241 <h2>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline"></a></h2>
242 <ul class="simple">
243 <li><em class="manpage"><a class="manpage reference external" href="https://linux.die.net/man/1/memcached">memcached(1)</a></em></li>
244 <li><a class="reference internal" href="../libmemcached.html"><span class="doc">C/C++ Client Library for memcached</span></a></li>
245 <li><a class="reference internal" href="memcached_strerror.html"><span class="doc">Converting Error Codes to Messages</span></a></li>
246 </ul>
247 </div>
248 </div>
249
250
251 </div>
252
253 </div>
254 <footer>
255
256 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
257
258 <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>
259
260
261 <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>
262
263 </div>
264
265
266 <hr/>
267
268 <div role="contentinfo">
269 <p>
270 &copy; <a href="../copyright.html">Copyright</a>
271
272 </p>
273 </div>
274 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>.
275
276 </footer>
277
278 </div>
279 </div>
280
281 </section>
282
283 </div>
284
285
286
287 <script type="text/javascript">
288 jQuery(function () {
289 SphinxRtdTheme.Navigation.enable(true);
290 });
291 </script>
292
293
294
295
296
297
298 </body>
299 </html>