コマンド
このドキュメントでは、Prisma Data Platform の統合された Prisma CLI コマンド、引数、およびオプションについて説明します。
はじめに
開始するには、Prisma CLI がバージョン 5.10.0 以降にアップデートされていることを確認してください。これは、Prisma CLI を介してプラットフォームにアクセスするために必要です。
💡 コマンドを使用する際は、常に prisma platform で始め、Prisma Data Platform をアーリーアクセスで使用できるようにするために --early-access フラグを含めてください。
認証
platform
auth login
Prisma Data Platform アカウントにログインするか、新しいアカウントを作成するためのブラウザウィンドウを開きます。現在、GitHub のみがサポートされているログイン方法です。Google およびメール/パスワードでのサインインのサポートを追加する予定です。
npx prisma platform auth login --early-access
auth logout
Prisma Data Platform アカウントからログアウトします。
npx prisma platform auth logout --early-access
auth show
現在認証されているユーザーに関する情報を表示します。
npx prisma platform auth show --early-access
ワークスペース管理
platform
workspace show
アカウントで利用可能なすべてのワークスペースをリスト表示します。
npx prisma platform workspace show --early-access
プロジェクト管理
platform
project show
指定されたワークスペース内のすべてのプロジェクトをリスト表示します。
npx prisma platform project show \
--workspace $INSERT_WORKSPACE_ID \
--early-access
引数
| 引数 | タイプ | 必須 | 説明 |
|---|---|---|---|
--workspace -w | string | はい | ワークスペース ID。 ヒント: ワークスペース ID は workspace show コマンドで確認できます。 |
project create
指定されたワークスペース内に新しいプロジェクトを作成します。
npx prisma platform project create \
--workspace $INSERT_WORKSPACE_ID \
--name "INSERT_PROJECT_NAME" \
--early-access
引数
| 引数 | タイプ | 必須 | 説明 |
|---|---|---|---|
--workspace -w | string | はい | ワークスペースの id。ヒント: ワークスペース ID は workspace show コマンドで確認できます。 |
--name -n | string | いいえ | プロジェクトの表示名。 省略した場合、デフォルトのプロジェクト名が自動生成されます。 |
project delete
指定されたプロジェクトを削除します。
npx prisma platform project delete \
--project $INSERT_PROJECT_ID \
--early-access
引数
| 引数 | タイプ | 必須 | 説明 |
|---|---|---|---|
--project -p | string | はい | プロジェクトの id。ヒント: プロジェクト ID は project show コマンドで確認できます。 |
環境管理
platform
environment show
指定されたプロジェクト内のすべての環境をリスト表示します。
npx prisma platform environment show \
--project $INSERT_PROJECT_ID \
--early-access
引数
| 引数 | タイプ | 必須 | 説明 |
|---|---|---|---|
--project -p | string | はい | プロジェクトの id。ヒント: プロジェクト ID は project show コマンドで確認できます。 |
environment create
指定されたプロジェクト内に新しい環境を作成します。
npx prisma platform environment create \
--project $INSERT_PROJECT_ID \
--name $INSERT_ENVIRONMENT_NAME \
--early-access
引数
| 引数 | タイプ | 必須 | 説明 |
|---|---|---|---|
--project -p | string | はい | プロジェクトの id。ヒント: プロジェクト ID は project show コマンドで確認できます。 |
--name -n | string | いいえ | 環境の表示名。 省略した場合、デフォルトの環境名が自動生成されます。 |
environment delete
指定された環境を削除します。
npx prisma platform environment delete \
--environment $INSERT_ENVIRONMENT_ID \
--early-access
引数
| 引数 | タイプ | 必須 | 説明 |
|---|---|---|---|
--environment -e | string | はい | 環境の id。ヒント: 環境 ID は environment show コマンドで確認できます。 |
API キー管理
platform
apikey show
指定された環境のすべての API キーをリスト表示します。
npx prisma platform apikey show \
--environment $INSERT_ENVIRONMENT_ID \
--early-access
引数
| 引数 | タイプ | 必須 | 説明 |
|---|---|---|---|
--environment -e | string | はい | 環境の id。ヒント: 環境 ID は environment show コマンドで確認できます。 |
apikey create
指定されたプロジェクトの新しい API キーを作成します。
npx prisma platform apikey create \
--environment $INSERT_ENVIRONMENT_ID \
--name $INSERT_API_KEY_NAME \
--early-access
引数
| 引数 | タイプ | 必須 | 説明 |
|---|---|---|---|
--environment -e | string | はい | 環境の id。ヒント: 環境 ID は environment show コマンドで確認できます。 |
--name -n | string | いいえ | API キーの表示名。 省略した場合、デフォルトの API キー名が自動生成されます。 |
apikey delete
指定された API キーを削除します。
npx prisma platform apikey delete \
--apikey $INSERT_API_KEY_ID \
--early-access
引数
| 引数 | タイプ | 必須 | 説明 |
|---|---|---|---|
--apikey | string | はい | API キーの id。ヒント: API キー ID は apikey show コマンドで確認できます。 |
Prisma Accelerate
platform
accelerate enable
指定された環境に対して Prisma Accelerate を有効にします。
npx prisma platform accelerate enable \
--environment $INSERT_ENVIRONMENT_ID \
--url "postgresql://username:password@host:port/database" \
--region $INSERT_CONNECTION_POOL_REGION \
--apikey true \
--early-access
引数
| 引数 | タイプ | 必須 | 説明 |
|---|---|---|---|
--environment -e | string | はい | 環境の id。ヒント: 環境 ID は environment show コマンドで確認できます。 |
--url | string | はい | データベース接続文字列。 |
--region | string | いいえ | Prisma Accelerate のマネージド接続プールのリージョン。 利用可能なリージョンの一覧はこちらをご覧ください。 ヒント: 最適なレイテンシを得るためには、データベースに最も近いリージョンを選択してください。 |
--apikey | boolean | いいえ | 「はい」の場合、関連付けられた環境に新しい API キーが生成されます。 |
accelerate disable
指定された環境に対して Prisma Accelerate を無効にします。
npx prisma platform accelerate disable \
--environment $INSERT_ENVIRONMENT_ID \
--early-access
引数
| 引数 | タイプ | 必須 | 説明 |
|---|---|---|---|
--environment -e | string | はい | 環境の id。ヒント: 環境 ID は environment show コマンドで確認できます。 |
ヘルプ
ご不明な点はお気軽にお問い合わせください。喜んでお手伝いさせていただきます。Discordまでご連絡ください。