cache_redis: A Caching object for redis

In ThinkR-open/bank: Extra Cache

A Caching object for redis

Description

A Caching object for redis

A Caching object for redis

Details

Create a cache backend with redis

Methods

Public methods

• cache_redis$new()

• cache_redis$get()

• cache_redis$set()

• cache_redis$has_key()

• cache_redis$reset()

• cache_redis$remove()

• cache_redis$keys()

• cache_redis$digest()

• cache_redis$clone()

---

Method new()

Start a new redis cache

Usage

cache_redis$new(..., version = NULL, algo = "sha512", compress = FALSE)

Arguments

...

Named configuration options passed to redis_config, used to create the environment (notable keys include host, port, and the environment variable REDIS_URL). For redis_available, arguments are passed through to hiredis.

version

Version of the interface to generate. If given as a string to numeric version, then only commands that exist up to that version will be included. If given as TRUE, then we will query the Redis server (with INFO) and extract the version number that way.

algo

for {memoise} compatibility, the digest() algorithm

compress

for {memoise} compatibility, should the data be compressed?

Returns

A cache_redis object

---

Method get()

Get a key from the cache

Usage

cache_redis$get(key)

Arguments

key

Name of the key.

Returns

The value stored using the key

---

Method set()

Set a key in the cache

Usage

cache_redis$set(key, value)

Arguments

key

Name of the key.

value

Value to store

Returns

Used for side effect

---

Method has_key()

Does the cache contains a given key?

Usage

cache_redis$has_key(key)

Arguments

key

Name of the key.

Returns

TRUE/FALSE

---

Method reset()

Clear all the cache

Usage

cache_redis$reset()

Returns

Used for side-effect

---

Method remove()

Remove a key/value pair

Usage

cache_redis$remove(key)

Arguments

key

Name of the key.

Returns

Used for side-effect

---

Method keys()

List all the keys in the cache

Usage

cache_redis$keys()

Returns

A list of keys

---

Method digest()

Function that runs an hash algo. For compatibily with {memoise}

Usage

cache_redis$digest(...)

Arguments

...

the value to hash

Returns

A function

---

Method clone()

The objects of this class are cloneable with this method.

Usage

cache_redis$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

ThinkR-open/bank documentation built on March 29, 2023, 5:17 a.m.