メインコンテンツにスキップ

環境変数リファレンス

このドキュメントでは、さまざまな環境変数とそのユースケースについて説明します。

Prisma Client​

DEBUG​

DEBUG は、Prisma Client でのデバッグ出力を有効にするために使用されます。

Prisma Client レベルのデバッグ出力を設定する例

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

詳細については、デバッグを参照してください。

NO_COLOR​

NO_COLOR が truthy の場合、エラーフォーマットの 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 は、プレビュー機能フラグが削除される可能性があることを示す警告メッセージを非表示にします。truthy な値です。

PRISMA_HIDE_UPDATE_MESSAGE​

PRISMA_HIDE_UPDATE_MESSAGE は、新しい Prisma CLI バージョンが利用可能な場合に表示される更新通知メッセージを非表示にするために使用されます。truthy な値です。

PRISMA_GENERATE_SKIP_AUTOINSTALL​

PRISMA_GENERATE_SKIP_AUTOINSTALL は、prisma generate コマンドを使用する際に、Prisma スキーマで prisma-client-js ジェネレーターが定義されている場合、prisma CLI および @prisma/client 依存関係の自動インストール（それらが欠落している場合）をスキップするために truthy な値を設定できます。

PRISMA_SKIP_POSTINSTALL_GENERATE​

PRISMA_SKIP_POSTINSTALL_GENERATE は、パッケージマネージャーによって postinstall フックがトリガーされたときに Prisma Client の自動生成をスキップするために truthy な値を設定できます。@prisma/client パッケージの postinstall フックは、パッケージがインストールされたとき、またはそのバージョンが更新されたときにトリガーされます。

PRISMA_DISABLE_WARNINGS​

logger.warn によって生成されるすべての CLI 警告を無効にします。

PRISMA_GENERATE_NO_ENGINE​

情報

この環境変数はバージョン 5.2.0 以降で使用可能です。

PRISMA_GENERATE_NO_ENGINE は、Prisma Accelerate と組み合わせることで、デプロイされたアプリケーションのサイズを削減するために、クエリエンジンを含まない Prisma Client を生成するために truthy な値を設定できます。

PRISMA_SCHEMA_DISABLE_ADVISORY_LOCK​

情報

この環境変数はバージョン 5.3.0 以降で使用可能です。

PRISMA_SCHEMA_DISABLE_ADVISORY_LOCK は、Prisma Migrate で使用される アドバイザリロッキング を無効にするために truthy な値を設定できます。これは、Percona-XtraDB-Cluster や MariaDB Galera Cluster など、データベース構成によっては必要になる場合があります。

プロキシ環境変数​

Prisma CLI は、Prisma エンジンをダウンロードするためのカスタム HTTP(S) プロキシをサポートしています。これらは、企業のファイアウォールの背後で作業する場合に役立ちます。詳細については、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 を使用してその場所を定義する必要があります。

これは、Prisma スキーマで同じ設定を定義できるgenerator ブロックの engineType プロパティの環境変数版です。

エンジンのダウンロード​

PRISMA_ENGINES_MIRROR​

PRISMA_ENGINES_MIRROR は、CLI/Client のエンジンファイルをダウンロードするためのカスタム CDN（またはサーバー）エンドポイントを指定するために使用できます。デフォルト値は 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 エンジンの整合性（チェックサムファイル経由）のダウンロードと検証に関する問題を無視するために truthy な値を設定できます。これは、チェックサムファイルをダウンロードできないオフラインシステム環境にデプロイする場合に特に役立ちます。

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 は、スキーマエンジンバイナリのカスタムロケーションを設定するために使用されます。

PRISMA_SCHEMA_ENGINE_BINARY=custom/my-schema-engine-unix

PRISMA_MIGRATION_ENGINE_BINARY​

警告

非推奨: PRISMA_MIGRATION_ENGINE_BINARY 変数は 5.0.0 で非推奨になりました。移行エンジンがスキーマエンジンに名前変更されたためです。

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 がインストール中にダウンロードする 1 つ以上のバイナリターゲットを指定するために使用できます（したがって、Prisma CLI の npm install 中に提供する必要があり、Prisma CLI または Prisma Client のランタイムには影響しません）。

PRISMA_CLI_BINARY_TARGETS は、1) 依存関係を含むローカルプロジェクトのアップロードを介して特定のプラットフォームにデプロイする場合、および 2) ローカル環境がターゲットと異なる場合（例：Node.js 20+ を搭載した AWS Lambda は rhel-openssl-3.0.x であり、ローカル環境は macOS arm64 darwin-arm64 である可能性があります）に使用します。PRISMA_CLI_BINARY_TARGETS 環境変数を使用すると、ターゲットエンジンファイルもダウンロードされることが保証されます。

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

これは、Prisma Client の同じ設定を定義できるgenerator ブロックの binaryTargets プロパティの Prisma CLI 版です。

注: Node.js バージョン 20 より前のバージョンでは、openssl バージョンは 3.0.x ではなく 1.0.x でした。これは、AWS Lambda デプロイメントで最も顕著であり、バイナリターゲットは rhel-openssl-3.0.x ではなく rhel-openssl-1.0.x になります。