Memcached::addByKey
(PECL memcached >= 0.1.0)
Memcached::addByKey — Add an item under a new key on a specific server
Description
string
$server_key,string
$key,mixed
$value,int
$expiration = ?): bool
Memcached::addByKey() is functionally equivalent to
Memcached::add(), except that the free-form
server_key can be used to map the
key to a specific server. This is useful if you need
to keep a bunch of related keys on a certain 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 under which to store the value.
-
value -
The value to store.
-
expiration -
The expiration time, defaults to 0. See Expiration Times for more info.
Return Values
Returns true on success or false on failure.
The Memcached::getResultCode() will return
Memcached::RES_NOTSTORED if the key already exists.
See Also
- Memcached::add() - Add an item under a new key
- Memcached::set() - Store an item
- Memcached::replace() - Replace the item under an existing key
