PhoenixAnalytics.Services.Cache (PhoenixAnalytics v0.4.1)

View Source

This module provides caching functionality for PhoenixAnalytics.

The main purpose of this cache is to reduce the number of read calls to the database. By caching results, we can improve performance and reduce the load on the database for frequently accessed data.

The cache uses Cachex with a configurable TTL (Time To Live).

Summary

Functions

add(key, value)

Adds a value to the cache with the given key.

fetch(key, callback)

Fetches a value from the cache for the given key, or computes and caches it if not present.

get(key)

Retrieves a value from the cache for the given key.

Functions

add(key, value)

Adds a value to the cache with the given key.

Parameters

  • key - The key under which to store the value in the cache.
  • value - The value to be stored in the cache.

Returns

  • {:ok, true} - If the value was successfully added to the cache.
  • {:ok, :error} - If there was an error adding the value to the cache.

Examples

iex> PhoenixAnalytics.Services.Cache.add("new_key", "new_value")
{:ok, true}

iex> PhoenixAnalytics.Services.Cache.add("existing_key", "updated_value")
{:ok, true}

fetch(key, callback)

Fetches a value from the cache for the given key, or computes and caches it if not present.

Parameters

  • key - The key to fetch from the cache.
  • callback - A function that computes the value if it's not in the cache.

## Returns

* `{:ok, value}` - If the value was found in the cache.

* `{:commit, value}` - If the value was successfully computed and cached.

* `{:error, reason}` - If there was an error fetching or computing the value.

Examples

iex> PhoenixAnalytics.Services.Cache.fetch("some_key", fn -> "computed_value" end)
{:commit, "computed_value"}

iex> PhoenixAnalytics.Services.Cache.fetch("existing_key", fn -> "new_value" end)
{:ok, "cached_value"}

get(key)

Retrieves a value from the cache for the given key.

Returns

  • {:ok, nil} - If the key is not found in the cache.
  • {:ok, value} - If the key is found, where value is the cached data.

Examples

iex> PhoenixAnalytics.Services.Cache.get("some_key")
{:ok, nil}

iex> PhoenixAnalytics.Services.Cache.get("existing_key")
{:ok, "cached_value"}