Serverpod Caching

session.caches

Cache types

• session.caches.local

  — in-memory, current server instance

• session.caches.localPrio

  — in-memory, for frequently accessed entries

• session.caches.global

  — Redis-backed, shared across instances (requires Redis config; do not use without Redis enabled)

• session.caches.query

  — local query cache used by generated database helpers

Basic usage

await session.caches.local.put('UserData-$userId', userData,
  lifetime: Duration(minutes: 5));

var userData = await session.caches.local.get<UserData>('UserData-$userId');

CacheMissHandler

var userData = await session.caches.local.get(
  'UserData-$userId',
  CacheMissHandler(
    () async => UserData.db.findById(session, userId),
    lifetime: Duration(minutes: 5),
  ),
);

null

null

Collections and primitives

await session.caches.local.put('userCount', 17, lifetime: Duration(minutes: 5));
var count = await session.caches.local.get<int>('userCount');

'EntityName-$id'

Pitfalls

• session.caches.global

  asserts Redis is enabled; it is not a safe no-op fallback.
• Cache groups (

  put(..., group: 'name')

  +

  invalidateGroup('name')

  ) only work on the local caches.

  invalidateGroup

  throws

  UnimplementedError

  on the Redis-backed global cache, so invalidate those entries by key with

  invalidateKey

  .