Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

R client for Redis first draft

  • Loading branch information...
commit 090c8477e27bfd710a028526b0e7cc0c65d3ff44 0 parents
B. W. Lewis authored
191 COPYING
@@ -0,0 +1,191 @@
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ Copyright 2010, B. W. Lewis
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
13 COPYRIGHT
@@ -0,0 +1,13 @@
+Copyright 2010, B. W. Lewis
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
10 DESCRIPTION
@@ -0,0 +1,10 @@
+Package: redis
+Type: Package
+Title: Redis client for R
+Version: 0.01
+Date: 2010-01-26
+Author: B. W. Lewis
+Maintainer: B. W. Lewis <blewis@illposed.net>
+Description: The 'redis' package provides a simple R client for the Redis persistent key-value database available from http://code.google.com/p/redis/.
+License: Apache 2.0
+LazyLoad: yes
1  NAMESPACE
@@ -0,0 +1 @@
+exportPattern("^[[:alpha:]]+")
26 R/redis-internal.R
@@ -0,0 +1,26 @@
+.redisEnv <- new.env()
+
+.redis <-
+function()
+{
+ tryCatch(get('con',envir=.redisEnv),error=function(e) stop('Not connected, try using redisConnect()'))
+}
+
+.redisPP <-
+function()
+{
+# Ping-pong
+ con <- .redis()
+ socketSelect(list(con),write=TRUE)
+ cat('PING\r\n',file=con)
+ socketSelect(list(con))
+ l <- readLines(con=con)
+ if(substr(l,1,5)!='+PONG') stop ('Ping/pong error')
+}
+
+`.onLoad` <-
+function(libname,pkgname)
+{
+}
+
+# XXX add .onUnload cleanup
8 R/redisClose.R
@@ -0,0 +1,8 @@
+redisClose <-
+function()
+{
+ con <- .redis()
+ close(con)
+ remove(list='con',envir=.redisEnv)
+}
+
13 R/redisConnect.R
@@ -0,0 +1,13 @@
+redisConnect <-
+function(host='localhost', port=6379)
+{
+ con <- socketConnection(host, port,open='a+b')
+ assign('con',con,envir=.redisEnv)
+ socketSelect(list(con),write=TRUE)
+ cat('PING\r\n',file=con)
+ socketSelect(list(con))
+ l <- readLines(con=con)
+# XXX check error
+ invisible()
+}
+
27 R/redisGet.R
@@ -0,0 +1,27 @@
+redisGet <-
+function(key)
+{
+ msg <- paste('GET ',key,'\r\n',sep='')
+ con <- .redis()
+ socketSelect(list(con),write=TRUE)
+ cat(msg, file=con)
+ socketSelect(list(con))
+ l <- readLines(con,n=1)
+ if(substr(l,1,1)!='$') {
+# XXX ping/pong here to stabilize the connection
+ return(NULL)
+ }
+ substr(l,1,1) <- ' '
+ l <- as.numeric(l)
+ if(l<0) {
+# XXX ping/pong here to stabilize the connection
+ return(NULL)
+ }
+ socketSelect(list(con))
+ x <- readBin(con,'raw',n=l)
+ socketSelect(list(con))
+ l <- readLines(con,n=1)
+# Try retrieving an R object, otherwise default to character:
+ tryCatch(unserialize(x),error=function(e) rawToChar(x))
+}
+
19 R/redisSet.R
@@ -0,0 +1,19 @@
+redisSet <-
+function(key, value)
+{
+ con <- .redis()
+ if(!is.raw(value)) value <- serialize(value,ascii=FALSE,connection=NULL)
+ msg <- paste('SET ',key,' ',length(value),'\r\n',sep='')
+ socketSelect(list(con),write=TRUE)
+ cat(msg, file=con)
+ socketSelect(list(con),write=TRUE)
+ writeBin(value,con)
+ socketSelect(list(con),write=TRUE)
+ cat('\r\n', file=con)
+ socketSelect(list(con))
+ l <- readLines(con,n=1)
+# XXX check for '+OK' reply
+ socketSelect(list(con),write=TRUE)
+ cat('\r\n', file=con)
+}
+
1  README
@@ -0,0 +1 @@
+rredis: An easy to use R client package for Redis
41 man/redis-package.Rd
@@ -0,0 +1,41 @@
+\name{redis-package}
+\alias{redis-package}
+\alias{redis}
+\docType{package}
+\title{An R client for Redis}
+\description{
+Redis is a high-performance networked
+persistent key/value structured data store.
+The redis package for R provides an easy to use native R language interface
+to Redis. The R client can store and read arbitrary serializable R objects
+as well as access raw objects like strings from other clients. The redis
+package presently supports only a useful subset of the many available Redis
+features. A more full-featured client implementation is in process.
+}
+\details{
+\tabular{ll}{
+Package: \tab redis\cr
+Type: \tab Package\cr
+Version: \tab 0.01\cr
+Date: \tab 2010-01-26\cr
+License: \tab Apache\cr
+LazyLoad: \tab yes\cr
+}
+}
+\author{
+B. W. Lewis
+
+Maintainer: B. W. Lewis <blewis@illposed.net>
+}
+\references{
+\link{http://code.google.com/p/redis/}
+}
+\keyword{ package }
+\examples{
+\dontrun{
+redisConnect()
+redisSet('x',runif(5))
+redisGet('x')
+redisClose()
+}
+}
35 man/redisClose.Rd
@@ -0,0 +1,35 @@
+\name{redisClose}
+\alias{redisClose}
+\title{Close an open connection to a Redis server.}
+\description{The redisClose function closes any open connection to a Redis
+server.}
+\usage{
+redisClose()
+}
+\arguments{
+}
+\details{A running instance of a Redis server is required. See
+http://code.google.com/p/redis/ for details.}
+\value{Nothing is returned. Errors are displayed if the function fails to
+close the connection to the Redis server, or if the connection is invalid.
+}
+\references{
+http://code.google.com/p/redis/ for details.
+}
+\author{
+B. W. Lewis
+}
+
+%% ~Make other sections like Warning with \section{Warning }{....} ~
+
+\seealso{
+\code{\link{redisConnect}}
+}
+\examples{
+\dontrun{
+redisConnect()
+redisSet('x',runif(5))
+redisGet('x')
+redisClose()
+}
+}
37 man/redisConnect.Rd
@@ -0,0 +1,37 @@
+\name{redisConnect}
+\alias{redisConnect}
+\title{Connect to a Redis server.}
+\description{Connect to an available Redis server on the specified port.}
+\usage{
+redisConnect(host = "localhost", port = 6379)
+}
+\arguments{
+ \item{host}{The Redis server host name or inet address (optional, character)}
+ \item{port}{The Redis port number (optional, numeric or integer)}
+}
+\details{A running instance of a Redis server is required. See
+http://code.google.com/p/redis/ for details.}
+\value{Nothing is returned. Errors are displayed if the function fails to
+connect to the specified Redis server. Disconnect from a connected server
+with redisClose.
+}
+\references{
+http://code.google.com/p/redis/ for details.
+}
+\author{
+B. W. Lewis
+}
+
+%% ~Make other sections like Warning with \section{Warning }{....} ~
+
+\seealso{
+\code{\link{redisClose}}
+}
+\examples{
+\dontrun{
+redisConnect()
+redisSet('x',runif(5))
+redisGet('x')
+redisClose()
+}
+}
36 man/redisGet.Rd
@@ -0,0 +1,36 @@
+\name{redisGet}
+\alias{redisGet}
+\title{Retrieve a value from Redis.}
+\description{Retrieve a value identified by a key
+from the Redis database.
+}
+\usage{
+redisGet(key)
+}
+\arguments{
+ \item{key}{
+The (required) character identifier for the value to be looked up.
+}
+}
+\details{
+The key must not contain spaces or newline characters (otherwise an error will be thrown).
+}
+\value{
+The retrieved value is returned, or NULL if no matching key was found.
+}
+\references{
+{\link{http://code.google.com/p/redis/}}
+}
+\author{
+B. W. Lewis
+}
+
+\seealso{
+\code{\link{redisSet}}
+}
+\examples{
+\dontrun{
+redisStore('x',runif(5))
+redisGet('x')
+}
+}
56 man/redisSet.Rd
@@ -0,0 +1,56 @@
+\name{redisSet}
+\alias{redisSet}
+\title{Store a value in Redis.}
+\description{Store a value identified by a character key name
+in the Redis database. Any existing value with the same key will be replaced
+by the new value.
+}
+\usage{
+redisSet(key, value)
+}
+\arguments{
+ \item{key}{
+The (required) character identifier for the value to be stored.
+}
+ \item{value}{
+The (required) object to associate with the key.
+}
+}
+\details{
+The key must not contain spaces or newline characters (otherwise an error will be thrown).
+
+The value object is copied to the Redis server.
+The value to be stored may can be any
+serializable R object up to the Redis maximum object size
+(excluding, for example, external pointer references).
+References to other R objects or environments inside the value are not
+guaranteed to be preserved.
+
+In order to store strings that can easily be read by other clients, first
+convert the character object using the
+\code{\link{charToRaw}} function as shown in the
+examples.
+}
+\value{
+Nothing is returned. Errors are displayed if something goes wrong.
+}
+\references{
+{\link{http://code.google.com/p/redis/}}
+}
+\author{
+B. W. Lewis
+}
+
+\seealso{
+\code{\link{redisGet}}
+}
+\examples{
+\dontrun{
+# Store an R object with the key 'x':
+redisSet('x',runif(5))
+}
+\dontrun{
+# Store a string that can be easily read by other clients:
+redisSet('x',charToRaw('Hello Redis clients'))
+}
+}
Please sign in to comment.
Something went wrong with that request. Please try again.