Cache
The cache stores computed values so you don't recompute them on every request. Use it for expensive queries, third-party API responses, counters, and locks that stop two processes from doing the same work at once.
Quick example
import cache from '@holo-js/cache'
import { DB } from '@holo-js/db'
export async function getDashboardStats() {
return cache.remember('dashboard.stats', 300, async () => ({
users: await DB.table('users').count(),
posts: await DB.table('posts').count(),
}))
}The first call runs the callback and stores the result for 300 seconds. Every call after that returns the stored value until it expires.
Install
Add cache support to an existing project:
npx holo install cacheThis installs @holo-js/cache, writes config/cache.ts, and adds CACHE_DRIVER and CACHE_PREFIX to .env and .env.example.
The default store is file, which keeps entries on disk under storage/framework/cache/data. Pick a different store with --driver:
npx holo install cache --driver redis
npx holo install cache --driver database--driver | Extra package | Extra setup |
|---|---|---|
file (default) | none | none |
redis | @holo-js/cache-redis | writes config/redis.ts if it is missing |
database | @holo-js/cache-db | run npx holo cache:table and npx holo migrate |
Switch drivers
If config/cache.ts already exists, the installer doesn't edit it. To switch an installed cache to another driver:
- Add that driver's store to
config/cache.ts. See Cache drivers for each store's config. - Run
npx holo install cache --driver <driver>to add its package and setup. Without the store, the command stops with an error and writes nothing. - Set
CACHE_DRIVERin.envto the new store's name. The installer keeps the value you already have, so the cache keeps using the old store until you change it.
See Cache drivers for what each store is good at.
Use the cache anywhere on the server
Import the default export from @holo-js/cache in any server code: routes, models, jobs, and listeners. Holo configures it from config/cache.ts when the app boots, so there is no setup call.
import cache from '@holo-js/cache'
await cache.put('settings.theme', 'dark', 3600)
const theme = await cache.get('settings.theme')WARNING
The cache is server-only. Don't import @holo-js/cache from client components or browser code.
Cache database queries
Query builders and models have a .cache() method, so you often don't need to call the cache directly:
import { DB } from '@holo-js/db'
const activeUsers = await DB.table('users')
.where('status', 'active')
.cache(300)
.get()Holo clears these entries automatically when you write to the users table. See Query caching.
Next steps
- Using the cache: every read and write method
- Locks: run work once across processes
- Query caching: cache query results with automatic invalidation
- Drivers: configure file, memory, Redis, and database stores