/man/redisHFields.Rd

http://github.com/bwlewis/rredis · Unknown · 27 lines · 27 code · 0 blank · 0 comment · 0 complexity · 651586a3c3c5305f6bb5a0b9bbc54faf MD5 · raw file

  1. \name{redisHFields}
  2. \alias{redisHFields}
  3. \title{Redis hash fields.}
  4. \description{Return the fields associated with the given key.}
  5. \usage{
  6. redisHFields(key, ...)
  7. }
  8. \arguments{
  9. \item{key}{The key to look up.}
  10. \item{...}{ Optional additional arguments. Specify \code{raw=TRUE} to skip de-serialization of the data.}
  11. }
  12. \details{Returns the fields in the Redis hash
  13. associated with \code{key}.
  14. If the key is not found, or if the hash is empty, NULL is returned. If the
  15. key is associated with a value of type other than 'hash,' an error is
  16. thrown.
  17. }
  18. \value{A list of fields defined for the given key. }
  19. \references{ http://redis.io/commands}
  20. \author{ B. W. Lewis }
  21. \seealso{ \code{\link{redisHSet}} }
  22. \examples{
  23. \dontrun{
  24. redisHMSet('A',list(x=1,y=2,z=3))
  25. redisHFields('A')
  26. }
  27. }