4 <html class=
"writer-html5" lang=
"en" >
8 <meta name=
"viewport" content=
"width=device-width, initial-scale=1.0">
10 <title>Dumping data from a server
— libmemcached
1.0.99 documentation
</title>
14 <link rel=
"stylesheet" href=
"../_static/css/theme.css" type=
"text/css" />
15 <link rel=
"stylesheet" href=
"../_static/pygments.css" type=
"text/css" />
24 <script src="../_static/js/html5shiv.min.js"></script>
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>
34 <script type=
"text/javascript" src=
"../_static/js/theme.js"></script>
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=
"Wiping clean the contents of a server" href=
"memcached_flush.html" />
41 <link rel=
"prev" title=
"Affecting the memcached Daemon" href=
"index_advanced_daemon.html" />
44 <body class=
"wy-body-for-nav">
47 <div class=
"wy-grid-for-nav">
49 <nav data-toggle=
"wy-nav-shift" class=
"wy-nav-side">
50 <div class=
"wy-side-scroll">
51 <div class=
"wy-side-nav-search" >
55 <a href=
"../index.html" class=
"icon icon-home" alt=
"Documentation Home"> libmemcached
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" />
83 <div class=
"wy-menu wy-menu-vertical" data-spy=
"affix" role=
"navigation" aria-label=
"main navigation">
90 <p class=
"caption"><span class=
"caption-text">libmemcached
</span></p>
92 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libmemcached.html">Introduction
</a></li>
93 <li class=
"toctree-l1 current"><a class=
"reference internal" href=
"index.html">libmemcached API
</a><ul class=
"current">
94 <li class=
"toctree-l2"><a class=
"reference internal" href=
"index_basics.html">Basics
</a></li>
95 <li class=
"toctree-l2"><a class=
"reference internal" href=
"index_data.html">Working with Data
</a></li>
96 <li class=
"toctree-l2"><a class=
"reference internal" href=
"index_errors.html">Messages and Errors
</a></li>
97 <li class=
"toctree-l2 current"><a class=
"reference internal" href=
"index_advanced.html">Advanced Topics
</a><ul class=
"current">
98 <li class=
"toctree-l3"><a class=
"reference internal" href=
"index_advanced_internals.html">Internal Behavior
</a></li>
99 <li class=
"toctree-l3"><a class=
"reference internal" href=
"index_advanced_aeh.html">Authentication, Encryption
& Hashing
</a></li>
100 <li class=
"toctree-l3"><a class=
"reference internal" href=
"index_advanced_servers.html">Servers and Server Lists
</a></li>
101 <li class=
"toctree-l3 current"><a class=
"reference internal" href=
"index_advanced_daemon.html">Affecting the memcached Daemon
</a><ul class=
"current">
102 <li class=
"toctree-l4 current"><a class=
"current reference internal" href=
"#">Dumping data from a server
</a></li>
103 <li class=
"toctree-l4"><a class=
"reference internal" href=
"memcached_flush.html">Wiping clean the contents of a server
</a></li>
104 <li class=
"toctree-l4"><a class=
"reference internal" href=
"memcached_verbosity.html">Setting the verbosity of a server
</a></li>
105 <li class=
"toctree-l4"><a class=
"reference internal" href=
"memcached_version.html">Getting version information about the client and server
</a></li>
108 <li class=
"toctree-l3"><a class=
"reference internal" href=
"index_advanced_stats.html">Statistics
</a></li>
111 <li class=
"toctree-l2"><a class=
"reference internal" href=
"index_deprecated.html">Deprecated Functionality
</a></li>
114 <li class=
"toctree-l1"><a class=
"reference internal" href=
"index_misc.html">Misc
</a></li>
116 <p class=
"caption"><span class=
"caption-text">libmemcachedutil
</span></p>
118 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libmemcachedutil.html">Introduction
</a></li>
119 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libmemcachedutil/index.html">libmemcachedutil API
</a></li>
121 <p class=
"caption"><span class=
"caption-text">libhashkit
</span></p>
123 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libhashkit.html">Introduction
</a></li>
124 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libhashkit/index.html">libhashkit API
</a></li>
126 <p class=
"caption"><span class=
"caption-text">Client Applications
</span></p>
128 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../bin/index.html">Client Applications
</a></li>
130 <p class=
"caption"><span class=
"caption-text">Copyright
</span></p>
132 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../copyright.html">Copyright
</a></li>
142 <section data-toggle=
"wy-nav-shift" class=
"wy-nav-content-wrap">
145 <nav class=
"wy-nav-top" aria-label=
"top navigation">
147 <i data-toggle=
"wy-nav-top" class=
"fa fa-bars"></i>
148 <a href=
"../index.html">libmemcached
</a>
153 <div class=
"wy-nav-content">
155 <div class=
"rst-content">
173 <div role=
"navigation" aria-label=
"breadcrumbs navigation">
175 <ul class=
"wy-breadcrumbs">
177 <li><a href=
"../index.html" class=
"icon icon-home"></a> »</li>
179 <li><a href=
"index.html">libmemcached API
</a> »</li>
181 <li><a href=
"index_advanced.html">Advanced Topics
</a> »</li>
183 <li><a href=
"index_advanced_daemon.html">Affecting the memcached Daemon
</a> »</li>
185 <li>Dumping data from a server
</li>
188 <li class=
"wy-breadcrumbs-aside">
199 <div role=
"main" class=
"document" itemscope=
"itemscope" itemtype=
"http://schema.org/Article">
200 <div itemprop=
"articleBody">
202 <div class=
"section" id=
"dumping-data-from-a-server">
203 <h1>Dumping data from a server
<a class=
"headerlink" href=
"#dumping-data-from-a-server" title=
"Permalink to this headline">¶
</a></h1>
204 <div class=
"section" id=
"synopsis">
205 <h2>SYNOPSIS
<a class=
"headerlink" href=
"#synopsis" title=
"Permalink to this headline">¶
</a></h2>
207 <dt>#include
<libmemcached/memcached.h
></dt><dd><p>Compile and link with -lmemcached
</p>
210 <dl class=
"cpp type">
211 <dt id=
"_CPPv417memcached_dump_fn">
212 <span id=
"_CPPv317memcached_dump_fn"></span><span id=
"_CPPv217memcached_dump_fn"></span><span id=
"memcached_dump_fn"></span><em class=
"property">typedef
</em><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_dump_fn
</code>)
<span class=
"sig-paren">(
</span><a class=
"reference internal" href=
"memcached_create.html#_CPPv412memcached_st" title=
"memcached_st">memcached_st
</a> *ptr,
<em class=
"property">const
</em> char *key, size_t key_length, void *context
<span class=
"sig-paren">)
</span><a class=
"headerlink" href=
"#_CPPv417memcached_dump_fn" title=
"Permalink to this definition">¶
</a><br /></dt>
213 <dd><dl class=
"field-list simple">
214 <dt class=
"field-odd">Parameters
</dt>
215 <dd class=
"field-odd"><ul class=
"simple">
216 <li><p><strong>ptr
</strong> -- pointer to
<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> object
</p></li>
217 <li><p><strong>key
</strong> -- key string being dumped
</p></li>
218 <li><p><strong>key_length
</strong> -- length of the key without any terminating zero
</p></li>
219 <li><p><strong>context
</strong> -- pointer to the user supplied context
</p></li>
222 <dt class=
"field-even">Returns
</dt>
223 <dd class=
"field-even"><p><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>
228 <dl class=
"cpp function">
229 <dt id=
"_CPPv414memcached_dumpP12memcached_stP17memcached_dump_fnPv8uint32_t">
230 <span id=
"_CPPv314memcached_dumpP12memcached_stP17memcached_dump_fnPv8uint32_t"></span><span id=
"_CPPv214memcached_dumpP12memcached_stP17memcached_dump_fnPv8uint32_t"></span><span id=
"memcached_dump__memcached_stP.memcached_dump_fnP.voidP.uint32_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_dump
</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>,
<a class=
"reference internal" href=
"#_CPPv417memcached_dump_fn" title=
"memcached_dump_fn">memcached_dump_fn
</a> *
<em>function
</em>, void *
<em>context
</em>, uint32_t
<em>number_of_callbacks
</em><span class=
"sig-paren">)
</span><a class=
"headerlink" href=
"#_CPPv414memcached_dumpP12memcached_stP17memcached_dump_fnPv8uint32_t" title=
"Permalink to this definition">¶
</a><br /></dt>
231 <dd><dl class=
"field-list simple">
232 <dt class=
"field-odd">Parameters
</dt>
233 <dd class=
"field-odd"><ul class=
"simple">
234 <li><p><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
</p></li>
235 <li><p><strong>function
</strong> -- pointer to
<a class=
"reference internal" href=
"#_CPPv414memcached_dumpP12memcached_stP17memcached_dump_fnPv8uint32_t" title=
"memcached_dump::number_of_callbacks"><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">number_of_callbacks
</span></code></a> <a class=
"reference internal" href=
"#_CPPv417memcached_dump_fn" title=
"memcached_dump_fn"><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">memcached_dump_fn
</span></code></a> callbacks
</p></li>
236 <li><p><strong>context
</strong> -- pointer to a user managed context
</p></li>
237 <li><p><strong>number_of_callbacks
</strong> -- number of callbacks in the
<a class=
"reference internal" href=
"#_CPPv414memcached_dumpP12memcached_stP17memcached_dump_fnPv8uint32_t" title=
"memcached_dump::function"><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">function
</span></code></a> array
</p></li>
240 <dt class=
"field-even">Returns
</dt>
241 <dd class=
"field-even"><p><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>
247 <div class=
"section" id=
"description">
248 <h2>DESCRIPTION
<a class=
"headerlink" href=
"#description" title=
"Permalink to this headline">¶
</a></h2>
249 <p><a class=
"reference internal" href=
"#_CPPv414memcached_dumpP12memcached_stP17memcached_dump_fnPv8uint32_t" title=
"memcached_dump"><code class=
"xref cpp cpp-func docutils literal notranslate"><span class=
"pre">memcached_dump()
</span></code></a> is used to get a list of keys found in
<em class=
"manpage"><a class=
"manpage reference external" href=
"https://linux.die.net/man/1/memcached">memcached(
1)
</a></em>
250 servers. Because memcached does not guarantee to dump all keys you can not
251 assume you have fetched all keys from the server. The function takes an array
252 of callbacks that it will use to execute on keys as they are found.
</p>
253 <p>Currently the binary protocol is not tested.
</p>
255 <div class=
"section" id=
"return-value">
256 <h2>RETURN VALUE
<a class=
"headerlink" href=
"#return-value" title=
"Permalink to this headline">¶
</a></h2>
257 <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.
258 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>.
259 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
262 <div class=
"section" id=
"see-also">
263 <h2>SEE ALSO
<a class=
"headerlink" href=
"#see-also" title=
"Permalink to this headline">¶
</a></h2>
265 <li><p><a class=
"reference internal" href=
"../libmemcached.html"><span class=
"doc">C/C++ Client Library for memcached
</span></a></p></li>
266 <li><p><a class=
"reference internal" href=
"memcached_strerror.html"><span class=
"doc">Converting Error Codes to Messages
</span></a></p></li>
277 <div class=
"rst-footer-buttons" role=
"navigation" aria-label=
"footer navigation">
279 <a href=
"memcached_flush.html" class=
"btn btn-neutral float-right" title=
"Wiping clean the contents of a server" accesskey=
"n" rel=
"next">Next
<span class=
"fa fa-arrow-circle-right"></span></a>
282 <a href=
"index_advanced_daemon.html" class=
"btn btn-neutral float-left" title=
"Affecting the memcached Daemon" accesskey=
"p" rel=
"prev"><span class=
"fa fa-arrow-circle-left"></span> Previous
</a>
289 <div role=
"contentinfo">
293 © <a href=
"../copyright.html">Copyright
</a>
300 Built with
<a href=
"http://sphinx-doc.org/">Sphinx
</a> using a
302 <a href=
"https://github.com/rtfd/sphinx_rtd_theme">theme
</a>
304 provided by
<a href=
"https://readthedocs.org">Read the Docs
</a>.
316 <script type=
"text/javascript">
318 SphinxRtdTheme.Navigation.enable(true);