MySQL/MariaDB

MySQL 数据源连接器将 Prisma ORM 连接到一个 MySQL 或 MariaDB 数据库服务器。

默认情况下，MySQL 连接器包含一个数据库驱动程序，负责连接到您的数据库。您可以使用驱动程序适配器 (预览) 使用 Prisma Client 中的 JavaScript 数据库驱动程序连接到您的数据库。

示例

要连接到 MySQL 数据库服务器，您需要在您的 Prisma Schema 中配置一个 datasource 块。

schema.prisma

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

传递给 datasource 块的字段是

provider: 指定 mysql 数据源连接器，它用于 MySQL 和 MariaDB。
url: 指定连接 URL，用于连接到 MySQL 数据库服务器。在本例中，一个环境变量被使用来提供连接 URL。

连接详细信息

连接 URL

以下是 MySQL 连接 URL 所需组件的概述

Structure of the MySQL connection URL

基本 URL 和路径

以下是以大写字母表示占位符的基本 URL 和路径结构示例

mysql://USER:PASSWORD@HOST:PORT/DATABASE

以下组件构成数据库的基本 URL，它们始终是必需的

名称	占位符	描述
主机	`HOST`	数据库服务器的 IP 地址/域名，例如 `localhost`
端口	`PORT`	数据库服务器运行的端口，例如 `5432` （默认值为 `3306`，或使用 Unix 套接字时没有端口）
用户	`USER`	数据库用户的名称，例如 `janedoe`
密码	`PASSWORD`	数据库用户的密码
数据库	`DATABASE`	您要使用的数据库的名称，例如 `mydb`

info

您必须对特殊字符进行百分比编码.

参数

连接 URL 还可以使用参数。以下是以大写字母表示占位符的三个参数的相同示例

mysql://USER:PASSWORD@HOST:PORT/DATABASE?KEY1=VALUE&KEY2=VALUE&KEY3=VALUE

可以使用以下参数

参数名称	必需	默认值	描述
`connection_limit`	否	`num_cpus * 2 + 1`	连接池的最大大小
`connect_timeout`	否	`5`	等待打开新连接的最大秒数，`0` 表示没有超时
`pool_timeout`	否	`10`	等待从连接池中获取新连接的最大秒数，`0` 表示没有超时
`sslcert`	否		服务器证书的路径。证书路径将相对于 `./prisma 文件夹` 解析
`sslidentity`	否		PKCS12 证书的路径
`sslpassword`	否		用于保护 PKCS12 文件的密码
`sslaccept`	否	`accept_invalid_certs`	配置是否检查证书中缺少的值。可能的值：`accept_invalid_certs`、`strict`
`socket`	否		指向包含要用于连接的套接字的目录
`socket_timeout`	否		等待单个查询终止的秒数

例如，如果您想将连接池大小设置为 5 并为查询配置 3 秒的超时，您可以使用以下参数

mysql://USER:PASSWORD@HOST:PORT/DATABASE?connection_limit=5&socket_timeout=3

配置 SSL 连接

如果您的数据库服务器使用 SSL，您可以在连接 URL 中添加各种参数。以下是可能参数的概述

sslcert=<PATH>: 服务器证书的路径。这是数据库服务器用来签署客户端证书的根证书。如果您系统上的受信任证书存储区中不存在证书，则需要提供此证书。对于 Google Cloud，这可能是 server-ca.pem。证书路径将相对于 ./prisma 文件夹 解析
sslidentity=<PATH>: 从客户端证书和密钥创建的 PKCS12 证书数据库的路径。这是您将使用客户端密钥和客户端证书生成的 PKCS12 格式的 SSL 标识文件。它将这两个文件合并到一个文件中，并通过密码 (参见下一个参数) 对其进行保护。您可以使用以下命令 (使用 openssl) 使用您的客户端密钥和客户端证书创建此文件
```
openssl pkcs12 -export -out client-identity.p12 -inkey client-key.pem -in client-cert.pem
```
sslpassword=<PASSWORD>: 用于保护 PKCS12 文件的密码。上一步骤中列出的 openssl 命令将在创建 PKCS12 文件时要求您输入密码，您需要在此处提供完全相同的密码。
sslaccept=(strict|accept_invalid_certs):
- strict: 证书中任何缺少的值都会导致错误。对于 Google Cloud，尤其是如果数据库没有域名，证书可能会缺少域名/IP 地址，从而在连接时导致错误。
- accept_invalid_certs (默认值): 跳过此检查。请注意此设置的安全后果。

