跳至主要内容

环境变量参考

本文档描述了不同的环境变量及其用例。

Prisma Client

DEBUG

DEBUG 用于启用 Prisma Client 中的调试输出。

设置 Prisma Client 级别调试输出的示例

# enable only `prisma:client`-level debugging output
export DEBUG="prisma:client"

有关更多信息,请参阅 调试

NO_COLOR

如果 NO_COLOR 为真值,将为错误格式激活 colorless 设置,并从错误消息中去除颜色。

有关更多信息,请参阅 通过环境变量进行格式化

Prisma Studio

BROWSER

BROWSER 用于强制 Prisma Studio 在其中打开的浏览器,如果未设置,则将在默认浏览器中打开。

BROWSER=firefox prisma studio --port 5555

或者,您也可以在从 CLI 启动 Studio 时设置此值。

prisma studio --browser firefox

有关更多信息,请参阅 Studio 文档。

Prisma CLI

PRISMA_HIDE_PREVIEW_FLAG_WARNINGS

PRISMA_HIDE_PREVIEW_FLAG_WARNINGS 隐藏指示预览功能标志可能会被删除的警告消息。它是一个真值。

PRISMA_HIDE_UPDATE_MESSAGE

PRISMA_HIDE_UPDATE_MESSAGE 用于隐藏在有更新的 Prisma CLI 版本可用时显示的更新通知消息。它是一个真值。

PRISMA_GENERATE_SKIP_AUTOINSTALL

PRISMA_GENERATE_SKIP_AUTOINSTALL 可以设置为真值以跳过 prisma CLI 和 @prisma/client 依赖项的自动安装(如果它们缺失),如果在使用 prisma generate 命令时,Prisma 模式中定义了 prisma-client-js 生成器。

PRISMA_SKIP_POSTINSTALL_GENERATE

PRISMA_SKIP_POSTINSTALL_GENERATE 可以设置为真值以跳过在包管理器触发其 postinstall 钩子时 Prisma Client 的自动生成。当安装包或更新其版本时,将触发 @prisma/client 包的 postinstall 钩子。

PRISMA_DISABLE_WARNINGS

禁用 logger.warn 生成的所有 CLI 警告。

PRISMA_GENERATE_NO_ENGINE

信息

此环境变量自版本 5.2.0 起可用

PRISMA_GENERATE_NO_ENGINE 可以设置为真值以生成不包含 查询引擎 的 Prisma Client,以便在与 Prisma Accelerate 配合使用时减小部署应用程序的大小。

PRISMA_SCHEMA_DISABLE_ADVISORY_LOCK

信息

此环境变量自版本 5.3.0 起可用

PRISMA_SCHEMA_DISABLE_ADVISORY_LOCK 可以设置为真值以禁用 Prisma Migrate 使用的 咨询锁定。根据数据库配置,例如对于 Percona-XtraDB-Cluster 或 MariaDB Galera Cluster,可能需要这样做。

代理环境变量

Prisma CLI 支持自定义 HTTP(S) 代理来下载 Prisma 引擎。在公司防火墙后工作时,这些代理可能很有用。有关更多信息,请参阅 为 CLI 使用 HTTP 代理

NO_PROXY

NO_PROXY 是不需要代理的主机名或 IP 地址的逗号分隔列表。

NO_PROXY=myhostname.com,10.11.12.0/16,172.30.0.0/16

HTTP_PROXY

HTTP_PROXY 设置为代理服务器的主机名或 IP 地址。

HTTP_PROXY=http://proxy.example.com

HTTPS_PROXY

HTTPS_PROXY 设置为代理服务器的主机名或 IP 地址。

HTTPS_PROXY=https://proxy.example.com

引擎环境变量

配置查询引擎类型

PRISMA_CLI_QUERY_ENGINE_TYPE

PRISMA_CLI_QUERY_ENGINE_TYPE 用于 定义 Prisma CLI 下载和使用的查询引擎类型。默认为 library,但可以设置为 binary

PRISMA_CLI_QUERY_ENGINE_TYPE=binary

PRISMA_CLIENT_ENGINE_TYPE

PRISMA_CLIENT_ENGINE_TYPE 用于 定义 Prisma Client 下载和使用的查询引擎类型。默认为 library,但可以设置为 binary

PRISMA_CLIENT_ENGINE_TYPE=binary

注意:您需要在设置此变量后生成 Prisma Client 才能使配置生效并下载库。否则,Prisma Client 将缺少相应的查询引擎库,您*必须*使用 PRISMA_QUERY_ENGINE_LIBRARY 定义其位置。

它等同于 generator 块的 engineType 属性 的环境变量,使您能够在 Prisma 模式中定义相同的设置。

下载引擎

PRISMA_ENGINES_MIRROR

PRISMA_ENGINES_MIRROR 可用于指定自定义 CDN(或服务器)端点以下载 CLI/Client 的引擎文件。默认值为 https://binaries.prisma.sh,Prisma 在此处托管引擎文件。

PRISMA_ENGINES_MIRROR=https://example.org/custom-engines/

有关如何使用此环境变量的概念概述,请参阅 Prisma 引擎

注意:此环境变量以前可用作 PRISMA_BINARIES_MIRROR,该变量在 Prisma ORM 3.0.1 中已弃用。建议不再使用,将来会删除。

PRISMA_ENGINES_CHECKSUM_IGNORE_MISSING

信息

此环境变量自版本 4.16.0 起可用

