Memcached::deleteByKey
(PECL memcached >= 0.1.0)
Memcached::deleteByKey — Delete an item from a specific server
Description
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.
Note: As of memcached 1.3.0 (released 2009) this feature is no longer supported. Passing a non-zero
timewill cause the deletion to fail. Memcached::getResultCode() will returnMEMCACHED_INVALID_ARGUMENTS.
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
add a note
