Drizzle <> PostgreSQL

This guide assumes familiarity with:

Database connection basics with Drizzle
gel-js basics

Drizzle has native support for Gel connections with the gel-js client.

Step 1 - Install packages

npm

yarn

pnpm

bun

npm i drizzle-orm gel
npm i -D drizzle-kit

yarn add drizzle-orm gel
yarn add -D drizzle-kit

pnpm add drizzle-orm gel
pnpm add -D drizzle-kit

bun add drizzle-orm gel
bun add -D drizzle-kit

Step 2 - Initialize the driver and make a query

gel

gel with config

// Make sure to install the 'gel' package 
import { drizzle } from 'drizzle-orm/gel';

const db = drizzle(process.env.DATABASE_URL);
 
const result = await db.execute('select 1');

// Make sure to install the 'gel' package
import { drizzle } from "drizzle-orm/gel";

// You can specify any property from the gel connection options
const db = drizzle({
  connection: {
    dsn: process.env.DATABASE_URL,
    tlsSecurity: "default",
  },
});

const result = await db.execute("select 1");

If you need to provide your existing driver:

// Make sure to install the 'gel' package 
import { drizzle } from "drizzle-orm/gel";
import { createClient } from "gel";

const gelClient = createClient();
const db = drizzle({ client: gelClient });

const result = await db.execute('select 1');

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