git.m6w6.name Git - awesomized/libmemcached/blob - docs/source/libmemcached/memcached_dump.rst

   1 ==========================
   2 Dumping data from a server
   3 ==========================
   4
   5 Get a list of keys found on memcached servers
   6
   7 .. index:: object: memcached_st
   8
   9 --------
  10 SYNOPSIS
  11 --------
  12
  13 #include <libmemcached/memcached.h>
  14
  15 .. function:: memcached_return_t memcached_dump (memcached_st *ptr, memcached_dump_fn *function, void *context, uint32_t number_of_callbacks)
  16
  17 .. type:: memcached_return_t (*memcached_dump_fn)(memcached_st *ptr,  const char *key, size_t key_length, void *context)
  18
  19 Compile and link with -lmemcached
  20
  21 -----------
  22 DESCRIPTION
  23 -----------
  24
  25 :func:`memcached_dump` is used to get a list of keys found in memcached(1)
  26 servers. Because memcached(1) does not guarantee to dump all keys you can not
  27 assume you have fetched all keys from the server. The function takes an array
  28 of callbacks that it will use to execute on keys as they are found.
  29
  30 Currently the binary protocol is not tested.
  31
  32 RETURN
  33 ------
  34
  35 A value of type :type:`memcached_return_t` is returned
  36 On success that value will be `MEMCACHED_SUCCESS`.
  37 Use :func:`memcached_strerror` to translate this value to a printable
  38 string.
  39
  40 --------
  41 SEE ALSO
  42 --------
  43
  44 .. only:: man
  45
  46   :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`