您的数据库连接 URL 将类似于以下内容

mysql://USER:PASSWORD@HOST:PORT/DATABASE?sslidentity=client-identity.p12&sslpassword=mypassword&sslcert=rootca.cert

通过套接字连接

要通过套接字连接到您的 MySQL/MariaDB 数据库，您必须将 socket 字段作为查询参数 添加到连接 URL 中 (而不是将其设置为 URI 的 host 部分)。然后，该参数的值必须指向包含套接字的目录，例如，在 Ubuntu 或 Debian 上默认安装 MySQL/MariaDB 时，请使用：mysql://USER:PASSWORD@HOST/DATABASE?socket=/run/mysqld/mysqld.sock

请注意，localhost 是必需的，其值本身会被忽略，可以是任何内容。

注意: 您可以在此 GitHub 问题中找到更多上下文。

MySQL 到 Prisma Schema 之间的类型映射

MySQL 连接器将 Prisma ORM 数据模型中的标量类型映射到本机列类型，如下所示

或者，请参见 Prisma Schema 参考，其中按 Prisma ORM 类型组织了类型映射。

从 Prisma ORM 到 MySQL 的本机类型映射

Prisma ORM	MySQL	注释
`String`	`VARCHAR(191)`
`Boolean`	`BOOLEAN`	在 MySQL 中，`BOOLEAN` 是 `TINYINT(1)` 的同义词
`Int`	`INT`
`BigInt`	`BIGINT`
`Float`	`DOUBLE`
`Decimal`	`DECIMAL(65,30)`
`DateTime`	`DATETIME(3)`	目前，Prisma ORM 不支持 MySQL 中的零日期 (`0000-00-00`、`00:00:00`)
`Json`	`JSON`	仅在 MySQL 5.7+ 版本中支持
`字节`	`LONGBLOB`

Prisma ORM 到 MariaDB 的原生类型映射

Prisma ORM	MariaDB	注释
`String`	`VARCHAR(191)`
`Boolean`	`BOOLEAN`	在 MariaDB 中，`BOOLEAN` 是 `TINYINT(1)` 的同义词
`Int`	`INT`
`BigInt`	`BIGINT`
`Float`	`DOUBLE`
`Decimal`	`DECIMAL(65,30)`
`DateTime`	`DATETIME(3)`
`Json`	`LONGTEXT`	参见 https://mariadb.com/kb/en/json-data-type/
`字节`	`LONGBLOB`

原生类型映射

当内省 MySQL 数据库时，数据库类型将根据以下表格映射到 Prisma ORM

