模式不兼容性
概览
本页的每个部分都描述了从 Prisma 1 升级到 Prisma ORM 2.x 及更高版本时可能遇到的问题,并解释了可用的解决方法。
默认值未在数据库中表示
问题
在 Prisma 1 数据模型中添加 @default
指令时,该字段的默认值由 Prisma 1 服务器在运行时生成。数据库列没有添加 DEFAULT
约束。由于此约束未在数据库本身中体现,Prisma ORM 2.x 及更高版本的内省无法识别它。
示例
Prisma 1 数据模型
type Post {
id: ID! @id
published: Boolean @default(value: false)
}
Prisma 1 生成的 SQL 迁移
CREATE TABLE "Post" (
id VARCHAR(25) PRIMARY KEY NOT NULL,
published BOOLEAN NOT NULL
);
在 Prisma ORM 2.x 及更高版本中内省的结果
model Post {
id String @id
published Boolean
}
由于在使用 prisma deploy
将 Prisma 1 数据模型映射到数据库时未将 DEFAULT
约束添加到数据库,Prisma ORM v2(及更高版本)在内省时无法识别它。
解决方法
手动为数据库列添加 DEFAULT
约束
您可以修改列以添加 DEFAULT
约束,如下所示
ALTER TABLE "Post"
ALTER COLUMN published SET DEFAULT false;
进行此调整后,您可以重新内省数据库,@default
属性将添加到 published
字段。
model Post {
id String @id
published Boolean @default(false)
}
手动为 Prisma 模型添加 @default
属性
您可以将 @default
属性添加到 Prisma 模型
model Post {
id String
published Boolean @default(false)
}
如果在 Prisma schema 中设置了 @default
属性并运行 prisma generate
,生成的 Prisma Client 代码将在运行时生成指定的默认值(类似于 Prisma 1 服务器在 Prisma 1 中所做的)。
生成的 CUID 作为 ID 值未在数据库中表示
问题
Prisma 1 会为带有 @id
指令的 ID
字段自动生成 CUID 作为 ID 值。这些 CUID 由 Prisma 1 服务器在运行时生成。由于此行为未在数据库本身中体现,Prisma ORM 2.x 及更高版本的内省无法识别它。
示例
Prisma 1 数据模型
type Post {
id: ID! @id
}
Prisma 1 生成的 SQL 迁移
CREATE TABLE "Post" (
id VARCHAR(25) PRIMARY KEY NOT NULL
);
在 Prisma ORM 2.x 及更高版本中内省的结果
model Post {
id String @id
}
由于数据库中没有关于 CUID 行为的指示,Prisma ORM 的内省无法识别它。
解决方法
作为解决方法,您可以手动为 Prisma 模型添加 @default(cuid())
属性
model Post {
id String @id @default(cuid())
}
如果在 Prisma schema 中设置了 @default
属性并运行 prisma generate
,生成的 Prisma Client 代码将在运行时生成指定的默认值(类似于 Prisma 1 服务器在 Prisma 1 中所做的)。
请注意,您需要在每次内省后重新添加该属性,因为内省会将其删除(因为之前的 Prisma schema 会被覆盖)!
@createdAt
未在数据库中表示
问题
Prisma 1 会为带有 @createdAt
指令的 DateTime
字段自动生成值。这些值由 Prisma 1 服务器在运行时生成。由于此行为未在数据库本身中体现,Prisma ORM 2.x 及更高版本的内省无法识别它。
示例
Prisma 1 数据模型
type Post {
id: ID! @id
createdAt: DateTime! @createdAt
}
Prisma 1 生成的 SQL 迁移
CREATE TABLE "Post" (
id VARCHAR(25) PRIMARY KEY NOT NULL,
"createdAt" TIMESTAMP NOT NULL
);
在 Prisma ORM 2.x 及更高版本中内省的结果
model Post {
id String @id
createdAt DateTime
}
解决方法
手动为数据库列添加 DEFAULT CURRENT_TIMESTAMP
您可以修改列以添加 DEFAULT
约束,如下所示
ALTER TABLE "Post"
ALTER COLUMN "createdAt" SET DEFAULT CURRENT_TIMESTAMP;
进行此调整后,您可以重新内省数据库,@default
属性将添加到 createdAt
字段。
model Post {
id String
createdAt DateTime @default(now())
}
手动为 Prisma 模型添加 @default(now())
属性
作为解决方法,您可以手动为 Prisma 模型添加 @default(now())
属性
model Post {
id String @id
createdAt DateTime @default(now())
}
如果在 Prisma schema 中设置了 @default
属性并运行 prisma generate
,生成的 Prisma Client 代码将在运行时生成指定的默认值(类似于 Prisma 1 服务器在 Prisma 1 中所做的)。
请注意,您需要在每次内省后重新添加该属性,因为内省会将其删除(因为之前的 Prisma schema 会被覆盖)!
@updatedAt
未在数据库中表示
问题
Prisma 1 会为带有 @updatedAt
指令的 DateTime
字段自动生成值。这些值由 Prisma 1 服务器在运行时生成。由于此行为未在数据库本身中体现,Prisma ORM 2.x 及更高版本的内省无法识别它。
示例
Prisma 1 数据模型
type Post {
id: ID! @id
updatedAt: DateTime! @updatedAt
}
Prisma 1 生成的 SQL 迁移
CREATE TABLE "Post" (
id VARCHAR(25) PRIMARY KEY NOT NULL,
updatedAt TIMESTAMP
);
在 Prisma ORM 2.x 及更高版本中内省的结果
model Post {
id String @id
updatedAt DateTime
}
解决方法
手动为 Prisma 模型添加 @updatedAt
属性
作为解决方法,您可以手动为 Prisma 模型添加 @updatedAt
属性
model Post {
id String @id
updatedAt DateTime @updatedAt
}
如果在 Prisma schema 中设置了 @updatedAt
属性并运行 prisma generate
,生成的 Prisma Client 代码将在更新现有记录时自动为此列生成值(类似于 Prisma 1 服务器在 Prisma 1 中所做的)。
请注意,您需要在每次内省后重新添加该属性,因为内省会将其删除(因为之前的 Prisma schema 会被覆盖)!
内联 1-1 关系被识别为 1-n(缺少 UNIQUE
约束)
问题
在 Prisma ORM v1.31 中引入的数据模型 v1.1 中,1-1 关系可以声明为*内联*。在这种情况下,关系将不通过关系表维护,而是通过其中一个表上的单个外键维护。
使用此方法时,Prisma ORM 不会向外键列添加 UNIQUE
约束,这意味着在 Prisma ORM 2.x 及更高版本中进行内省后,这种之前的 1-1 关系将被添加到 Prisma schema 中作为 1-n 关系。
示例
Prisma ORM 数据模型 v1.1(Prisma ORM v1.31 及更高版本可用)
type User {
id: ID! @id
profile: Profile @relation(link: INLINE)
}
type Profile {
id: ID! @id
user: User
}
请注意,在这种情况下省略 @relation
指令会得到相同的行为,因为 link: INLINE
是 1-1 关系的*默认*值。
Prisma 1 生成的 SQL 迁移
CREATE TABLE "User" (
id VARCHAR(25) PRIMARY KEY NOT NULL
);
CREATE TABLE "Profile" (
id VARCHAR(25) PRIMARY KEY NOT NULL,
"user" VARCHAR(25),
FOREIGN KEY ("user") REFERENCES "User"(id)
);
在 Prisma ORM 2.x 及更高版本中内省的结果
model User {
id String @id
Profile Profile[]
}
model Profile {
id String @id
user String?
User User? @relation(fields: [user], references: [id])
}
由于 user
列(代表此关系中的外键)上没有定义 UNIQUE
约束,Prisma ORM 的内省将其识别为 1-n 关系。
解决方法
手动为外键列添加 UNIQUE
约束
您可以修改外键列以添加 UNIQUE
约束,如下所示
ALTER TABLE "Profile"
ADD CONSTRAINT userId_unique UNIQUE ("user");
进行此调整后,您可以重新内省数据库,1-1 关系将被正确识别。
model User {
id String @id
Profile Profile?
}
model Profile {
id String @id
user String? @unique
User User? @relation(fields: [user], references: [id])
}
所有非内联关系都被识别为 m-n
问题
Prisma 1 大多数时候将关系表示为关系表
- Prisma 1 数据模型 v1.0 中的所有关系都表示为关系表
- 在数据模型 v1.1 中,所有 m-n 关系以及声明为
link: TABLE
的 1-1 和 1-n 关系都表示为关系表。
由于这种表示方式,Prisma ORM 2.x 及更高版本的内省将识别所有这些关系为 m-n 关系,即使它们在 Prisma 1 中可能被声明为 1-1 或 1-n。
示例
Prisma 1 数据模型
type User {
id: ID! @id
posts: [Post!]!
}
type Post {
id: ID! @id
author: User! @relation(link: TABLE)
}
Prisma 1 生成的 SQL 迁移
CREATE TABLE "User" (
id VARCHAR(25) PRIMARY KEY NOT NULL
);
CREATE TABLE "Post" (
id VARCHAR(25) PRIMARY KEY NOT NULL
);
CREATE TABLE "_PostToUser" (
"A" VARCHAR(25) NOT NULL REFERENCES "Post"(id) ON DELETE CASCADE,
"B" VARCHAR(25) NOT NULL REFERENCES "User"(id) ON DELETE CASCADE
);
CREATE UNIQUE INDEX "_PostToUser_AB_unique" ON "_PostToUser"("A" text_ops,"B" text_ops);
CREATE INDEX "_PostToUser_B" ON "_PostToUser"("B" text_ops);
在 Prisma ORM 2.x 及更高版本中内省的结果
model User {
id String @id
Post Post[] @relation(references: [id])
}
model Post {
id String @id
User User[] @relation(references: [id])
}
由于 Prisma 1 创建的关系表使用的关系表约定与 Prisma ORM 2.x 及更高版本中的约定相同,因此该关系现在被识别为 m-n 关系。
解决方法
作为解决方法,您可以将数据迁移到与 Prisma ORM 的 1-n 关系兼容的结构中
- 在
Post
表上创建新列authorId
。此列应为外键,引用User
表的id
字段。ALTER TABLE "Post" ADD COLUMN "authorId" VARCHAR(25);
ALTER TABLE "Post"
ADD CONSTRAINT fk_author
FOREIGN KEY ("authorId")
REFERENCES "User"("id"); - 编写一个 SQL 查询,从
_PostToUser
关系表中读取所有行,并为每一行- 通过查找列
A
中的值找到相应的Post
记录 - 将列
B
中的值作为authorId
的值插入到该Post
记录中
UPDATE "Post" post
SET "authorId" = post_to_user."B"
FROM "_PostToUser" post_to_user
WHERE post_to_user."A" = post."id"; - 通过查找列
- 删除
_PostToUser
关系表DROP TABLE "_PostToUser";
之后,您可以内省数据库,关系现在将被识别为 1-n。
model User {
id String @id
Post Post[]
}
model Post {
id String @id
User User @relation(fields: [authorId], references: [id])
authorId String
}
Json
类型在数据库中表示为 TEXT
问题
Prisma 1 支持在其数据模型中使用 Json
数据类型。然而,在底层数据库中,类型为 Json
的字段实际上是使用底层数据库的 TEXT
数据类型以纯字符串形式存储的。存储的 JSON 数据的任何解析和验证都由 Prisma 1 服务器在运行时完成。
示例
Prisma 1 数据模型
type User {
id: ID! @id
jsonData: Json
}
Prisma 1 生成的 SQL 迁移
CREATE TABLE "User" (
id VARCHAR(25) PRIMARY KEY NOT NULL,
jsonData TEXT
);
在 Prisma ORM 2.x 及更高版本中内省的结果
model User {
id String @id
jsonData String?
}
解决方法
您可以手动将列的类型更改为 JSON
ALTER TABLE "User" ALTER COLUMN "jsonData" TYPE JSON USING "jsonData"::json;
进行此调整后,您可以重新内省数据库,该字段现在将被识别为 Json
。
model User {
id String @id
jsonData Json?
}
枚举在数据库中表示为 TEXT
问题
Prisma 1 支持在其数据模型中使用 enum
数据类型。然而,在底层数据库中,声明为 enum
的类型实际上是使用底层数据库的 TEXT
数据类型以纯字符串形式存储的。存储的 enum
数据的任何验证都由 Prisma 1 服务器在运行时完成。
示例
Prisma 1 数据模型
type User {
id: ID! @id
role: Role
}
enum Role {
ADMIN
CUSTOMER
}
Prisma 1 生成的 SQL 迁移
CREATE TABLE "User" (
id VARCHAR(25) PRIMARY KEY NOT NULL,
role TEXT
);
在 Prisma ORM 2.x 及更高版本中内省的结果
model User {
id String @id
role String?
}
解决方法
您可以手动将 role
列转换为具有所需值的枚举
- 在数据库中创建一个与您在 Prisma 1 数据模型中定义的
enum
镜像的enum
CREATE TYPE "Role" AS ENUM ('CUSTOMER', 'ADMIN');
- 将类型从
TEXT
更改为您新的enum
ALTER TABLE "User" ALTER COLUMN "role" TYPE "Role"
USING "role"::text::"Role";
内省后,类型现在被正确识别为枚举。
model User {
id String @id
role Role?
}
enum Role {
ADMIN
CUSTOMER
}
CUID 长度不匹配
问题
Prisma 1 使用 CUID 作为所有数据库记录的 ID 值。在底层数据库中,这些 ID 表示为最大长度为 25 个字符的字符串(如 VARCHAR(25)
)。然而,在 Prisma ORM 2.x(或更高版本)schema 中使用 @default(cuid())
配置默认 CUID 时,生成的 ID 值可能会超过 25 个字符的限制(最大长度可能为 30 个字符)。为了使您的 ID 适用于 Prisma ORM 2.x(或更高版本),您需要将列类型调整为 VARCHAR(30)
。
示例
Prisma 1 数据模型
type User {
id: ID! @id
}
Prisma 1 生成的 SQL 迁移
CREATE TABLE "User" (
id VARCHAR(25) PRIMARY KEY NOT NULL
);
在 Prisma ORM 2.x 及更高版本中内省的结果
model User {
id String @id
}
解决方法
您可以手动将 VARCHAR(25)
列转换为 VARCHAR(30)
ALTER TABLE "User" ALTER COLUMN "id" SET DATA TYPE character varying(30);
注意:使用升级 CLI 修复此问题时,即使您已更改底层数据库中的列类型,生成的 SQL 语句仍会继续在升级 CLI 中出现。这是升级 CLI 目前的一个限制。
标量列表(数组)通过额外的表维护
问题
在 Prisma 1 中,您可以在模型上定义*标量*类型的列表。在内部,这通过一个额外的表实现,该表跟踪列表中的值。
为了消除使用额外表的方法(这会产生隐藏的性能成本),Prisma ORM 2.x 及更高版本仅在您使用的数据库原生支持标量列表时才支持。目前,只有PostgreSQL 原生支持标量列表(数组)。
对于 PostgreSQL 用户,您可以在 Prisma ORM 2.x 及更高版本中继续使用标量列表,但您需要执行数据迁移,将数据从 Prisma 1 的额外表转移到实际的 PostgreSQL 数组中。
示例
Prisma 1 数据模型
type User {
id: ID! @id
coinflips: [Boolean!]! @scalarList(strategy: RELATION)
}
Prisma 1 生成的 SQL 迁移
CREATE TABLE "User" (
id VARCHAR(25) PRIMARY KEY NOT NULL
);
CREATE TABLE "User_coinflips" (
"nodeId" VARCHAR(25) REFERENCES "User"(id),
position INTEGER,
value BOOLEAN NOT NULL,
CONSTRAINT "User_coinflips_pkey" PRIMARY KEY ("nodeId", position)
);
CREATE UNIQUE INDEX "User_coinflips_pkey" ON "User_coinflips"("nodeId" text_ops,position int4_ops);
Prisma ORM 2 内省的结果
model User {
id String @id
User_coinflips User_coinflips[]
}
model User_coinflips {
nodeId String
position Int
value Boolean
User User @relation(fields: [nodeId], references: [id])
@@id([nodeId, position])
}
请注意,您现在可以生成 Prisma Client,并通过额外表访问标量列表中的数据。PostgreSQL 用户也可以选择将数据迁移到原生的 PostgreSQL 数组中,并继续受益于 Prisma Client 对标量列表提供的更简洁的 API(阅读以下部分了解更多信息)。
展开查看 Prisma Client API 调用示例
要访问 coinflips 数据,您现在必须始终在查询中include
它
const user = await prisma.user.findUnique({
where: { id: 1 },
include: {
coinflips: {
orderBy: { position: 'asc' },
},
},
})
注意:
orderBy
对于保持列表的顺序很重要。
这是查询的结果
{
id: 1,
name: 'Alice',
coinflips: [
{ id: 1, position: 1000, value: false },
{ id: 2, position: 2000, value: true },
{ id: 3, position: 3000, value: false },
{ id: 4, position: 4000, value: true },
{ id: 5, position: 5000, value: true },
{ id: 6, position: 6000, value: false }
]
}
要只访问列表中的布尔值,您可以通过以下方式在 user
的 coinflips
上进行 map
const currentCoinflips = user!.coinflips.map((cf) => cf.value)
注意:上面的感叹号表示您正在*强制解封*
user
值。这是必要的,因为上一个查询返回的user
可能为null
。
这是调用 map
后 currentCoinflips
的值
[false, true, false, true, true, false]
解决方法
以下解决方法仅适用于 PostgreSQL 用户!
由于标量列表(即数组)作为原生的 PostgreSQL 功能可用,您可以在 Prisma schema 中继续使用 coinflips: Boolean[]
的相同表示法。
然而,为此您需要手动将底层数据从 User_coinflips
表迁移到 PostgreSQL 数组中。操作方法如下
- 向
User
表添加新的coinflips
列ALTER TABLE "User" ADD COLUMN coinflips BOOLEAN[];
- 将数据从
"User_coinflips".value
迁移到"User.coinflips"
UPDATE "User"
SET coinflips = t.flips
FROM (
SELECT "nodeId", array_agg(VALUE ORDER BY position) AS flips
FROM "User_coinflips"
GROUP BY "nodeId"
) t
where t."nodeId" = "User"."id"; - 为了清理,您可以删除
User_coinflips
表DROP TABLE "User_coinflips";
现在您可以内省数据库,并且 coinflips
字段将在您的新 Prisma schema 中表示为数组。
model User {
id String @id
coinflips Boolean[]
}
您可以像以前一样继续使用 Prisma Client
const user = await prisma.user.findUnique({
where: { id: 1 },
})
这是 API 调用的结果
{
id: 1,
name: 'Alice',
coinflips: [ false, true, false, true, true, false ]
}