diff options
Diffstat (limited to 'docs/source/memcached_delete.rst')
| -rw-r--r-- | docs/source/memcached_delete.rst | 73 |
1 files changed, 73 insertions, 0 deletions
diff --git a/docs/source/memcached_delete.rst b/docs/source/memcached_delete.rst new file mode 100644 index 00000000..1c4f2661 --- /dev/null +++ b/docs/source/memcached_delete.rst @@ -0,0 +1,73 @@ +=========================== +Deleting data from a server +=========================== + +.. index:: object: memcached_st + +-------- +SYNOPSIS +-------- + + +#include <libmemcached/memcached.h> + +.. c:function:: memcached_return_t memcached_delete (memcached_st *ptr, const char *key, size_t key_length, time_t expiration) + +.. c: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) + +Compile and link with -lmemcached + +----------- +DESCRIPTION +----------- + + +:c:func:`memcached_delete` is used to delete a particular key. +:c:func:`memcached_delete_by_key` works the same, but it takes a master key +to find the given value. + +Expiration works by placing the item into a delete queue, which means that +it won't be possible to retrieve it by the "get" command. The "add" and +"replace" commands with this key will also fail (the "set" command will +succeed, however). After the time passes, the item is finally deleted from server memory. + +Please note the the Danga memcached server removed tests for expiration in +the 1.4 version. + + +------ +RETURN +------ + + +A value of type :c:type:`memcached_return_t` is returned +On success that value will be :c:type:`MEMCACHED_SUCCESS`. +Use :c:func:`memcached_strerror` to translate this value to a printable +string. + +If you are using the non-blocking mode of the library, success only +means that the message was queued for delivery. + + +---- +HOME +---- + + +To find out more information please check: +`http://libmemcached.org/ <http://libmemcached.org/>`_ + + +------ +AUTHOR +------ + + +Brian Aker, <brian@tangent.org> + + +-------- +SEE ALSO +-------- + +:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` |