Memcached::deleteByKey
Memcached::deleteByKey
(PECL memcached >= 0.1.0)
Memcached::deleteByKey — Delete an item from a specific server
Description
public bool Memcached::deleteByKey ( string $server_key , string $key [, int $time = 0 ] )
Memcached::deleteByKey()
is functionally equivalent to Memcached::delete(), except that the free-form server_key
can be used to map the key
to a specific server.
Parameters
server_key
The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations.
key
The key to be deleted.
time
The amount of time the server will wait to delete the item.
Return Values
Returns TRUE
on success or FALSE
on failure. The Memcached::getResultCode() will return Memcached::RES_NOTFOUND
if the key does not exist.
See Also
- Memcached::delete() - Delete an item
- Memcached::deleteMulti() - Delete multiple items
- Memcached::deleteMultiByKey() - Delete multiple items from a specific server
← Memcached::delete
Memcached::deleteMulti →
© 1997–2017 The PHP Documentation Group
Licensed under the Creative Commons Attribution License v3.0 or later.