跳到主要内容

环境变量参考

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

Prisma Client

DEBUG

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

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

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

更多信息请参阅调试

NO_COLOR

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

更多信息请参阅通过环境变量格式化

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 Schema 中定义了 prisma-client-js 生成器,在使用 prisma generate 命令时,可以将 PRISMA_GENERATE_SKIP_AUTOINSTALL 设置为一个真值,以跳过自动安装 prisma CLI 和 @prisma/client 依赖项(如果它们缺失)。

PRISMA_SKIP_POSTINSTALL_GENERATE

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

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 block 的 engineType 属性的环境变量等效项,后者使您可以在 Prisma Schema 中定义相同的设置。

下载引擎

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 中已弃用,因为 Migration 引擎已重命名为 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 起由 Migration 引擎提供服务。因此,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 在安装期间将下载的一个或多个二进制目标(因此必须在 npm install Prisma CLI 时提供,并且不影响 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

这是 Prisma CLI 对应于 generator block 的 binaryTargets 属性的等效项,后者使您可以在 Prisma Client 中定义相同的设置。

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