Microsoft SQL Server

Microsoft SQL Server 数据源连接器将 Prisma ORM 连接到 Microsoft SQL Server 数据库服务器。

示例

要连接到 Microsoft SQL Server 数据库，您需要在您的 datasource 块中配置 Prisma schema

schema.prisma

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

传递给 datasource 块的字段是

• provider: 指定 sqlserver 数据源连接器。
• url: 指定 Microsoft SQL Server 数据库的 连接 URL。在这种情况下，使用环境变量 来提供连接 URL。

连接详情

用于连接到 Microsoft SQL Server 数据库的连接 URL 遵循 JDBC 标准。

以下示例使用 SQL 身份验证（用户名和密码）以及启用的 TLS 加密连接

sqlserver://HOST[:PORT];database=DATABASE;user=USER;password=PASSWORD;encrypt=true

警告

注意：如果您在连接字符串中使用以下任何字符，您将需要转义它们。

:\=;/[]{}  # these are characters that will need to be escaped

要转义这些字符，请在包含特殊字符的值周围使用花括号 {}。例如

sqlserver://HOST[:PORT];database=DATABASE;user={MyServer/MyUser};password={ThisIsA:SecurePassword;};encrypt=true

参数

参数名称	必需	默认值	注释
database initial catalog	否	master	要连接的数据库。
username user uid userid	否 - 请参阅注释		SQL Server 登录名（例如 sa）或 有效的 Windows (Active Directory) 用户名（如果 integratedSecurity 设置为 true）（仅限 Windows）。
password pwd	否 - 请参阅注释		SQL Server 登录名的密码或 Windows (Active Directory) 用户名（如果 integratedSecurity 设置为 true）（仅限 Windows）。
encrypt	否	true	配置是否始终使用 TLS，或仅用于登录过程，可能的值：true（始终使用），false（仅用于登录凭据）。
integratedSecurity	否		启用 Windows 身份验证（集成安全），可能的值：true，false，yes，no。如果设置为 true 或 yes 且存在 username 和 password，则通过 Windows Active Directory 执行登录。如果未通过单独的参数提供登录详细信息，则当前登录的 Windows 用户将用于登录服务器。
connectionLimit	否	num_cpus * 2 + 1	连接池的最大大小
connectTimeout	否	5	等待新连接的最大秒数
schema	否	dbo	如果架构名称不是默认值，则作为所有查询的前缀添加。
loginTimeout connectTimeout connectionTimeout	否		等待登录成功的秒数。
socketTimeout	否		等待每次查询成功的秒数。
isolationLevel	否		设置 事务隔离级别。
poolTimeout	否	10	等待从池中获取新连接的最大秒数。如果所有连接都在使用中，数据库将在等待给定时间后返回 PoolTimeout 错误。
ApplicationName Application Name （不区分大小写）	否		设置连接的应用程序名称。自 2.28.0 版本起。
trustServerCertificate	否	false	配置是否信任服务器证书。
trustServerCertificateCA	否		用于代替系统证书授权服务器证书的证书颁发机构文件的路径。必须为 pem、crt 或 der 格式。不能与 trustServerCertificate 参数一起使用。

使用 集成安全（仅限 Windows）

以下示例使用当前登录的 Windows 用户登录 Microsoft SQL Server

sqlserver://127.0.0.1:1433;database=sample;integratedSecurity=true;trustServerCertificate=true;

以下示例使用特定的 Active Directory 用户登录 Microsoft SQL Server

sqlserver://127.0.0.1:1433;database=sample;integratedSecurity=true;username=prisma;password=aBcD1234;trustServerCertificate=true;

连接到命名实例

以下示例使用集成安全连接到 Microsoft SQL Server 的命名实例 (mycomputer\sql2019)

sqlserver://mycomputer\sql2019;database=sample;integratedSecurity=true;trustServerCertificate=true;

Microsoft SQL Server 到 Prisma schema 之间的类型映射

有关按 Prisma ORM 类型组织的类型映射，请参阅 Prisma schema 参考 文档。

支持的版本

请参阅 支持的数据库。

限制和已知问题

Prisma Migrate 注意事项

