PageRenderTime 5ms CodeModel.GetById 1ms app.highlight 1ms RepoModel.GetById 2ms app.codeStats 0ms

/man/redisHSet.Rd

http://github.com/bwlewis/rredis
Unknown | 59 lines | 56 code | 3 blank | 0 comment | 0 complexity | b2e7d67e1abf69093417e598eda83c16 MD5 | raw file
 1\name{redisHSet}
 2\alias{redisHSet}
 3\title{Store a hash value in Redis.}
 4\description{Store a value identified by a character key name and field
 5in the Redis database. Any existing value with the same key/field 
 6will be replaced by the new value unless NX is set to TRUE.
 7}
 8\usage{
 9redisHSet(key, field, value, NX = FALSE)
10}
11\arguments{
12  \item{key}{
13The (required) character identifier for the key name. 
14}
15  \item{field}{
16The (required) character identifier for the field name. 
17}
18  \item{value}{
19The (required) object to associate with the key/field.
20}
21  \item{NX}{
22If NX = TRUE, existing values will not be replaced.
23}
24}
25\details{
26Redis hash values store values in one or more fields associated with a single
27key name.
28
29The value to be stored can be any
30serializable R object up to the Redis maximum object size 
31(excluding, for example, external pointer references).
32References to other R objects or environments inside the value are not
33guaranteed to be preserved.
34
35In order to store strings that can easily be read by other clients, first
36convert the character object using the 
37\code{\link{charToRaw}} function as shown in the
38examples.
39}
40\value{
41TRUE is returned on success. 
42If NX = FALSE and a value already exists, the value will not be replaced
43and FALSE will be returned.
44}
45\references{
46http://redis.io/commands
47}
48\author{
49B. W. Lewis
50}
51
52\seealso{
53\code{\link{redisHGet}}
54}
55\examples{
56\dontrun{
57redisHSet('A', 'x',runif(5))
58}
59}