Prismaを使用してOceanBaseデータベースに接続する|OceanBaseデータベース|ドキュメント|OceanBaseマニュアル

適用対象

PrismaはOceanBaseデータベースのMySQLモードで動作します。

Prismaは、型安全性のあるデータベースアクセスを提供する、現代的なデータベースツールキットです。本記事では、Prismaを使用してOceanBaseデータベースのMySQLモードに接続する方法について説明します。

前提条件

Node.js 14.0.0以降がインストール済みであること。
npmまたはyarnパッケージマネージャーがインストールされていること。
OceanBaseデータベースがデプロイ済みで、MySQLモードのテナントが作成されていること。

手順

Node.jsとnpmのバージョンを確認する
必要な依存関係をインストールする
OceanBaseデータベースの接続情報を取得する
プロジェクトを作成して設定する
サンプルプログラムを実行する

ステップ１：Node.jsとnpmのバージョンを確認する

ターミナルを開き、以下のコマンドを実行してNode.jsとnpmのバージョンを確認します：

node -v
npm -v

ステップ2：必要な依存関係をインストールする

プロジェクトディレクトリを作成して初期化します：

mkdir prisma-oceanbase-demo
cd prisma-oceanbase-demo
npm init -y
npm install prisma @prisma/client

Prismaを初期化します：

npx prisma init --datasource-provider mysql

イニシャライズが完了すると、以下の出力が表示されます：

✔ Your Prisma schema was created at prisma/schema.prisma
  You can now open it in your favorite editor.

Next steps:
1. Set the DATABASE_URL in the .env file to point to your existing database.
2. Run prisma db pull to turn your database schema into a Prisma schema.
3. Run prisma generate to generate the Prisma Client.
4. Start querying your database with Prisma Client.

More information in our documentation:
https://pris.ly/d/getting-started

環境変数を設定します：

イニシャライズ後、Prismaは自動的に.envファイルとprisma/schema.prismaファイルを作成します。.envファイルを編集し、OceanBaseデータベースの接続情報を設定します：
```
# .env
DATABASE_URL="mysql://username:password@host:port/database?schema=public"
```
注意
- username、password、host、port および database をご自身のOceanBaseデータベース接続情報に置き換えてください。
- schema パラメータがデータベーススキーマ名と一致していることを確認してください。
- SSL接続を使用する場合は、?sslmode=requireパラメータを追加する必要があります。
データベーススキーマを取得します（データベースにテーブルが既に存在する場合）：
```
npx prisma db pull
```
このコマンドは、既存のデータベースからテーブル構造を取得し、prisma/schema.prismaファイルを更新します。
Prismaクライアントを生成します：
```
npx prisma generate
```
このコマンドはprisma/schema.prismaファイルを読み込み、対応するTypeScript型定義とPrismaクライアントコードを生成します。
データベース移行を作成します（新規プロジェクトのみ適用）：
```
npx prisma migrate dev --name init
```
新規プロジェクトの場合、このコマンドを使用して以下を行います：
- 移行ファイルの作成
- データベースへの移行の適用
- Prismaクライアントの再生成
注意

db pull コマンドで既存データベースからテーブル構造を取得済みの場合は、この手順を実行する必要はありません。

ステップ3：データ操作の例

このセクションでは、Prismaを使用して基本的なデータ操作を行う方法を示します。具体的には、usersテーブルのデータを挿入し、クエリする方法です。

1. Prismaクライアントの初期化

まず、プロジェクトのルートディレクトリに index.js ファイルを作成し、以下のコードを追加します：

const { PrismaClient } = require('@prisma/client')
const prisma = new PrismaClient()

async function main() {
  // 1. Create a new user
  const newUser = await prisma.users.create({
    data: {
      username: 'ambermoe',
      email: 'amber@example.com',
      password_hash: 'hashed_password_here',  // Use bcrypt for password hashing in production
    },
  })
  console.log('User created successfully:', newUser)

  // 2. Query user
  const user = await prisma.users.findUnique({
    where: {
      email: 'amber@example.com',
    },
  })
  console.log('Retrieved user:', user)
}

main()
  .catch((e) => {
    console.error('Error:', e)
    process.exit(1)
  })
  .finally(async () => {
    await prisma.$disconnect()
  })

2. サンプルコードの実行

以下の手順が完了していることを確認してください：

prisma/schema.prisma に users テーブルモデルが正しく定義されていること。
新規プロジェクトの場合は、データベースマイグレーションを適用します：
```
npx prisma migrate dev --name init
```
既存のデータベースからテーブル構造を取得した場合は、この手順をスキップできます。
Prisma Clientの生成：
```
npx prisma generate
```
サンプルコードの実行：
```
node index.js
```

実行後、コンソールに新規作成されたユーザー情報とクエリされたユーザー情報が表示されます。

User created successfully: {
  id: 2,
  username: 'ambermoe',
  email: 'amber@example.com',
  password_hash: 'hashed_password_here',
  created_at: 2025-06-04T03:40:43.000Z,
  updated_at: 2025-06-04T03:40:43.000Z
}
Retrieved user: {
  id: 2,
  username: 'ambermoe',
  email: 'amber@example.com',
  password_hash: 'hashed_password_here',
  created_at: 2025-06-04T03:40:43.000Z,
  updated_at: 2025-06-04T03:40:43.000Z
}

説明

実際のプロジェクトでは、以下を確認してください：

パスワードは暗号化処理（例：bcryptの使用）を施す必要があります。
発生する可能性のあるエラー状況を処理します。
環境変数を使用してデータベース接続情報を管理します。
適切な入力検証を追加します。