MySQL	Prisma ORM	支持	原生数据库类型属性	注释
`serial`	`BigInt`	✔️	`@db.UnsignedBigInt @default(autoincrement())`
`bigint`	`BigInt`	✔️	`@db.BigInt`
`bigint unsigned`	`BigInt`	✔️	`@db.UnsignedBigInt`
`bit`	`字节`	✔️	`@db.Bit(x)`	`bit(1)` 映射到 `Boolean` - 其他所有 `bit(x)` 映射到 `Bytes`
`boolean` \| `tinyint(1)`	`Boolean`	✔️	`@db.TinyInt(1)`
`varbinary`	`字节`	✔️	`@db.VarBinary`
`longblob`	`字节`	✔️	`@db.LongBlob`
`tinyblob`	`字节`	✔️	`@db.TinyBlob`
`mediumblob`	`字节`	✔️	`@db.MediumBlob`
`blob`	`字节`	✔️	`@db.Blob`
`binary`	`字节`	✔️	`@db.Binary`
`date`	`DateTime`	✔️	`@db.Date`
`datetime`	`DateTime`	✔️	`@db.DateTime`
`timestamp`	`DateTime`	✔️	`@db.TimeStamp`
`time`	`DateTime`	✔️	`@db.Time`
`decimal(a,b)`	`Decimal`	✔️	`@db.Decimal(x,y)`
`numeric(a,b)`	`Decimal`	✔️	`@db.Decimal(x,y)`
`enum`	`Enum`	✔️	N/A
`float`	`Float`	✔️	`@db.Float`
`double`	`Float`	✔️	`@db.Double`
`smallint`	`Int`	✔️	`@db.SmallInt`
`smallint unsigned`	`Int`	✔️	`@db.UnsignedSmallInt`
`mediumint`	`Int`	✔️	`@db.MediumInt`
`mediumint unsigned`	`Int`	✔️	`@db.UnsignedMediumInt`
`int`	`Int`	✔️	`@db.Int`
`int unsigned`	`Int`	✔️	`@db.UnsignedInt`
`tinyint`	`Int`	✔️	`@db.TinyInt(x)`	`tinyint(1)` 映射到 `Boolean`，其他所有 `tinyint(x)` 映射到 `Int`
`tinyint unsigned`	`Int`	✔️	`@db.UnsignedTinyInt(x)`	`tinyint(1) unsigned` 不映射到 `Boolean`
`year`	`Int`	✔️	`@db.Year`
`json`	`Json`	✔️	`@db.Json`	仅在 MySQL 5.7+ 版本中支持
`char`	`String`	✔️	`@db.Char(x)`
`varchar`	`String`	✔️	`@db.VarChar(x)`
`tinytext`	`String`	✔️	`@db.TinyText`
`text`	`String`	✔️	`@db.Text`
`mediumtext`	`String`	✔️	`@db.MediumText`
`longtext`	`String`	✔️	`@db.LongText`
`set`	`不支持`	尚未
`geometry`	`不支持`	尚未
`point`	`不支持`	尚未
`linestring`	`不支持`	尚未
`polygon`	`不支持`	尚未
`multipoint`	`不支持`	尚未
`multilinestring`	`不支持`	尚未
`multipolygon`	`不支持`	尚未
`geometrycollection`	`不支持`	尚未

内省添加作为 Unsupported 字段的尚未支持的原生数据库类型

schema.prisma

model Device {
  id   Int                   @id @default(autoincrement())
  name String
  data Unsupported("circle")
}

引擎

如果您使用的是 MySQL 的版本，其中 MyISAM 是默认引擎，则在创建表时必须指定 ENGINE = InnoDB;。如果您内省使用不同引擎的数据库，则 Prisma Schema 中的关系不会创建（或者如果关系已经存在则会丢失）。

权限

默认情况下，新安装的 MySQL/MariaDB 只有一个 root 数据库用户。在您的 Prisma 配置中不要使用 root 用户，而要为每个应用程序创建数据库和数据库用户。在大多数 Linux 主机（例如 Ubuntu）上，您可以简单地以 Linux root 用户身份运行此命令（它会自动具有数据库 root 访问权限）

mysql -e "CREATE DATABASE IF NOT EXISTS $DB_PRISMA;"
mysql -e "GRANT ALL PRIVILEGES ON $DB_PRISMA.* TO $DB_USER@'%' IDENTIFIED BY '$DB_PASSWORD';"

以上内容足以运行 prisma db pull 和 prisma db push 命令。为了也运行 prisma migrate 命令，需要授予这些权限

mysql -e "GRANT CREATE, DROP, REFERENCES, ALTER ON *.* TO $DB_USER@'%';"

示例​

连接详细信息​

连接 URL​

基本 URL 和路径​

参数​

配置 SSL 连接​

通过套接字连接​

MySQL 到 Prisma Schema 之间的类型映射​

从 Prisma ORM 到 MySQL 的本机类型映射​

Prisma ORM 到 MariaDB 的原生类型映射​

原生类型映射​

引擎​

权限​

示例