跳至主要内容

.env 文件

Prisma ORM 在项目的根目录创建了一个默认的 .env 文件。您可以选择替换此文件或在 prisma 文件夹中创建一个新文件,或者如果您选择重新定位 prisma.schema 文件,则可以将其放在该文件旁边。

.env 文件位置

Prisma CLI 按顺序在以下位置查找 .env 文件

  1. 在项目的根文件夹中 (./.env)
  2. 来自由 --schema 参数指定的模式的同一文件夹
  3. 来自 package.json"prisma": {"schema": "/path/to/schema.prisma"} 中获取的模式的同一文件夹
  4. 来自 ./prisma 文件夹

如果在步骤 1. 中找到 .env 文件,但在步骤 2. - 4. 中找到其他冲突的 .env 变量,则 CLI 将抛出错误。例如,如果您在两个不同的 .env 文件中指定 DATABASE_URL 变量,您将收到以下错误

Error: There is a conflict between env vars in .env and prisma/.env
Conflicting env vars:
DATABASE_URL

We suggest to move the contents of prisma/.env to .env to consolidate your env vars.

下表描述了 Prisma CLI 在哪里查找 .env 文件

命令模式位置按顺序检查的 .env 文件位置
prisma [命令]./prisma/schema.prisma./.env
./prisma/.env
prisma [命令] --schema=./a/b/schema.prisma./a/b/schema.prisma./.env
./a/b/.env
./prisma/.env
prisma [命令]"prisma": {"schema": "/path/to/schema.prisma"}.env
./path/to/schema/.env
./prisma/.env
prisma [命令]无模式(例如,在空目录中运行 prisma db pull 时)./.env
./prisma/.env

在该 .env 文件中定义的任何环境变量将在运行 Prisma CLI 命令时自动加载。

警告

不要将您的 .env 文件提交到版本控制中!

有关如果在两个地方定义了环境变量会发生什么,请参阅 dotenv 文档。

扩展变量

存储在 .env 文件中的变量可以使用 dotenv-expand 指定的格式进行扩展。

.env
DATABASE_URL=postgresql://test:test@localhost:5432/test
DATABASE_URL_WITH_SCHEMA=${DATABASE_URL}?schema=public

这将使值为 postgresql://test:test@localhost:5432/test?schema=public 的环境变量 DATABASE_URL_WITH_SCHEMA 可用于 Prisma ORM。

您还可以使用在 .env 文件外部设置的环境变量进行扩展,例如在 Heroku 或类似的 PaaS 上设置的数据库 URL

# environment variable already set in the environment of the system
export DATABASE_URL=postgresql://test:test@localhost:5432/test
.env
DATABASE_URL_WITH_SCHEMA=${DATABASE_URL}?schema=foo

这将使值为 postgresql://test:test@localhost:5432/test?schema=foo 的环境变量 DATABASE_URL_WITH_SCHEMA 可用于 Prisma ORM。

示例:在 .env 文件中设置 DATABASE_URL 环境变量

通常从环境变量加载数据库连接 URL

// schema.prisma
datasource db {
provider = "postgresql"
url = env("DATABASE_URL")
}

您可以在 .env 文件中设置 DATABASE_URL

.env
DATABASE_URL=postgresql://test:test@localhost:5432/test?schema=public

当您运行需要访问通过 datasource 块定义的数据库的命令(例如,prisma db pull)时,Prisma CLI 会自动从 .env 文件加载 DATABASE_URL 环境变量并使其可用于 CLI。

在代码中使用环境变量

如果希望在运行时评估环境变量,则需要在应用程序代码中手动加载它们(例如,使用 dotenv

import * as dotenv from 'dotenv'

dotenv.config() // Load the environment variables
console.log(`The connection URL is ${process.env.DATABASE_URL}`)

如果您正在为环境变量使用自定义文件名,则可以配置 dotenv 以使用该文件名

import * as dotenv from 'dotenv'

var envFile = path.resolve(join(__dirname, "myenv.env"))
dotenv.config({path: envFile}) // Load the environment variables
console.log(`The connection URL is ${process.env.DATABASE_URL}`)

如果您需要跨环境文件进行变量扩展,则还可以使用 dotenv-expand

import * as dotenv from 'dotenv'
const dotenvExpand = require('dotenv-expand')

var envFile = path.resolve(join(__dirname, "myenv.env"))
var mySqlEnv = dotenv.config({path: envFile})
dotenvExpand.expand(mySqlEnv)