Getting started

1. Install the package (view on npm)

   bun

   bun add drizzle-cloudflare-kv-cache-adapter

   npm

   npm i drizzle-cloudflare-kv-cache-adapter

   pnpm

   pnpm add drizzle-cloudflare-kv-cache-adapter

   drizzle-orm >= 0.44.0 is a peer dependency.

2. Bind a KV namespace in your Wrangler config:

   wrangler.toml

   [[kv_namespaces]]
   binding = "CACHE"
   id = "<your-kv-namespace-id>"

   wrangler.jsonc

   {
     "kv_namespaces": [
       {
         "binding": "CACHE",
         "id": "<your-kv-namespace-id>"
       }
     ]
   }

   Don’t have one yet? Create it:

   wrangler kv namespace create CACHE

3. Wire it into Drizzle

   import { drizzle } from 'drizzle-orm/d1'
   import { cloudflareKVCache } from 'drizzle-cloudflare-kv-cache-adapter'
   
   export default {
     async fetch(request: Request, env: Env) {
       const db = drizzle(env.DB, {
         cache: cloudflareKVCache(env.CACHE),
       })
   
       const users = await db.select().from(usersTable).$withCache()
       return Response.json(users)
     },
   }

4. Deploy

   wrangler deploy

That’s it. Continue to Usage for caching strategies and TTLs.