/man/redisGet.Rd

http://github.com/bwlewis/rredis · Unknown · 51 lines · 48 code · 3 blank · 0 comment · 0 complexity · ff441c2f43f106dd61cebd943ebbc9df MD5 · raw file

  1. \name{redisGet}
  2. \alias{redisGet}
  3. \title{Retrieve a value from Redis.}
  4. \description{Retrieve a value identified by a key
  5. from the Redis database.
  6. }
  7. \usage{
  8. redisGet(key, ...)
  9. }
  10. \arguments{
  11. \item{key}{
  12. The (required) character identifier for the value to be looked up.
  13. }
  14. \item{...}{ Optional additional arguments passed to \code{redisCmd}.
  15. Specify \code{raw=TRUE} to skip de-serialization of the data.}
  16. }
  17. \details{
  18. The key must not contain spaces or newline characters (otherwise an error will
  19. be thrown). The \code{raw} option is used to retrieve binary data from other
  20. languages.
  21. }
  22. \value{
  23. The value corresponding to the specified key, or NULL if the matching key
  24. contained no value or if no matching key was found.
  25. Use the \code{raw=TRUE} option to return Redis values in raw binary form, which
  26. can optionally later be converted to character using the \code{rawToChar}
  27. function.
  28. A Redis value that does not represent a serialized R value is returned as a
  29. \code{character} R value with an attribute named "redis string value." Subsequent
  30. uploads of that value to Redis will send the character-valued data in raw form
  31. (not as a serialized R value), preserving the original nature of the data in
  32. Redis.
  33. }
  34. \references{
  35. http://redis.io/commands
  36. }
  37. \author{
  38. B. W. Lewis
  39. }
  40. \seealso{
  41. \code{\link{redisSet}}
  42. }
  43. \examples{
  44. \dontrun{
  45. redisSet('x',runif(5))
  46. redisGet('x')
  47. }
  48. }