跳至主要内容

环境变量参考

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

Prisma 客户端

DEBUG

DEBUG 用于启用 Prisma 客户端中的调试输出。

示例设置 Prisma 客户端级调试输出

# 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-client-js 生成器在 Prisma 架构中定义,使用 prisma generate 命令时。

PRISMA_SKIP_POSTINSTALL_GENERATE

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

PRISMA_DISABLE_WARNINGS

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

PRISMA_GENERATE_NO_ENGINE

信息

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

PRISMA_GENERATE_NO_ENGINE 可以设置为真值,以生成不包含 查询引擎 的 Prisma 客户端,以便在与 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 客户端下载和使用的查询引擎类型。默认值为 library,但可以设置为 binary

PRISMA_CLIENT_ENGINE_TYPE=binary

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

它是 generator 块的 engineType 属性 的环境变量等效项,它使您能够在 Prisma 架构中定义相同的设置。

下载引擎

PRISMA_ENGINES_MIRROR

PRISMA_ENGINES_MIRROR 可用于指定自定义 CDN(或服务器)端点以下载 CLI/客户端的引擎文件。默认值为 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 在安装期间将下载的一个或多个二进制目标(因此它必须在 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

这是 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