Files
payloadcms/packages/db-vercel-postgres
Sasha 0a357372e9 feat(db-postgres): support read replicas (#12728)
Adds support for read replicas
https://orm.drizzle.team/docs/read-replicas that can be used to offload
read-heavy traffic.

To use (both `db-postgres` and `db-vercel-postgres` are supported):
```ts
import { postgresAdapter } from '@payloadcms/db-postgres'

database: postgresAdapter({
  pool: {
    connectionString: process.env.POSTGRES_URL,
  },
  readReplicas: [process.env.POSTGRES_REPLICA_URL],
})
```

---------

Co-authored-by: Dan Ribbens <dan.ribbens@gmail.com>
2025-06-09 19:09:52 +00:00
..
2025-06-09 14:43:03 -04:00

Payload Postgres Adapter

Vercel Postgres adapter for Payload.

Installation

npm install @payloadcms/db-vercel-postgres

Usage

Explicit Connection String

import { buildConfig } from 'payload'
import { vercelPostgresAdapter } from '@payloadcms/db-vercel-postgres'

export default buildConfig({
  db: vercelPostgresAdapter({
    pool: {
      connectionString: process.env.DATABASE_URI,
    },
  }),
  // ...rest of config
})

Automatic Connection String Detection

Have Vercel automatically detect from environment variable (typically process.env.POSTGRES_URL)

export default buildConfig({
  db: postgresAdapter(),
  // ...rest of config
})

More detailed usage can be found in the Payload Docs.