Prisma Migrate 在 2.13.0 及更高版本中受支持，但有以下注意事项

数据库架构名称

SQL Server 没有等同于 PostgreSQL 的 SET search_path 命令。这意味着当您创建迁移时，您必须在生产数据库使用的连接 URL 中定义相同的架构名称。对于大多数用户来说，这是 dbo（默认值）。但是，如果生产数据库使用另一个架构名称，则必须手动编辑所有迁移 SQL 以反映生产环境，或者 必须在创建迁移之前更改连接 URL（例如：schema=name）。

循环引用

当每个模型都引用另一个模型时，可能会在模型之间发生循环引用，从而创建一个闭环。当使用 Microsoft SQL Server 数据库时，如果关系的 引用操作 设置为 NoAction 以外的值，Prisma ORM 将显示验证错误。

有关更多信息，请参阅 SQL Server 中引用操作的特殊规则。

破坏性更改

某些迁移将导致比您预期更多的更改。例如

• 添加或删除 autoincrement()。这无法通过修改列来实现，而是需要重新创建表（包括所有约束、索引和外键）并在表之间移动所有数据。
• 此外，不可能删除表中的所有列（PostgreSQL 或 MySQL 可以）。如果迁移需要重新创建所有表列，它还将重新创建表。

不支持共享默认值

在某些情况下，用户可能希望将默认值定义为共享对象

default_objects.sql

CREATE DEFAULT catcat AS 'musti';

CREATE TABLE cats (
    id INT IDENTITY PRIMARY KEY,
    name NVARCHAR(1000)
);

sp_bindefault 'catcat', 'dbo.cats.name';

使用存储过程 sp_bindefault，默认值 catcat 可以用于多个表。Prisma ORM 管理默认值的方式是按表进行的

default_per_table.sql

CREATE TABLE cats (
    id INT IDENTITY PRIMARY KEY,
    name NVARCHAR(1000) CONSTRAINT DF_cat_name DEFAULT 'musti'
);

当内省时，最后一个示例会生成以下模型

schema.prisma

model cats {
  id   Int     @id @default(autoincrement())
  name String? @default("musti")
}

而第一个示例不会内省默认值

schema.prisma

model cats {
  id   Int     @id @default(autoincrement())
  name String?
}

如果将 Prisma Migrate 与共享默认对象一起使用，则对它们的更改必须手动完成到 SQL。

数据模型限制

无法使用具有 UNIQUE 约束和筛选索引的列作为外键

Microsoft SQL Server 仅允许在具有 UNIQUE 约束的列中有一个 NULL 值。例如

• 用户表有一个名为 license_number 的列
• license_number 字段具有 UNIQUE 约束
• license_number 字段仅允许 一个 NULL 值

解决此问题的标准方法是创建一个筛选的唯一索引，排除 NULL 值。这允许您插入多个 NULL 值。如果您未在数据库中创建索引，如果您尝试将多个 null 值插入到具有 Prisma Client 的列中，您将收到错误。

但是，创建索引使得无法在数据库中使用 license_number 作为外键（或在相应的 Prisma Schema 中作为关系标量字段）

原始查询注意事项

带有 String @db.VarChar(n) 字段 / VARCHAR(N) 列的原始查询

原始查询 中的 String 查询参数始终编码为 SQL Server 作为 NVARCHAR(4000)（如果您的 String 长度 <= 4000）或 NVARCHAR(MAX)。如果您将 String 查询参数与 String @db.VarChar(N)/VARCHAR(N) 类型的列进行比较，这可能会导致 SQL Server 上的隐式转换，这会影响您的索引性能并可能导致高 CPU 使用率。

这是一个例子

model user {
  id Int @id
  name String @db.VarChar(40)
}

此查询将受到影响

await prisma.$queryRaw`SELECT * FROM user WHERE name = ${"John"}`

为了避免此问题，我们建议您始终在原始查询中手动将 String 查询参数转换为 VARCHAR(N)

await prisma.$queryRaw`SELECT * FROM user WHERE name = CAST(${"John"} AS VARCHAR(40))`

这使 SQL Server 能够执行聚集索引查找而不是聚集索引扫描。