cache_mongo: A Caching object for MongoDB

In ThinkR-open/bank: Extra Cache

A Caching object for MongoDB

Description

A Caching object for MongoDB

A Caching object for MongoDB

Details

Create a cache backend with MongoDB.

Methods

Public methods

• cache_mongo$new()

• cache_mongo$get()

• cache_mongo$set()

• cache_mongo$has_key()

• cache_mongo$reset()

• cache_mongo$remove()

• cache_mongo$keys()

• cache_mongo$digest()

• cache_mongo$clone()

---

Method new()

Start a new mongo cache

Usage

cache_mongo$new(
  db = "test",
  url = "mongodb://localhost",
  prefix = "fs",
  options = mongolite::ssl_options(),
  algo = "sha512",
  compress = FALSE
)

Arguments

db

name of database

url

address of the mongodb server in mongo connection string URI format

prefix

string to prefix the collection name

options

additional connection options such as SSL keys/certs.

algo

for {memoise} compatibility. The digest() algorithm.

compress

for {memoise} compatibility. Should the data be compressed?

Returns

A cache_mongo object

---

Method get()

Get a key from the cache

Usage

cache_mongo$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_mongo$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_mongo$has_key(key)

Arguments

key

Name of the key.

Returns

TRUE/FALSE

---

Method reset()

Clear all the cache

Usage

cache_mongo$reset()

Returns

Used for side-effect

---

Method remove()

Remove a key/value pair

Usage

cache_mongo$remove(key)

Arguments

key

Name of the key.

Returns

Used for side-effect

---

Method keys()

List all the keys in the cache

Usage

cache_mongo$keys()

Returns

A list of keys

---

Method digest()

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

Usage

cache_mongo$digest(...)

Arguments

...

the value to hash

Returns

A function

---

Method clone()

The objects of this class are cloneable with this method.

Usage

cache_mongo$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

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