Drizzle <> Appwrite MySQL

Appwrite offers dedicated, native MySQL databases that you connect to directly over TLS. There is no Appwrite-specific driver or abstraction layer, so you can use Drizzle with the mysql2 driver through the drizzle-orm/mysql2 package, the same way you would with any MySQL server.

To get your connection string, open your database in the Appwrite Console and click Credentials, or fetch it from the Appwrite API with mysql.get(). The username is admin.<hash>, where the hash matches the one in the hostname, and the database name is always default. Appwrite’s proxy routes your connection by this username, so always use the full value from the connection string.

DATABASE_URL="mysql://admin.<hash>:<password>@db-<hash>.<region>.appwrite.center:3306/default?ssl=true"

Step 1 - Install packages

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

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

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

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

Step 2 - Initialize the driver and make a query

import { drizzle } from "drizzle-orm/mysql2";

const db = drizzle(process.env.DATABASE_URL);

const response = await db.select().from(...)

import { drizzle } from "drizzle-orm/mysql2";

// You can specify any property from the mysql2 connection options
const db = drizzle({ connection: { uri: process.env.DATABASE_URL, ssl: { rejectUnauthorized: true } } });

const response = await db.select().from(...)

If you need to provide your existing driver:

import { drizzle } from "drizzle-orm/mysql2";
import mysql from "mysql2/promise";

const connection = await mysql.createConnection(process.env.DATABASE_URL);

const db = drizzle({ client: connection });

import { drizzle } from "drizzle-orm/mysql2";
import mysql from "mysql2/promise";

const poolConnection = mysql.createPool({
  uri: process.env.DATABASE_URL,
});

const db = drizzle({ client: poolConnection });

Connection pooling for serverless

Appwrite runs a connection pooler on port 6033 of the same hostname. In serverless and edge environments, route your application traffic through the pooler so short-lived instances don’t exhaust the engine’s connection limit, and keep Drizzle Kit pointed at the direct engine port 3306, because migrations issue DDL that needs a session-level connection.

# Runtime: pooled, transaction mode
DATABASE_URL="mysql://admin.<hash>:<password>@db-<hash>.<region>.appwrite.center:6033/default?ssl=true"

# Migrations & introspection: direct connection to the engine
DIRECT_URL="mysql://admin.<hash>:<password>@db-<hash>.<region>.appwrite.center:3306/default?ssl=true"

import { defineConfig } from 'drizzle-kit';

export default defineConfig({
  dialect: 'mysql',
  schema: './src/schema.ts',
  out: './drizzle',
  dbCredentials: {
    url: process.env.DIRECT_URL!,
  },
});

The pooler defaults to transaction mode, which does not keep a backend connection across statements. Drizzle’s regular query builder sends text queries and works with transaction pooling, but session-level features such as explicit prepared queries, user variables and temporary tables need the direct port or a session-mode pooler.

What’s next?