Memcached::incrementByKey
(PECL memcached >= 2.0.0)
Memcached::incrementByKey — 指定したサーバー上にある数値アイテムの値を増やす
説明
public Memcached::incrementByKey
( string $server_key
, string $key
[, int $offset
= 1
[, int $initial_value
= 0
[, int $expiry
= 0
]]] ) : int|false
Memcached::incrementByKey() は、数値アイテムの値を
offset
で指定しただけ増やします。
アイテムの値が数値でない場合はエラーとなります。
アイテムが存在しない場合、Memcached::incrementByKey() は値を
initial_value
に設定します。
パラメータ
server_key
- 値を格納したりデータを取得したりするサーバーを表すキー。 アイテムの実際のキーをハッシュするかわりにサーバーのキーをハッシュして、どの memcached サーバーとやりとりするのか選びます。 これで、関連するアイテムを一つのサーバーにまとめられるようになり、マルチ操作の効率が上がります。
key
- 増やしたいアイテムのキー。
offset
- 値を増やしたい量。
initial_value
- そのアイテムが存在しない場合に設定する値。
expiry
- そのアイテムに設定する有効期限。
返り値
成功した場合にアイテムの新しい値、失敗した場合に false
を返します。
参考
- Memcached::decrement() - 数値アイテムの値を減らす
- Memcached::decrementByKey() - 指定したサーバー上にある数値アイテムの値を減らす
- Memcached::increment() - 数値アイテムの値を増やす