Prisma Migrateのベストプラクティス
この記事は原文から機械翻訳されています。
記事を読み込み中...
記事を読み込み中...
この記事は原文から機械翻訳されています。
データベースマイグレーションを効果的に管理することは、データ整合性を維持し、アプリケーションを円滑にデプロイするうえで極めて重要です。このガイドでは、データベーススキーマの変更をプロフェッショナルに扱うための Prisma Migrate のベストプラクティスを説明します。
Prisma Migrate は、開発者がデータベーススキーマを維持し、バージョン管理するのを支援する強力なデータベースマイグレーションツールです。Prisma スキーマへの変更に基づいて SQL マイグレーションファイルを自動生成します。
3つの相互接続されたモデルを定義する基本的な Prisma スキーマを見てみましょう:
// schema.prisma
datasource db {
provider = "postgresql"
url = env("DATABASE_URL")
}
generator client {
provider = "prisma-client-js"
}
model User {
id Int @id @default(autoincrement())
email String @unique
name String?
posts Post[]
profile Profile?
}
model Profile {
id Int @id @default(autoincrement())
bio String?
user User @relation(fields: [userId], references: [id])
userId Int @unique
}
model Post {
id Int @id @default(autoincrement())
title String
content String?
published Boolean @default(false)
author User @relation(fields: [authorId], references: [id])
authorId Int
}このスキーマで示されている主要な Prisma 機能を詳しく見ていきましょう:
このマイグレーションワークフローを段階的に分解してみましょう:
このワークフローは反復的です。テスト中に問題が見つかった場合、開発者は追加のスキーマ変更を行い、望ましい結果が得られるまで新しいマイグレーションを生成できます。
次の図は完全なマイグレーションワークフローを示しています:
この例では、ユーザーの作成日を追跡するためのタイムスタンプフィールドを追加する方法を示します:
// Original model
model User {
id Int @id @default(autoincrement())
email String @unique
name String?
}
// Adding a new field
model User {
id Int @id @default(autoincrement())
email String @unique
name String?
created DateTime @default(now())
}このスキーマ変更に関する重要なポイント:
スキーマ変更とデータ変換の両方を処理する詳細なマイグレーションスクリプトを次に示します:
// migration.ts
import { PrismaClient } from '@prisma/client'
const prisma = new PrismaClient()
async function main() {
// Update existing records with current timestamp
await prisma.user.updateMany({
data: {
created: new Date(),
},
})
// Complex data transformation for specific users
const users = await prisma.user.findMany({
where: {
email: {
contains: '@example.com'
}
}
})
for (const user of users) {
await prisma.profile.create({
data: {
userId: user.id,
bio: `Default bio for ${user.name}`
}
})
}
}
main()
.catch((e) => {
console.error(e)
process.exit(1)
})
.finally(async () => {
await prisma.$disconnect()
})このマイグレーションスクリプトは、いくつかの重要なパターンを示しています:
スキーマで enum型を管理する例を次に示します:
enum Role {
USER
ADMIN
}
model User {
id Int @id @default(autoincrement())
email String @unique
role Role @default(USER)
}
// Migration to add new role
enum Role {
USER
ADMIN
MODERATOR
}enum 変更に関する重要な考慮事項:
この例では、関連レコードを効率的に作成する方法を示します:
// Creating related records
async function createUserWithPosts() {
const user = await prisma.user.create({
data: {
email: 'user@example.com',
name: 'John Doe',
posts: {
create: [
{
title: 'First Post',
content: 'Hello World!',
published: true
},
{
title: 'Draft Post',
content: 'Work in progress...',
published: false
}
]
}
},
include: {
posts: true
}
})
console.log(user)
}このコードは、Prisma のいくつかの高度な機能を示しています:
以下は包括的なデータベースシードスクリプトです:
// seed.ts
import { PrismaClient } from '@prisma/client'
const prisma = new PrismaClient()
async function seed() {
// Clean existing data
await prisma.post.deleteMany()
await prisma.profile.deleteMany()
await prisma.user.deleteMany()
// Create new data
const alice = await prisma.user.create({
data: {
email: 'alice@prisma.io',
name: 'Alice',
profile: {
create: {
bio: 'I love databases!'
}
},
posts: {
create: [
{
title: 'Prisma Makes Database Easy',
published: true
}
]
}
}
})
console.log({ alice })
}
seed()
.catch((e) => {
console.error(e)
process.exit(1)
})
.finally(async () => {
await prisma.$disconnect()
})このシードスクリプトは、いくつかのベストプラクティスを示しています:
最後に、本番環境に対応したデプロイスクリプトを示します:
# Production deployment script
#!/bin/bash
# Backup database
pg_dump $DATABASE_URL > backup.sql
# Run migrations
npx prisma migrate deploy
# If migration fails, restore from backup
if [ $? -ne 0 ]; then
echo "Migration failed, restoring from backup..."
psql $DATABASE_URL < backup.sql
exit 1
fi
# Run seed if needed
npx prisma db seedこのデプロイスクリプトは、いくつかの重要な安全対策を実装しています:
次の監視プラクティスを実装してください:
これらのベストプラクティスに従うことで、スムーズなデータベース移行を実現し、アプリケーションのライフサイクル全体にわたってデータ整合性を維持できます。本番環境に変更を適用する前に、開発環境とステージング環境で必ず十分にテストしてください。
詳細については、 公式 Prisma ドキュメント。