View Source Plausible.Site.Cache (Plausible v0.0.1)

The cache allows lookups by both domain and domain_changed_from fields - this is to allow traffic from sites whose domains changed within a certain grace period (see: Plausible.Site.Transfer).

To differentiate cached Site structs from those retrieved directly from the database, a virtual schema field from_cache?: true is set. This indicates the Plausible.Site struct is incomplete in comparison to its database counterpart -- to spare bandwidth and query execution time, only selected database columns are retrieved and cached.

The @cached_schema_fields attribute defines the list of DB columns queried on each cache refresh.

Also see tests for more comprehensive examples.

Summary

Functions

child_spec(opts)

get(key, opts \\ [])

get_or_store(key, fallback_fn, opts \\ [])

get_site_id(domain, opts \\ [])

hit_rate(cache_name \\ name())

See Plausible.Cache.Stats.hit_rate/1.

merge_items(new_items, opts \\ [])

ready?(cache_name \\ name())

Ensures the cache has non-zero size unless no items exist. Useful for orchestrating app startup to prevent the service going up asynchronously with an empty cache.

refresh_all(opts \\ [])

refresh_updated_recently(opts \\ [])

size(cache_name \\ name())

See Plausible.Cache.Adapter.size/1.

telemetry_event_refresh(cache_name \\ name(), mode)

touch_site!(site, now)