@xata.io/drizzle

A Drizzle driver for Xata, using the Xata serverless driver for TypeScript.

The goal of this package is polish the implementation and contribute it back to the official Drizzle repository.

Installation

You should install both drizzle-orm and @xata.io/drizzle with @xata.io/client. You can install them with your favorite package manager:

# with bun
bun install drizzle-orm @xata.io/drizzle @xata.io/client

# with pnpm
pnpm add drizzle-orm @xata.io/drizzle @xata.io/client

# with yarn
yarn add drizzle-orm @xata.io/drizzle @xata.io/client

# with npm
npm install drizzle-orm @xata.io/drizzle @xata.io/client

Usage

To work with drizzle you need to define your models and then create a drizzle instance with the models.

import { drizzle } from '@xata.io/drizzle';
import { sql } from 'drizzle-orm';
import { pgTable, text } from 'drizzle-orm/pg-core';
import { getXataClient } from './xata';

const xata = getXataClient();

const drivers = pgTable('drivers', {
  id: text('id').primaryKey(),
  surname: text('surname'),
  forename: text('forename'),
  nationality: text('nationality')
});

const schema = {
  drivers
};

const db = drizzle(xata, { schema });

const result = await db.execute(sql`select * from ${drivers} where ${drivers.nationality} = 'Spanish'`);

[Experimental] Model generation

We offer an experimental model generation helper that will generate the models for you from your tables array in your xata.ts file. Since it's a work in progress, we don't recommend using it in your applications yet, please build your models manually. However, we would love to hear your feedback on it.

import { drizzle, buildModels } from '@xata.io/drizzle';
import { sql } from 'drizzle-orm';
import { pgTable, text } from 'drizzle-orm/pg-core';
import { getXataClient, tables } from './xata';

const xata = getXataClient();

const schema = buildModels(tables);
const { drivers } = schema;

const db = drizzle(xata, { schema });

const result = await db.execute(sql`select * from ${drivers} where ${drivers.nationality} = 'Spanish'`);

Limitations

• Migrations from drizzle are not supported yet, we will add them once the SQL endpoint allows it.
• Transactions are not supported yet, we will add them once the SQL endpoint allows it.