跳到主要内容

MySQL/MariaDB

MySQL 数据源连接器将 Prisma ORM 连接到 MySQLMariaDB 数据库服务器。

默认情况下,MySQL 连接器包含一个负责连接到你的数据库的数据库驱动程序。你可以使用驱动程序适配器 (预览) 来使用来自 Prisma 客户端的 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_limitnum_cpus * 2 + 1连接池 的最大大小
connect_timeout5等待打开新连接的最大秒数,0 表示没有超时
pool_timeout10等待从池中获取新连接的最大秒数,0 表示没有超时
sslcert服务器证书的路径。证书路径是相对于 ./prisma 文件夹解析的
sslidentityPKCS12 证书的路径
sslpassword用于保护 PKCS12 文件的密码
sslacceptaccept_invalid_certs配置是否检查证书中缺少的值。可能的值:accept_invalid_certsstrict
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 ORMMySQL注释
StringVARCHAR(191)
BooleanBOOLEAN在 MySQL 中,BOOLEANTINYINT(1) 的同义词
IntINT
BigIntBIGINT
FloatDOUBLE
DecimalDECIMAL(65,30)
DateTimeDATETIME(3)目前,Prisma ORM 在 MySQL 中不支持零日期(0000-00-0000:00:00
JsonJSON仅在 MySQL 5.7+ 中支持
BytesLONGBLOB

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

Prisma ORMMariaDB注释
StringVARCHAR(191)
BooleanBOOLEAN在 MariaDB 中,BOOLEANTINYINT(1) 的同义词
IntINT
BigIntBIGINT
FloatDOUBLE
DecimalDECIMAL(65,30)
DateTimeDATETIME(3)
JsonLONGTEXT请参阅 https://mariadb.com/kb/en/json-data-type/
BytesLONGBLOB

原生类型映射

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

MySQLPrisma ORM支持原生数据库类型属性注释
serialBigInt✔️@db.UnsignedBigInt @default(autoincrement())
bigintBigInt✔️@db.BigInt
bigint unsignedBigInt✔️@db.UnsignedBigInt
bitBytes✔️@db.Bit(x)bit(1) 映射到 Boolean - 所有其他 bit(x) 映射到 Bytes
boolean | tinyint(1)Boolean✔️@db.TinyInt(1)
varbinaryBytes✔️@db.VarBinary
longblobBytes✔️@db.LongBlob
tinyblobBytes✔️@db.TinyBlob
mediumblobBytes✔️@db.MediumBlob
blobBytes✔️@db.Blob
binaryBytes✔️@db.Binary
dateDateTime✔️@db.Date
datetimeDateTime✔️@db.DateTime
timestampDateTime✔️@db.TimeStamp
timeDateTime✔️@db.Time
decimal(a,b)Decimal✔️@db.Decimal(x,y)
numeric(a,b)Decimal✔️@db.Decimal(x,y)
enumEnum✔️N/A
floatFloat✔️@db.Float
doubleFloat✔️@db.Double
smallintInt✔️@db.SmallInt
smallint unsignedInt✔️@db.UnsignedSmallInt
mediumintInt✔️@db.MediumInt
mediumint unsignedInt✔️@db.UnsignedMediumInt
intInt✔️@db.Int
int unsignedInt✔️@db.UnsignedInt
tinyintInt✔️@db.TinyInt(x)tinyint(1) 映射到 Boolean,所有其他 tinyint(x) 映射到 Int
tinyint unsignedInt✔️@db.UnsignedTinyInt(x)tinyint(1) unsigned **不** 映射到 Boolean
yearInt✔️@db.Year
jsonJson✔️@db.Json仅在 MySQL 5.7+ 中支持
charString✔️@db.Char(x)
varcharString✔️@db.VarChar(x)
tinytextString✔️@db.TinyText
textString✔️@db.Text
mediumtextString✔️@db.MediumText
longtextString✔️@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 pullprisma db push 命令。为了运行 prisma migrate 命令,还需要授予以下权限

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