/man/redisHIncrBy.Rd
http://github.com/bwlewis/rredis · Unknown · 44 lines · 43 code · 1 blank · 0 comment · 0 complexity · 9dd25e68eef2f747742fb985fb0d381c MD5 · raw file
- \name{redisHIncrBy}
- \alias{redisHIncrBy}
- \alias{redisHIncrByFloat}
- \title{Increment a value.}
- \description{Increment the value corresponding to the given key/field
- combination by the specified value.
- }
- \usage{
- redisHIncrBy(key, field, value, ...)
- }
- \arguments{
- \item{key}{A key name.}
- \item{field}{A field name.}
- \item{value}{The value to increment by (integer, numeric, or character).}
- \item{...}{ Optional additional arguments. Specify \code{raw=TRUE} to skip de-serialization of the data.}
- }
- \details{
- The value should be an integer
- (\code{redisHIncrBy}) or a numeric value (\code{redisHIncrByFloat}).
- If the key/field value does not exist or contains a
- value of a wrong type, set the
- key to the value of "0" before to perform the operation.
- }
- \value{
- The new value of key after the increment, returned as a character
- string.
- }
- \references{
- http://redis.io/commands
- }
- \author{
- B. W. Lewis
- }
- \seealso{
- \code{\link{redisHSet}}
- }
- \examples{
- \dontrun{
- # Note initial value must be a raw character string!
- redisHSet('A','x',charToRaw('5'))
- redisHIncrBy('A','x',3)
- }
- }