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: 指定 MySQL 数据库服务器的连接 URL。在本例中，使用了环境变量来提供连接 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`

信息

您必须百分比编码特殊字符。

参数

连接 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 folder` 文件夹解析的
`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 folder 文件夹解析的
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 issue 中找到更多上下文。

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+ 中支持
`Bytes`	`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/
`Bytes`	`LONGBLOB`

本机类型映射

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

MySQL	Prisma ORM	支持的	本机数据库类型属性	注释
`serial`	`BigInt`	✔️	`@db.UnsignedBigInt @default(autoincrement())`
`bigint`	`BigInt`	✔️	`@db.BigInt`
`bigint unsigned`	`BigInt`	✔️	`@db.UnsignedBigInt`
`bit`	`Bytes`	✔️	`@db.Bit(x)`	`bit(1)` 映射到 `Boolean` - 所有其他 `bit(x)` 映射到 `Bytes`
`boolean` \| `tinyint(1)`	`Boolean`	✔️	`@db.TinyInt(1)`
`varbinary`	`Bytes`	✔️	`@db.VarBinary`
`longblob`	`Bytes`	✔️	`@db.LongBlob`
`tinyblob`	`Bytes`	✔️	`@db.TinyBlob`
`mediumblob`	`Bytes`	✔️	`@db.MediumBlob`
`blob`	`Bytes`	✔️	`@db.Blob`
`binary`	`Bytes`	✔️	`@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 的本机类型映射​

本机类型映射​

引擎​

权限​

示例