/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
5from the Redis database.
6}
7\usage{
8redisGet(key, ...)
9}
10\arguments{
11  \item{key}{
12The (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{
18The key must not contain spaces or newline characters (otherwise an error will
19be thrown). The \code{raw} option is used to retrieve binary data from other
20languages.
21}
22\value{
23The value corresponding to the specified key, or NULL if the matching key
24contained no value or if no matching key was found.
25
26Use the \code{raw=TRUE} option to return Redis values in raw binary form, which
27can optionally later be converted to character using the \code{rawToChar}
28function.
29
30A Redis value that does not represent a serialized R value is returned as a
31\code{character} R value with an attribute named "redis string value." Subsequent
32uploads of that value to Redis will send the character-valued data in raw form
33(not as a serialized R value), preserving the original nature of the data in
34Redis.
35}
36\references{
37http://redis.io/commands
38}
39\author{
40B. W. Lewis
41}
42
43\seealso{