---
title: "View source for Cache Overview - DreamFactory Wiki"
source: "http://wiki.dreamfactory.com/index.php?action=edit&title=Cache_Overview"
canonical_url: "http://wiki.dreamfactory.com/index.php?action=edit&title=Cache_Overview"
converted_at: "2026-04-17T10:40:51.121Z"
format: "markdown"
converted_by: "html-to-md-ai"
---
[]()
	
	
	
	# View source for Cache Overview

	
		
		← [Cache Overview](/Cache_Overview)
		
		
		
		[Jump to navigation](#mw-head)
		[Jump to search](#searchInput)
		You do not have permission to edit this page, for the following reason:

The action you have requested is limited to users in the group: [Users](/index.php?title=DreamFactory_Wiki:Users&action=edit&redlink=1).

---

You can view and copy the source of this page.

{{#seo:
|title=Cache Overview - DreamFactory Documentation
|title_mode=replace
|canonical=https://wiki.dreamfactory.com/Cache_Overview
|og:title=Cache Overview
|og:type=article
|og:site_name=DreamFactory Documentation
}}
= Cache Services Overview =

DreamFactory supports multiple caching backends to improve API performance. Caching stores frequently accessed data in memory, reducing database load and improving response times for read-heavy workloads.

----

== Supported Cache Services ==

{| class="wikitable"
! Service !! Type !! Use Case !! Documentation
|-
| '''Redis''' || In-memory store || Production caching, sessions, queues || [[Redis]]
|-
| '''Memcached''' || In-memory cache || Simple key-value caching || [[Memcached]]
|-
| '''Local''' || File-based || Development, single-instance deployments || Built-in
|-
| '''File''' || File-based || Development, disk-based persistence || Built-in
|-
| '''Database''' || SQL-backed || Simple deployments without external cache || Built-in
|}

----

== Cache Use Cases in DreamFactory ==

=== API Response Caching ===

Cache API responses to reduce database queries:

* '''Per-service caching''': Enable caching on individual database or file services
* '''TTL configuration''': Set expiration times based on data volatility
* '''Cache invalidation''': Automatic clearing on write operations

=== Session Storage ===

Store user sessions in a distributed cache:

* '''Scalability''': Share sessions across multiple DreamFactory instances
* '''Performance''': Faster session lookups than database
* '''Persistence''': Redis can persist sessions across restarts

=== Rate Limiting ===

Track API request counts per user or role:

* '''Distributed counting''': Works across load-balanced instances
* '''Atomic operations''': Accurate request tracking
* '''Automatic expiry''': Counters reset after time windows

----

== Choosing a Cache Backend ==

=== Redis vs Memcached ===

{| class="wikitable"
! Feature !! Redis !! Memcached
|-
| Data structures || Strings, lists, sets, hashes, sorted sets || Strings only
|-
| Persistence || Optional disk persistence || Memory only
|-
| Replication || Master-slave, clustering || None (client-side)
|-
| Pub/Sub || Yes || No
|-
| Lua scripting || Yes || No
|-
| Memory efficiency || Good || Excellent for simple data
|-
| Max key size || 512 MB || 1 MB
|-
| Use case || Feature-rich, sessions, queues || Simple caching
|}

=== Recommendation ===

* '''Production''': Use '''Redis''' for its flexibility, persistence options, and support for sessions
* '''Development''': Use '''Local''' cache for simplicity
* '''High-volume simple caching''': Use '''Memcached''' for maximum memory efficiency

----

== Cache Architecture ==

<syntaxhighlight lang="text">
┌─────────────────┐     ┌──────────────────┐     ┌─────────────────┐
│   API Client    │────▶│   DreamFactory   │────▶│    Database     │
│                 │◀────│                  │◀────│                 │
└─────────────────┘     └────────┬─────────┘     └─────────────────┘
                                 │
                                 │ Cache check
                                 ▼
                        ┌─────────────────┐
                        │  Cache Backend  │
                        │  (Redis/Memcached)
                        └─────────────────┘
</syntaxhighlight>

=== Cache Flow ===

# '''Request arrives''' at DreamFactory
# '''Cache check''': If cached response exists and is valid, return it
# '''Cache miss''': Query the database/service
# '''Store in cache''': Save response with configured TTL
# '''Return response''' to client

=== Cache Invalidation ===

DreamFactory automatically invalidates cache entries when:

* '''POST/PUT/PATCH/DELETE''' operations modify data
* '''TTL expires''' based on configured duration
* '''Manual flush''' via admin API

----

== Configuring Cache Services ==

=== System-Wide Cache ===

Configure the default cache backend in DreamFactory's environment:

<syntaxhighlight lang="text">
CACHE_DRIVER=redis
REDIS_HOST=localhost
REDIS_PORT=6379
REDIS_PASSWORD=your_password
</syntaxhighlight>

=== Per-Service Caching ===

Enable caching on individual services:

# Navigate to the service configuration
# Enable '''Cache Enabled''' option
# Set '''Cache TTL''' in seconds
# Save the service

----

== Cache API Endpoints ==

DreamFactory exposes a Cache API for direct cache operations:

{| class="wikitable"
! Method !! Endpoint !! Description
|-
| <code>GET</code> || <code>/api/v2/{cache_service}/{key}</code> || Get cached value
|-
| <code>POST</code> || <code>/api/v2/{cache_service}</code> || Store value in cache
|-
| <code>DELETE</code> || <code>/api/v2/{cache_service}/{key}</code> || Delete cached value
|-
| <code>DELETE</code> || <code>/api/v2/{cache_service}</code> || Flush all cached values
|}

=== Example: Store a Value ===

<syntaxhighlight lang="bash">
curl -X POST "https://example.com/api/v2/cache" \
  -H "X-DreamFactory-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "key": "user:123:profile",
    "value": {"name": "John", "email": "john@example.com"},
    "ttl": 3600
  }'
</syntaxhighlight>

=== Example: Retrieve a Value ===

<syntaxhighlight lang="bash">
curl -X GET "https://example.com/api/v2/cache/user:123:profile" \
  -H "X-DreamFactory-API-Key: YOUR_API_KEY"
</syntaxhighlight>

----

== Performance Best Practices ==

=== TTL Configuration ===

{| class="wikitable"
! Data Type !! Recommended TTL !! Rationale
|-
| Static reference data || 24 hours || Rarely changes
|-
| User profiles || 5-15 minutes || Balances freshness and performance
|-
| Real-time data || 30-60 seconds || Frequently updated
|-
| Session data || 30 minutes - 2 hours || Matches session duration
|}

=== Cache Key Design ===

Use structured, predictable key patterns:

<syntaxhighlight lang="text">
{resource_type}:{id}:{sub_resource}
</syntaxhighlight>

Examples:
* <code>user:123:profile</code>
* <code>product:456:inventory</code>
* <code>order:789:items</code>

=== Memory Management ===

* '''Monitor memory usage''' to prevent eviction
* '''Set appropriate TTLs''' to expire stale data
* '''Use Redis maxmemory-policy''' for graceful eviction

----

== Common Errors ==

{| class="wikitable"
! Error Code !! Message !! Cause !! Solution
|-
| 400 || Bad Request || Invalid key or value format || Check request payload
|-
| 401 || Unauthorized || Missing API key || Add API key header
|-
| 404 || Not Found || Key does not exist || Handle cache miss in client
|-
| 503 || Service Unavailable || Cache backend unreachable || Check cache server status
|}

----

== Next Steps ==

* '''[[Redis]]''': Configure Redis for production caching
* '''[[Memcached]]''': Configure Memcached for simple caching
* '''[[Getting_Started/Optimizing_Dreamfactory/Database|Performance Tuning]]''': Optimize DreamFactory performance

[[Category:API]]
Return to [Cache Overview](/Cache_Overview).

Retrieved from "[https://wiki.dreamfactory.com/Cache_Overview](https://wiki.dreamfactory.com/Cache_Overview)"