@pglite-utils/prisma-adapter

Prisma driver adapter for Pglite Driver.

Before you start

Before you start, make sure you have:

• Node >= 18
• Prisma CLI installed

Install

You will need to install the @pglite-utils/prisma-adapter driver adapter and the @electric-sql/pglite serverless driver.

npm install @pglite-utils/prisma-adapter @electric-sql/pglite

DATABASE URL

Set the environment to your .env file in the local environment. You can get connection information on the TiDB Cloud console.

1// .env
2DATABASE_URL="./some/path"

NOTE

The adapter only supports Prisma Client. Prisma migration and introspection are not supported, though I want to make a cli tool to help with that in the future.

Define Prisma schema

First, you need to create a Prisma schema file called schema.prisma and define the model. Here we use the user as an example.

1// schema.prisma
2generator client {
3    provider        = "prisma-client-js"
4    previewFeatures = ["driverAdapters"]
5}
6
7datasource db {
8    provider     = "pglite"
9    url          = env("DATABASE_URL")
10}
11
12// define model according to your database table
13model user {
14    id    Int     @id @default(autoincrement())
15    email String? @unique(map: "uniq_email") @db.VarChar(255)
16    name  String? @db.VarChar(255)
17}

Query

Here is an example of query:

1// query.js
2import { PGlite } from '@electric-sql/pglite';
3import { PrismaPGlite } from '@pglite-utils/prisma-adapter';
4import { PrismaClient } from '@prisma/client';
5import dotenv from 'dotenv';
6
7// setup
8dotenv.config();
9const connectionString = `${process.env.DATABASE_URL}`;
10
11// init prisma client
12const client = new PGlite(connectionString);
13const adapter = new PrismaPGlite(client);
14const prisma = new PrismaClient({ adapter });
15
16// insert
17const user = await prisma.user.create({
18    data: {
19        email: 'test@prisma.io',
20        name: 'test',
21    },
22})
23console.log(user)
24
25// query after insert
26console.log(await prisma.user.findMany())

Transaction

Here is an example of transaction:

1// query.js
2import { PGlite } from '@electric-sql/pglite';
3import { PrismaPGlite } from '@pglite-utils/prisma-adapter';
4import { PrismaClient } from '@prisma/client';
5import dotenv from 'dotenv';
6
7// setup
8dotenv.config();
9const connectionString = `${process.env.DATABASE_URL}`;
10
11// init prisma client
12const client = new PGlite(connectionString);
13const adapter = new PrismaPGlite(client);
14const prisma = new PrismaClient({ adapter });
15
16const createUser1 = prisma.user.create({
17  data: {
18    email: 'yuhang.shi@pingcap.com',
19    name: 'Shi Yuhang',
20  },
21})
22
23const createUser2 = prisma.user.create({
24  data: {
25    email: 'yuhang.shi@pingcap.com',
26    name: 'Shi Yuhang2',
27  },
28})
29
30const createUser3 = prisma.user.create({
31  data: {
32    email: 'yuhang2.shi@pingcap.com',
33    name: 'Shi Yuhang2',
34  },
35})
36try {
37  await prisma.$transaction([createUser1, createUser2]) // Operations fail together
38} catch (e) {
39  console.log(e)
40  await prisma.$transaction([createUser1, createUser3]) // Operations succeed together
41}