Lotus.Cache.Adapter behaviour (Lotus v0.10.0)
View SourceBehaviour specification for cache adapters in the Lotus framework.
All cache adapters must implement this behavior.
Cache adapters are only meant to be used internally by Lotus and should not be called directly by application code, as their implementation may change without notice.
Built-in Adapters
Lotus.Cache.ETS- Default ETS-based local in-memory cacheLotus.Cache.Cachex- Cachex-based cache supporting local and distributed modes
Usage
Simply use the behavior in your adapter implementation:
defmodule MyApp.CustomCacheAdapter do
use Lotus.Cache.Adapter
# Implement required callbacks...
endConfiguration
Configure your chosen adapter in your application config:
config :lotus,
cache: %{
adapter: MyApp.CustomCacheAdapter,
# adapter-specific options...
}
Summary
Callbacks
Removes a value from the cache by key.
Retrieves a value from the cache by key.
Retrieves a value from cache or stores it if missing.
Invalidates all cache entries associated with the given tags.
Stores a value in the cache with the given key and TTL.
Returns the adapter specification configuration.
Updates the TTL of an existing cache entry without modifying its value.
Types
@type opts() :: Keyword.t()
Options passed to cache operations
@type ttl_ms() :: non_neg_integer()
How long the cache entry should live, in milliseconds
Callbacks
@callback delete(key()) :: :ok | {:error, term()}
Removes a value from the cache by key.
@callback get(key()) :: {:ok, value()} | :miss | {:error, term()}
Retrieves a value from the cache by key.
@callback get_or_store(key(), ttl_ms(), (-> value()), opts()) :: {:ok, value(), :hit | :miss} | {:error, term()}
Retrieves a value from cache or stores it if missing.
Invalidates all cache entries associated with the given tags.
Tags allow for bulk invalidation of related cache entries. When a tag is invalidated, all cache entries that were stored with that tag are removed.
Parameters
tags- List of tag names to invalidate
Stores a value in the cache with the given key and TTL.
@callback spec_config() :: [Supervisor.child_spec()] | [Supervisor.module_spec()]
Returns the adapter specification configuration.
This should return a keyword list of configuration options specific to the adapter.
Called by Lotus.Supervisor to start the cache adapter under the supervisor.
Updates the TTL of an existing cache entry without modifying its value.