coldbox-cache-integration

Provide the English text to be summarized in the field below.

1|Updated Apr 10, 2026
One-click install
npx skills add https://github.com/ColdBox/skills --skill coldbox-cache-integration
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: coldbox-cache-integration
Source: https://github.com/ColdBox/skills/tree/main/coldbox/cache-integration
Command: npx skills add https://github.com/ColdBox/skills --skill coldbox-cache-integration

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

ColdBox applications need predictable, performant caching for data, rendered output, and view fragments while avoiding stampede, cross-key collisions, and per-process limitations in multi-node deployments.

Core Features & Use Cases

  • CacheBox configuration: configure default and named caches via config/CacheBox.cfc or inline ColdBox.cfc DSL and choose providers like ConcurrentStore, ConcurrentSoftReferenceStore, engine-native caches, or Redis.
  • Injection & API: inject caches using WireBox (cachebox:name), access getCache()/getCacheBox() in handlers, and use core methods like get, set, getOrSet, clearByKeySnippet, and getStats.
  • Output & Fragment Caching: support full event output caching with setEventCacheableEntry and fine-grained view fragment caching with renderView(cache=true), plus cache listener interceptors for warming and monitoring.
  • Use Case: add a products cache with long TTL for catalogs, use template cache for rendered pages, invalidate list caches on writes, and configure Redis for multi-server session caching.

Quick Start

Configure CacheBox for a ColdBox app to add a Redis-backed sessions cache, a long‑TTL products cache, and inject named caches into your ProductService.

Frequently Asked Questions about coldbox-cache-integration

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I configure CacheBox for Redis caching in a ColdBox application?

Configure CacheBox in a ColdBox application by defining default and named caches in config/CacheBox.cfc or inline within ColdBox.cfc. You can select providers like Redis for multi-server setups or ConcurrentStore for engine-native caching.

How do I inject a named cache into a ColdBox handler or service?

Inject named caches into ColdBox handlers and services using WireBox with the cachebox:name DSL. Alternatively, access caches programmatically in your code by calling the getCache() or getCacheBox() API methods directly.

What is the best way to cache rendered view fragments in ColdBox?

Cache rendered view fragments in ColdBox by using the renderView(cache=true) method. This enables fine-grained view fragment caching, while setEventCacheableEntry handles full event output caching for complete page responses.

How do I invalidate specific cached queries or data when a write occurs in ColdBox?

Invalidate cached queries and data in ColdBox using the clearByKeySnippet method to target specific cache keys. You can also manage TTLs and invalidation automatically by configuring cache listener interceptors for warming and monitoring.

Does ColdBox caching support multi-node deployments to prevent stampede issues?

ColdBox caching supports multi-node deployments by configuring Redis providers to share cached data across servers. This setup avoids per-process limitations, cross-key collisions, and cache stampede issues inherent to single-node engine-native caches.

When should I use ConcurrentSoftReferenceStore instead of Redis for ColdBox caching?

Use ConcurrentSoftReferenceStore or ConcurrentStore for engine-native, in-process caching within a single ColdBox server. Switch to Redis when you need multi-server session caching, shared data across nodes, or long-TTL catalog caches in distributed deployments.