Drizzle <> AWS Data API Postgres

This guide assumes familiarity with:

Database connection basics with Drizzle
AWS Data API - website
AWS SDK - website

Step 1 - Install packages

npm

yarn

pnpm

bun

npm i drizzle-orm @aws-sdk/client-rds-data
npm i -D drizzle-kit

yarn add drizzle-orm @aws-sdk/client-rds-data
yarn add -D drizzle-kit

pnpm add drizzle-orm @aws-sdk/client-rds-data
pnpm add -D drizzle-kit

bun add drizzle-orm @aws-sdk/client-rds-data
bun add -D drizzle-kit

Step 2 - Initialize the driver and make a query

import { drizzle } from 'drizzle-orm/connect';

// These three properties are required. You can also specify
// any property from the RDSDataClient type inside the connection object.
const db = drizzle('aws-data-api-pg', { connection: {
  database: process.env['DATABASE']!,
  secretArn: process.env['SECRET_ARN']!,
  resourceArn: process.env['RESOURCE_ARN']!,
}});

await db.select().from(...);

If you need a synchronous connection, you can use our additional connection API, where you specify a driver connection and pass it to the Drizzle instance.

import { drizzle } from 'drizzle-orm/aws-data-api/pg';
import { RDSDataClient } from '@aws-sdk/client-rds-data';

const rdsClient = new RDSDataClient({ region: 'us-east-1' });

const db = drizzle(rdsClient, {
  database: process.env['DATABASE']!,
  secretArn: process.env['SECRET_ARN']!,
  resourceArn: process.env['RESOURCE_ARN']!,
});

await db.select().from(...);

What’s next?

Manage schema

Drizzle Schema PostgreSQL data types Indexes and Constraints Database Views Database Schemas Sequences Extensions

Query data

Relational Queries Select Insert Update Delete Filters Joins sql`` operator