redis_connect: Connect to Redis Cache

Description Usage Arguments Details Value See Also

View source: R/connect.R

Description

The function is a wrapper for redisConnect function that allows to pass host name, port, and authorization as a connection string rather than separate variables.

Usage

1
2
3
redis_connect(conn = redis_options("connection"), host, port, password, ...)

redis_close(...)

Arguments

conn

a connection string for Redis cache, see details

host

the Redis server host name, see redisConnect for details. This will overwrite any settings of the connection string conn.

port

the Redis port number, see redisConnect for details. This will overwrite any settings of the connection string conn.

password

the Redis authentification password, see redisConnect for details. This will overwrite any settings of the connection string conn.

...

other parameter passed to redisConnect or redisClose

Details

The connection string ... contains hostname, port, and authorization (password) for the redis cache. The connection string is of the form host=<hostname>;port=<port>;password=<auth>.

The port can be included in the hostname with a colon as separator: host=<hostname>:<port>;.

As password may contain any string, it must be the last part of the connection string.

Value

logical value, TRUE if connection has been opened, FALSE if a connection has already been opened (note that this has not necessarily need to be the one specified by conn)

See Also

redisConnect for basis function to connect to a Redis Server


mlkornexl/easyRedis documentation built on May 17, 2019, 9:13 a.m.