API Reference Nebulex v3.0.0-rc.1
View SourceModules
Nebulex is split into two main components
Specifies the minimal API required from adapters.
Specifies the adapter Info API.
Specifies the adapter Key/Value API.
Specifies the adapter Observable API.
Specifies the adapter Query API.
Specifies the adapter Transaction API.
A simple/default implementation for Nebulex.Adapter.Info
behaviour.
Stats implementation using Erlang counters.
The Nil adapter is a special cache adapter that turns off the cache. It loses all the items saved on it and returns nil for all read operations and true for all save operations. This adapter is mostly useful for tests.
Options for the Nebulex.Adapters.Nil
adapter.
Cache abstraction layer inspired by Ecto.
It is raised when the cache cannot be retrieved from the registry because it was not started or does not exist.
At its core, the abstraction applies caching to Elixir functions, reducing thus the number of executions based on the information available in the cache. That is, each time a targeted function is invoked, the abstraction will apply a caching behavior checking whether the function has been already executed and its result cached for the given arguments. If it has, then the cached result is returned without having to execute the actual function; if it has not, then function is executed, the result cached and returned to the user so that, the next time the method is invoked, the cached result is returned. This way, expensive functions (whether CPU or IO bound) can be executed only once for a given set of parameters and the result reused without having to actually execute the function again. The caching logic is applied transparently without any interference to the invoker.
Declarative decorator-based caching, inspired by Spring Cache Abstraction.
Decorator context.
This exception represents command execution errors. For example, the cache cannot perform a command because it has not started, it does not exist, or the adapter failed to perform it for any reason.
Nebulex cache event.
A cache entry event.
Raised at runtime when a key does not exist in the cache.
Raised at runtime when the query is invalid.
A Telemetry handler listens to cache command completion events, builds the corresponding cache entry event, and applies the provided filter and listener.
Telemetry handler for aggregating cache stats; it relies on the default
Nebulex.Adapters.Common.Info
implementation based on Erlang counters.
See Nebulex.Adapters.Common.Info.Stats
.
Time utilities.
General purpose utilities.
Mix Tasks
Prints Nebulex tasks and their information.
Generates a new cache.