TiDB Cloud
TiDB Self-Managed
Learning Center
お問い合わせ

TiDB CloudサーバーレスDriverPrisma チュートリアル

プリズマはオープンソースの次世代 ORM (オブジェクト リレーショナル マッピング) であり、開発者が直感的、効率的、かつ安全な方法でデータベースを操作できるようにします。TiDB TiDB Cloud は@tidbcloud/プリズマアダプタ提供し、 TiDB Cloudサーバーレス ドライバーで HTTPS 経由でプリズマクライアント使用できます。従来の TCP 方式と比較して、 @tidbcloud/プリズマアダプタは次の利点があります。

  • サーバーレス環境での Prisma Client のパフォーマンスが向上
  • エッジ環境で Prisma Client を使用する機能

このチュートリアルでは、サーバーレス環境とエッジ環境で@tidbcloud/プリズマアダプタ使用する方法について説明します。

インストール

@tidbcloud/プリズマアダプタとTiDB Cloudサーバーレス ドライバー両方をインストールする必要があります。 ネプまたはお好みのパッケージ マネージャーを使用してインストールできます。

npm を例にとると、インストールには次のコマンドを実行できます。

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

driverAdapters有効にする

Prisma アダプターを使用するには、 schema.prismaファイルのdriverAdapters機能を有効にする必要があります。例:

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

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

Prismaクライアントを初期化する

Prisma Client を使用する前に、 @tidbcloud/prisma-adapterで初期化する必要があります。例:

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

// Initialize Prisma Client
const connection = connect({ url: ${DATABASE_URL} });
const adapter = new PrismaTiDBCloud(connection);
const prisma = new PrismaClient({ adapter });

その後、Prisma Client からのクエリをTiDB Cloudサーバーレス ドライバーに送信して処理することができます。

Node.js環境でPrismaアダプターを使用する

このセクションでは、Node.js 環境で@tidbcloud/prisma-adapter使用する方法の例を示します。

始める前に

このチュートリアルを完了するには、次のものが必要です。

ステップ1. プロジェクトを作成する

  1. prisma-exampleという名前のプロジェクトを作成します。

    mkdir prisma-example
cd prisma-example

  2. @tidbcloud/prisma-adapterドライバー アダプター、 @tidbcloud/serverlessサーバーレス ドライバー、および Prisma CLI をインストールします。

    次のコマンドは、パッケージ マネージャーとして npm を使用します。1 npm install @tidbcloud/serverless実行すると、プロジェクト ディレクトリにnode_modulesディレクトリとpackage.jsonファイルが作成されます。

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

  3. package.jsonファイルで、 type: "module"を追加して ES モジュールを指定します。

    {
  "type": "module",
  "dependencies": {
    "@prisma/client": "^5.5.2",
    "@tidbcloud/prisma-adapter": "^5.5.2",
    "@tidbcloud/serverless": "^0.0.7"
  },
  "devDependencies": {
    "prisma": "^5.5.2"
  }
}

ステップ2. 環境を設定する

  1. TiDB Cloud Serverless クラスターの概要ページで、右上隅の[接続]をクリックし、表示されるダイアログからデータベースの接続文字列を取得します。接続文字列は次のようになります。

    mysql://[username]:[password]@[host]:4000/[database]?sslaccept=strict

  2. プロジェクトのルート ディレクトリに.envという名前のファイルを作成し、次のようにDATABASE_URLという名前の環境変数を定義して、この変数内のプレースホルダー[]接続文字列内の対応するパラメーターに置き換えます。

    DATABASE_URL='mysql://[username]:[password]@[host]:4000/[database]?sslaccept=strict'

    注記：

    @tidbcloud/prisma-adapter HTTPS 経由の Prisma Client の使用のみをサポートします。 プリズマ移行およびプリズマ イントロスペクションでは、従来の TCP 接続が引き続き使用されます。 Prisma Client のみを使用する必要がある場合は、 DATABASE_URL mysql://[username]:[password]@[host]/[database]形式に簡略化できます。

  3. .envファイルから環境変数を読み込むにはdotenvインストールします。

    npm install dotenv

ステップ3. スキーマを定義する

  1. schema.prismaという名前のファイルを作成します。このファイルには、 driverAdaptersプレビュー機能を含め、 DATABASE_URL環境変数を参照します。次にファイルの例を示します。

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

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

  2. schema.prismaファイルで、データベース テーブルのデータ モデルを定義します。次の例では、 userという名前のデータ モデルが定義されています。

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

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

// define a data 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)
}

  3. データベースを Prisma スキーマと同期します。TiDB TiDB Cloud Serverless クラスターにデータベース テーブルを手動で作成することも、次のように Prisma CLI を使用して自動的に作成することもできます。

    npx prisma db push

    このコマンドは、 @tidbcloud/prisma-adapter使用した HTTPS 接続ではなく、従来の TCP 接続を介してTiDB Cloud Serverless クラスターにuserテーブルを作成します。これは、Prisma Migrate と同じエンジンを使用するためです。このコマンドの詳細については、 スキーマのプロトタイプを作成する参照してください。

  4. Prisma クライアントを生成します:

    npx prisma generate

    このコマンドは、Prisma スキーマに基づいて Prisma クライアントを生成します。

ステップ4. CRUD操作を実行する

  1. hello-word.jsという名前のファイルを作成し、次のコードを追加して Prisma Client を初期化します。

    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}`;

// Initialize Prisma Client
const connection = connect({ url: connectionString });
const adapter = new PrismaTiDBCloud(connection);
const prisma = new PrismaClient({ adapter });

  2. Prisma Client を使用していくつかの CRUD 操作を実行します。例:

    // Insert
const user = await prisma.user.create({
  data: {
    email: 'test@pingcap.com',
    name: 'test',
  },
})
console.log(user)

// Query
console.log(await prisma.user.findMany())

// Delete
await prisma.user.delete({
   where: {
      id: user.id,
   },
})

  3. Prisma Client を使用していくつかのトランザクション操作を実行します。例:

    const createUser1 = prisma.user.create({
  data: {
    email: 'test1@pingcap.com',
    name: 'test1',
  },
})
const createUser2 = prisma.user.create({
  data: {
    email: 'test1@pingcap.com',
    name: 'test1',
  },
})
const createUser3 = prisma.user.create({
  data: {
    email: 'test2@pingcap.com',
    name: 'test2',
  },
})

try {
  await prisma.$transaction([createUser1, createUser2]) // Operations fail because the email address is duplicated
} catch (e) {
  console.log(e)
}

try {
  await prisma.$transaction([createUser2, createUser3]) // Operations success because the email address is unique
} catch (e) {
  console.log(e)
}

エッジ環境でPrismaアダプターを使用する

Vercel Edge FunctionsやCloudflare Workersなどのエッジ環境では、 @tidbcloud/prisma-adapter v5.11.0以降のバージョンを使用できます。

このページは役に立ちましたか？