Drizzle <> MSSQL

This guide assumes familiarity with:

Database connection basics with Drizzle
node-mssql basics

Drizzle has native support for MSSQL connections with the mssql driver.

Step 1 - Install packages

npm

yarn

pnpm

bun

npm i drizzle-orm@rc mssql
npm i -D drizzle-kit@rc

yarn add drizzle-orm@rc mssql
yarn add -D drizzle-kit@rc

pnpm add drizzle-orm@rc mssql
pnpm add -D drizzle-kit@rc

bun add drizzle-orm@rc mssql
bun add -D drizzle-kit@rc

Step 2 - Initialize the driver and make a query

mssql

mssql with config

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

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

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

const db = drizzle({
  connection: process.env.DATABASE_URL,
});
 
const result = await db.execute('select 1');

IMPORTANT

As long as the node-mssql driver requires await on Pool initialization, we need to await it before each request - unless you are providing your own Pool instance to Drizzle. In that case, when you want to access db.$client, you first need to await it, and then use it

const awaitedClient = await db.$client.$instance();
const response = awaitedClient.query...;

If you need to provide your existing driver:

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

const pool = await connect(process.env.DATABASE_URL!);
const db = drizzle({ client: pool });
 
const result = await db.execute('select 1');

What’s next?

Manage schema

Drizzle Schema MSSQL data types Indexes and Constraints Drizzle Relations

Query data

Select Insert Update Delete Filters Joins sql`` operator