跳到主要内容

Microsoft SQL Server

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

示例​

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

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），或者，如果 integratedSecurity 设置为 true（仅限 Windows），则为有效的 Windows (Active Directory) 用户名。
  • 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如果 schema 名称不是默认值，则作为前缀添加到所有查询中。
  • loginTimeout
  • connectTimeout
  • connectionTimeout
否等待登录成功的秒数。
socketTimeout否等待每个查询成功的秒数。
isolationLevel否设置事务隔离级别。
poolTimeout否10等待从连接池获取新连接的最大秒数。如果所有连接都在使用中，数据库在等待给定时间后将返回 PoolTimeout 错误。
  • ApplicationName
  • 应用程序名称
（不区分大小写）		否设置连接的应用程序名称。自 2.28.0 版本起可用。
trustServerCertificate否false配置是否信任服务器证书。
trustServerCertificateCA否证书颁发机构文件的路径，用于代替系统证书授权服务器证书。必须是 pem、crt 或 der 格式。不能与 trustServerCertificate 参数一起使用。

使用集成安全性（仅限 Windows）​

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

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

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

sqlserver://localhost: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 及更高版本，但存在以下注意事项

数据库 schema 名称​

SQL Server 没有类似于 PostgreSQL 中熟悉的 SET search_path 命令。这意味着当您创建迁移时，必须在连接 URL 中定义与生产数据库使用的 schema 名称相同的名称。对于大多数用户来说，这是 dbo（默认值）。但是，如果生产数据库使用其他 schema 名称，则所有迁移 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 值。如果您未在数据库中创建索引，则在使用 Prisma Client 尝试向具有 UNIQUE 约束的列中插入多个 null 值时，将会收到错误。

但是，创建索引使得无法在数据库中将 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 能够执行聚集索引查找而不是聚集索引扫描。