How do I add caching to an Ecto query with Nebulex?

Use Nebulex's decorator-based caching: define a cache module, add the @decorate cacheable annotation with a key like {User, id} and TTL options, as shown in the quick start example. This minimizes code changes while caching database results.

Nebulex vs Cachex for local caching in Elixir?

Nebulex provides a unified abstraction supporting multiple backends including Cachex, ideal for teams wanting consistency across caches. Cachex is better for direct, lightweight local caching without the abstraction layer, offering more control but less flexibility.

How to configure Nebulex for distributed caching?

Choose a distributed adapter like Redis or Memcached, add its dependency in mix.exs, and set the adapter in your cache definition. Refer to the Nebulex adapters guide for topology setup and configuration details.

What telemetry events does Nebulex provide?

Nebulex emits events for cache operations like hits, misses, and errors, which can be monitored via the :telemetry dependency. Check the Info API guide for specific event names and metrics to track performance.

How to handle cache expiration with Nebulex decorators?

Set the ttl option in decorators like @decorate cacheable(opts: [ttl: :timer.hours(1)]) to define time-to-live for entries. This is demonstrated in the quick start example where user cache expires after one hour.

Is Nebulex suitable for high-throughput applications?

Yes, but benchmark your setup: Nebulex includes performance tests with benchee, and while the abstraction adds overhead, using efficient adapters like Redis can scale. Monitor with telemetry to tune for throughput.

nebulex — Elixir Caching Toolkit

What is nebulex?

Nebulex is a caching toolkit for Elixir that provides a transparent abstraction layer for integrating caching into applications, similar to how Ecto handles databases. It supports multiple backends like Redis, Memcached, and local caches such as Cachex, and offers features like declarative caching decorators and common caching patterns. The toolkit aims to shield developers from the complexities of underlying caching systems while promoting clean, declarative code.

Target Audience

Elixir developers building applications that require in-memory or distributed caching, particularly those seeking a unified, Ecto-like interface to abstract different caching solutions. It is also suitable for teams needing advanced caching patterns like cache-aside, read-through, or write-through out of the box.

Value Proposition

Developers choose Nebulex for its consistent API across various caching backends, reducing vendor lock-in and simplifying code changes. Its declarative decorator-based caching allows minimal code modifications to add caching, and built-in telemetry integration provides monitoring capabilities without extra setup.

In-memory and distributed caching toolkit for Elixir.

Use Cases

Best For

Elixir applications needing a unified caching abstraction to switch between Redis, Memcached, or local caches without code rewrites.
Implementing declarative caching with decorator annotations to easily cache function results, such as database queries in Ecto contexts.
Building scalable distributed caching topologies for high-availability Elixir systems.
Applying common caching patterns like cache-aside, read-through, or write-through with minimal boilerplate.
Monitoring cache performance and metrics through built-in telemetry events in Elixir applications.
Integrating caching transparently into existing Elixir codebases with an Ecto-like approach for consistency.

Not Ideal For

Projects requiring direct, low-level access to caching backend APIs for custom optimizations or specific features not abstracted by Nebulex.
Applications with strict dependency minimization that cannot accommodate optional dependencies like :decorator or :telemetry for full functionality.
Simple, single-backend caching needs where using a library like Cachex or :ets directly would be lighter without the abstraction overhead.
Teams preferring imperative caching code over declarative decorators, as Nebulex's annotation-based approach adds syntactic complexity.

Pros & Cons

Pros

Unified Caching Abstraction

Provides a consistent API for multiple backends like Redis, Memcached, and Cachex, reducing vendor lock-in and simplifying code changes, as shown in the adapter setup examples.

Declarative Caching Support

Enables easy caching with decorator annotations, minimizing code modifications for caching logic, as demonstrated in the quick start example with Ecto queries.

Built-in Caching Patterns

Implements patterns like cache-aside and read-through out of the box, saving development time and promoting best practices, referenced in the cache usage patterns guide.

Telemetry Integration

Offers monitoring capabilities with built-in events for cache performance metrics, requiring only the :telemetry dependency for setup, as noted in the Info API guide.

Cons

Dependency Management Complexity

Requires optional dependencies like :decorator and :telemetry for full features, adding setup steps and potential version conflicts, as highlighted in the README's dependency instructions.

Abstraction Overhead

The abstraction layer may introduce performance penalties compared to direct backend usage, as indicated by benchmarks focusing on the Nil adapter to measure Nebulex's own impact.

Adapter Limitations

Not all caching backends might be supported or fully abstracted, limiting flexibility for niche solutions, and adapter-specific features may require workarounds.

What is nebulex?

Target Audience

Value Proposition

Use Cases

Best For

Elixir applications needing a unified caching abstraction to switch between Redis, Memcached, or local caches without code rewrites.
Implementing declarative caching with decorator annotations to easily cache function results, such as database queries in Ecto contexts.
Building scalable distributed caching topologies for high-availability Elixir systems.
Applying common caching patterns like cache-aside, read-through, or write-through with minimal boilerplate.
Monitoring cache performance and metrics through built-in telemetry events in Elixir applications.
Integrating caching transparently into existing Elixir codebases with an Ecto-like approach for consistency.

Not Ideal For

Projects requiring direct, low-level access to caching backend APIs for custom optimizations or specific features not abstracted by Nebulex.
Applications with strict dependency minimization that cannot accommodate optional dependencies like :decorator or :telemetry for full functionality.
Simple, single-backend caching needs where using a library like Cachex or :ets directly would be lighter without the abstraction overhead.
Teams preferring imperative caching code over declarative decorators, as Nebulex's annotation-based approach adds syntactic complexity.

Pros & Cons

Pros

Unified Caching Abstraction

Provides a consistent API for multiple backends like Redis, Memcached, and Cachex, reducing vendor lock-in and simplifying code changes, as shown in the adapter setup examples.

Declarative Caching Support

Enables easy caching with decorator annotations, minimizing code modifications for caching logic, as demonstrated in the quick start example with Ecto queries.

Built-in Caching Patterns

Implements patterns like cache-aside and read-through out of the box, saving development time and promoting best practices, referenced in the cache usage patterns guide.

Telemetry Integration

Offers monitoring capabilities with built-in events for cache performance metrics, requiring only the :telemetry dependency for setup, as noted in the Info API guide.

Cons

Dependency Management Complexity

Requires optional dependencies like :decorator and :telemetry for full features, adding setup steps and potential version conflicts, as highlighted in the README's dependency instructions.

Abstraction Overhead

The abstraction layer may introduce performance penalties compared to direct backend usage, as indicated by benchmarks focusing on the Nil adapter to measure Nebulex's own impact.

Adapter Limitations

Not all caching backends might be supported or fully abstracted, limiting flexibility for niche solutions, and adapter-specific features may require workarounds.

nebulex

What is nebulex?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?

nebulex

What is nebulex?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?