PRISMA_ENGINES_CHECKSUM_IGNORE_MISSING 可以设置为真值以忽略下载和验证 Prisma ORM 引擎完整性(通过校验和文件)方面的问题。当部署到无法下载校验和文件的脱机系统环境时,这尤其有用。

PRISMA_ENGINES_CHECKSUM_IGNORE_MISSING=1

注意:我们可能会在将来的版本中更改整体下载行为,以便在脱机环境情况下不再需要此环境变量。

自定义引擎文件位置

默认情况下,安装 Prisma CLI 时会下载所有引擎文件,生成 Prisma Client 时会复制这些文件,并将它们放入已知位置。但是,在某些情况下,您可能希望从自定义位置使用自定义引擎文件。

PRISMA_QUERY_ENGINE_BINARY

PRISMA_QUERY_ENGINE_BINARY 用于设置您自己的查询引擎二进制文件的自定义位置。

PRISMA_QUERY_ENGINE_BINARY=custom/query-engine-<target>
# Example: ./prisma/binaries/query-engine-linux-arm64-openssl-1.0.x

对于 Prisma CLI,它允许您定义要使用的查询引擎文件。


对于 Prisma Client,在构建时(在 `prisma generate` 期间),它定义了查询引擎文件将从哪里复制到 Prisma Client 中。在运行时(使用生成的 Client 时),它可以用于定义要使用的特定查询引擎文件,而不是包含的文件。

注意:只有当 CLI 或 Client 的引擎类型设置为 `binary` 时,此设置才会生效。如果引擎类型为 `library`(默认值),请使用 PRISMA_QUERY_ENGINE_LIBARY 代替。

PRISMA_QUERY_ENGINE_LIBRARY

PRISMA_QUERY_ENGINE_LIBRARY 用于设置您自己的查询引擎库的自定义位置。

PRISMA_QUERY_ENGINE_LIBRARY=custom/libquery_engine-<target>.so.node
# Example: ./prisma/binaries/libquery_engine-linux-arm64-openssl-1.0.x.so.node

对于 Prisma CLI,它允许您定义要使用的查询引擎文件。


对于 Prisma Client,在构建时(在 `prisma generate` 期间),它定义了查询引擎文件将从哪里复制到 Prisma Client 中。在运行时(使用生成的 Client 时),它可以用于定义要使用的特定查询引擎文件,而不是包含的文件。

注意:只有当 CLI 或 Client 的引擎类型设置为 `library`(默认值)时,此设置才会生效。

PRISMA_SCHEMA_ENGINE_BINARY

PRISMA_SCHEMA_ENGINE_BINARY 用于设置您自己的 Schema 引擎二进制文件的自定义位置。

PRISMA_SCHEMA_ENGINE_BINARY=custom/my-schema-engine-unix

PRISMA_MIGRATION_ENGINE_BINARY

警告

已弃用PRISMA_MIGRATION_ENGINE_BINARY 变量在 5.0.0 中被弃用,因为迁移引擎已重命名为 Schema 引擎。

PRISMA_MIGRATION_ENGINE_BINARY 用于设置您自己的迁移引擎二进制文件的自定义位置。

PRISMA_MIGRATION_ENGINE_BINARY=custom/my-migration-engine-unix

PRISMA_INTROSPECTION_ENGINE_BINARY

PRISMA_INTROSPECTION_ENGINE_BINARY 用于设置您自己的内省引擎二进制文件的自定义位置。

PRISMA_INTROSPECTION_ENGINE_BINARY=custom/my-introspection-engine-unix
警告

4.9.0 开始,内省引擎由迁移引擎提供。因此,将不会使用 PRISMA_INTROSPECTION_ENGINE 环境变量。

PRISMA_FMT_BINARY

危险

此功能已在 Prisma CLI 版本 4.10.0 中移除。它仅在早期版本中有效。

PRISMA_FMT_BINARY 用于设置您自己的格式引擎二进制文件的自定义位置。

PRISMA_FMT_BINARY=custom/my-custom-format-engine-unix
警告

PRISMA_FMT_BINARY 变量用于版本 4.2.0 或更低版本。

CLI 二进制目标

PRISMA_CLI_BINARY_TARGETS

PRISMA_CLI_BINARY_TARGETS 可用于指定一个或多个 Prisma CLI 在安装期间将下载的二进制目标(因此它必须在 Prisma CLI 的 `npm install` 期间提供,并且不会影响 Prisma CLI 或 Prisma Client 的运行时)。

如果您 1) 通过上传包含依赖项的本地项目来部署到特定平台,以及 2) 您的本地环境与目标环境不同(例如,使用 Node.js 20+ 的 AWS Lambda 为 `rhel-openssl-3.0.x`,而您的本地环境可能是 macOS arm64 `darwin-arm64`),则使用 PRISMA_CLI_BINARY_TARGETS 环境变量。使用 PRISMA_CLI_BINARY_TARGETS 环境变量可确保也下载目标引擎文件。

PRISMA_CLI_BINARY_TARGETS=darwin-arm64,rhel-openssl-3.0.x npm install

这是 `generator` 块的 `binaryTargets` 属性 的 Prisma CLI 等效项,它允许您为 Prisma Client 定义相同的设置。

注意:对于低于 20 的 Node.js 版本,openssl 版本为 1.0.x 而不是 3.0.x。这在 AWS Lambda 部署中最为明显,其中二进制目标将为 `rhel-openssl-1.0.x` 而不是 `rhel-openssl-3.0.x`。