Prisma Migrate 最佳实践
本文由原文机器翻译。
正在加载文章...
正在加载文章...
本文由原文机器翻译。
有效管理数据库迁移对于维护数据完整性和实现顺畅的应用部署至关重要。本指南介绍使用 Prisma Migrate 专业地处理数据库架构变更的最佳实践。
Prisma Migrate 是一个强大的数据库迁移工具,可帮助开发者维护数据库架构并对其进行版本控制。它会根据 Prisma schema 的变更自动生成 SQL 迁移文件。
让我们来看一个定义了三个相互关联模型的基础 Prisma schema:
// 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
}让我们详细探讨此 schema 中展示的关键 Prisma 特性:
让我们逐步拆解此迁移工作流:
该工作流是迭代式的——如果在测试期间发现问题,开发者可以进行额外的 schema 变更并生成新的迁移,直到达到预期结果。
下图展示了完整的迁移工作流:
此示例演示添加一个时间戳字段来跟踪用户创建日期:
// 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())
}关于此 schema 变更的关键点:
以下是一个详细的迁移脚本,它同时处理 schema 变更和数据转换:
// 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()
})此迁移脚本演示了几个重要模式:
以下是在 schema 中管理枚举类型的示例:
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
}枚举变更的重要注意事项:
此示例展示了如何高效地创建关联记录:
// 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 文档。