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