MySQL

Preview Feature

MySQL support is in preview and may be subject to breaking changes in future releases.

Installing driver

npm

npm install mysql2

pnpm

pnpm add mysql2

bun

bun add mysql2

yarn

yarn add mysql2

Creating ZenStackClient

import { schema } from './zenstack/schema';
import { createPool } from 'mysql2';
import { ZenStackClient } from '@zenstackhq/orm';
import { MysqlDialect } from '@zenstackhq/orm/dialects/mysql';

const db = new ZenStackClient(schema, {
  dialect: new MysqlDialect({
    pool: createPool(process.env.DATABASE_URL),
  }),
});