@prisma/adapter-mariadb

@prisma/adapter-mariadb

This package contains the driver adapter for Prisma ORM that enables usage of the mariadb database driver for MariaDB and MySQL databases.

mariadb is the official MariaDB connector for Node.js, providing high-performance access to MariaDB and MySQL databases. It can be used with any MariaDB or MySQL database that's accessed via TCP, including cloud-hosted instances.

Usage

This section explains how you can use it with Prisma ORM and the @prisma/adapter-mariadb driver adapter. Be sure that the DATABASE_URL environment variable is set to your MariaDB/MySQL connection string (e.g. in a .env file).

1. Enable the driverAdapters Preview feature flag

Since driver adapters are currently in Preview, you need to enable its feature flag on the datasource block in your Prisma schema:

// schema.prisma
generator client {
  provider        = "prisma-client-js"
  previewFeatures = ["driverAdapters"]
}

datasource db {
  provider = "mysql"
  url      = env("DATABASE_URL")
}

Once you have added the feature flag to your schema, re-generate Prisma Client:

npx prisma generate

2. Install the dependencies

Next, install the MariaDB Prisma ORM driver adapter:

npm install @prisma/adapter-mariadb

3. Instantiate Prisma Client using the driver adapter

import { PrismaMariaDb } from '@prisma/adapter-mariadb'
import { PrismaClient } from '@prisma/client'

const adapter = new PrismaMariaDb({
  host: 'localhost', // your database host
  user: 'your_username', // your database username
  password: 'your_password', // your database password
  database: 'your_database', // optional, your database name
})
const prisma = new PrismaClient({ adapter })

Feedback

We encourage you to create an issue if you find something missing or run into a bug.

If you have any feedback, leave a comment in this GitHub discussion.