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

   1 Deleting data from a server
   2 ===========================
   3
   4 .. index:: object: memcached_st
   5
   6 SYNOPSIS
   7 --------
   8
   9 #include <libmemcached/memcached.h>
  10
  11 .. function:: memcached_return_t memcached_delete (memcached_st *ptr, const char *key, size_t key_length, time_t expiration)
  12
  13 .. function:: memcached_return_t memcached_delete_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, time_t expiration)
  14
  15 Compile and link with -lmemcached
  16
  17 DESCRIPTION
  18 -----------
  19
  20 :func:`memcached_delete` is used to delete a particular key.
  21 :func:`memcached_delete_by_key` works the same, but it takes a master key
  22 to find the given value.
  23
  24 Expiration works by placing the item into a delete queue, which means that
  25 it won't be possible to retrieve it by the "get" command. The "add" and
  26 "replace" commands with this key will also fail (the "set" command will
  27 succeed, however). After the time passes, the item is finally deleted from server memory.
  28
  29 Please note the the memcached server removed tests for expiration in
  30 the 1.4 version.
  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 If you are using the non-blocking mode of the library, success only
  41 means that the message was queued for delivery.
  42
  43 SEE ALSO
  44 --------
  45
  46 .. only:: man
  47
  48   :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`