npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@tidbcloud/prisma-adapter

v5.20.0

Published

Prisma's driver adapter for "@tidbcloud/serverless"

Downloads

428

Readme

@tidbcloud/prisma-adapter

Prisma driver adapter for TiDB Cloud Serverless Driver. For more details, see TiDB Cloud Serverless Driver Prisma Tutorial .

Before you start

Before you start, make sure you have:

  • A TiDB Cloud account
  • Node >= 18
  • Prisma CLI installed

Install

You will need to install the @tidbcloud/prisma-adapter driver adapter and the @tidbcloud/serverless serverless driver.

npm install @tidbcloud/prisma-adapter @tidbcloud/serverless

DATABASE URL

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

// .env
DATABASE_URL="mysql://username:password@host:4000/database?sslaccept=strict"

NOTE

The adapter only supports Prisma Client. Prisma migration and introspection still go through the traditional TCP way. If you only need Prisma Client, you can set the DATABASE_URL as the mysql://username:password@host/database format which port and ssl parameters are not needed).

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.

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

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

// define model according to your database table
model user {
    id    Int     @id @default(autoincrement())
    email String? @unique(map: "uniq_email") @db.VarChar(255)
    name  String? @db.VarChar(255)
}

Query

Here is an example of query:

// query.js
import { connect } from '@tidbcloud/serverless';
import { PrismaTiDBCloud } from '@tidbcloud/prisma-adapter';
import { PrismaClient } from '@prisma/client';
import dotenv from 'dotenv';

// setup
dotenv.config();
const connectionString = `${process.env.DATABASE_URL}`;

// init prisma client
const connection = connect({ url: connectionString });
const adapter = new PrismaTiDBCloud(connection);
const prisma = new PrismaClient({ adapter });

// insert
const user = await prisma.user.create({
    data: {
        email: '[email protected]',
        name: 'test',
    },
})
console.log(user)

// query after insert
console.log(await prisma.user.findMany())

Transaction

Here is an example of transaction:

// query.js
import { connect } from '@tidbcloud/serverless';
import { PrismaTiDBCloud } from '@tidbcloud/prisma-adapter';
import { PrismaClient } from '@prisma/client';
import dotenv from 'dotenv';

// setup
dotenv.config();
const connectionString = `${process.env.DATABASE_URL}`;

// init prisma client
const connection = connect({ url: connectionString });
const adapter = new PrismaTiDBCloud(connection);
const prisma = new PrismaClient({ adapter });

const createUser1 = prisma.user.create({
  data: {
    email: '[email protected]',
    name: 'Shi Yuhang',
  },
})

const createUser2 = prisma.user.create({
  data: {
    email: '[email protected]',
    name: 'Shi Yuhang2',
  },
})

const createUser3 = prisma.user.create({
  data: {
    email: '[email protected]',
    name: 'Shi Yuhang2',
  },
})
try {
  await prisma.$transaction([createUser1, createUser2]) // Operations fail together
} catch (e) {
  console.log(e)
  await prisma.$transaction([createUser1, createUser3]) // Operations succeed together
}

Choose a version

| Adapter | Prisma/Prisma Client | serverless driver | |---------|----------------------|-------------------| | v5.4.x | v5.4.x | [v0.0.6, v0.1.0) | | v5.5.x | v5.5.x | [v0.0.7, v0.1.0) | | v5.6.x | v5.6.x | [v0.0.7, v0.1.0) | | v5.7.x | v5.7.x | [v0.0.7, v0.1.0) | | v5.8.x | v5.8.x | [v0.0.9, v0.1.0) | | v5.9.x | v5.9.x | [v0.0.9, v0.1.0) | | v5.10.x | v5.10.x | >= v0.1.0 | | v5.11.x | v5.11.x | >= v0.1.0 | | v5.12.x | v5.12.x | >= v0.1.0 | | v5.13.x | v5.13.x | >= v0.1.0 | | v5.14.x | v5.14.x | >= v0.1.0 | | v5.15.x | v5.15.x | >= v0.1.0 | | v5.20.x | v5.20.x | >= v0.1.0 |

Here is the step to step guide for how to choose the version:

  1. Choose the Prisma version: Choose the one as you need.
  2. Choose the adapter version: If you are using Prisma vx.y.z, you can choose the latest adapter version in vx.y. Open an issue once you find the adapter version is not compatible with Prisma version.
  3. Choose the serverless driver version: You can always use the latest version according to the table above.

Limitations