cache_postgres: A Caching object for postgres

In ThinkR-open/bank: Extra Cache

A Caching object for postgres

Description

A Caching object for postgres

A Caching object for postgres

Details

Create a cache backend with postgres

Methods

Public methods

• cache_postgres$new()

• cache_postgres$has_key()

• cache_postgres$get()

• cache_postgres$set()

• cache_postgres$reset()

• cache_postgres$remove()

• cache_postgres$keys()

• cache_postgres$digest()

• cache_postgres$clone()

---

Method new()

Start a new postgres cache

Usage

cache_postgres$new(
  ...,
  cache_table = "bankrcache",
  algo = "sha512",
  compress = FALSE
)

Arguments

...

Parameters passes do DBI::dbConnect(RPostgres::Postgres(), ...)

cache_table

On initialize(), the cache object will create a table to store the cache. Default name is bankrcache. Change it if you already have a table named bankrcache in your DB.

algo

for {memoise} compatibility, the digest() algorithm

compress

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

Returns

A cache_postgres object

---

Method has_key()

Does the cache contains a given key?

Usage

cache_postgres$has_key(key)

Arguments

key

Name of the key.

Returns

TRUE/FALSE

---

Method get()

Get a key from the cache

Usage

cache_postgres$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_postgres$set(key, value)

Arguments

key

Name of the key.

value

Value to store

Returns

Used for side effect

---

Method reset()

Clear all the cache

Usage

cache_postgres$reset()

Returns

Used for side-effect

---

Method remove()

Remove a key/value pair

Usage

cache_postgres$remove(key)

Arguments

key

Name of the key.

Returns

Used for side-effect

---

Method keys()

List all the keys in the cache

Usage

cache_postgres$keys()

Returns

A list of keys

---

Method digest()

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

Usage

cache_postgres$digest(...)

Arguments

...

the value to hash

Returns

A function

---

Method clone()

The objects of this class are cloneable with this method.

Usage

cache_postgres$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

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