Serverpod caching — local and Redis caches, cache keys, lifetime, CacheMissHandler. Use when caching data, optimizing queries, or working with session.caches.
In-memory and optional Redis caches via session.caches. Cached objects must be serializable models or primitives supported by Serverpod.
session.caches.local — in-memory, current server instancesession.caches.localPriority — in-memory, for frequently accessed entriessession.caches.global — Redis-backed, shared across instances (requires Redis config)await session.caches.local.put('UserData-$userId', userData,
lifetime: Duration(minutes: 5));
var userData = await session.caches.local.get<UserData>('UserData-$userId');
Load on miss and store automatically:
var userData = await session.caches.local.get(
'UserData-$userId',
CacheMissHandler(
() async => UserData.db.findById(session, userId),
lifetime: Duration(minutes: 5),
),
);
Returns null if the handler returns null (nothing stored).
await session.caches.local.put('userCount', 17, lifetime: Duration(minutes: 5));
var count = await session.caches.local.get<int>('userCount');
If relevant set a lifetime to avoid unbounded growth. Use stable, unique keys (e.g. 'EntityName-$id').