コマンド
このドキュメントでは、Prisma Data Platformに統合されたPrisma CLIのコマンド、引数、およびオプションについて説明します。
始める
始めるには、Prisma CLIがバージョン5.10.0
以降に更新されていることを確認してください。これは、Prisma CLIを介してPlatformにアクセスするために必要です。
💡 コマンドを使用する際は、常にprisma platform
から始め、--early-access
フラグを含めて、早期アクセス中のPrisma Data Platformの使用を有効にしてください。
認証
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 | 文字列 | はい | ワークスペースID。 ヒント: workspace show コマンドでワークスペースIDを表示できます。 |
project create
指定されたワークスペース内に新しいプロジェクトを作成します。
npx prisma platform project create \
--workspace $INSERT_WORKSPACE_ID \
--name "INSERT_PROJECT_NAME" \
--early-access
引数
引数 | 型 | 必須 | 説明 |
---|---|---|---|
--workspace -w | 文字列 | はい | ワークスペースid 。ヒント: workspace show コマンドでワークスペースIDを表示できます。 |
--name -n | 文字列 | いいえ | プロジェクトの表示名。 省略した場合、デフォルトのプロジェクト名が自動生成されます。 |
project delete
指定されたプロジェクトを削除します。
npx prisma platform project delete \
--project $INSERT_PROJECT_ID \
--early-access
引数
引数 | 型 | 必須 | 説明 |
---|---|---|---|
--project -p | 文字列 | はい | プロジェクトid 。ヒント: project show コマンドでプロジェクトIDを表示できます。 |
環境管理
platform
environment show
指定されたプロジェクト内のすべての環境を一覧表示します。
npx prisma platform environment show \
--project $INSERT_PROJECT_ID \
--early-access
引数
引数 | 型 | 必須 | 説明 |
---|---|---|---|
--project -p | 文字列 | はい | プロジェクトid 。ヒント: project show コマンドでプロジェクトIDを表示できます。 |
environment create
指定されたプロジェクト内に新しい環境を作成します。
npx prisma platform environment create \
--project $INSERT_PROJECT_ID \
--name $INSERT_ENVIRONMENT_NAME \
--early-access
引数
引数 | 型 | 必須 | 説明 |
---|---|---|---|
--project -p | 文字列 | はい | プロジェクトid 。ヒント: project show コマンドでプロジェクトIDを表示できます。 |
--name -n | 文字列 | いいえ | 環境の表示名。 省略した場合、デフォルトの環境名が自動生成されます。 |
environment delete
指定された環境を削除します。
npx prisma platform environment delete \
--environment $INSERT_ENVIRONMENT_ID \
--early-access
引数
引数 | 型 | 必須 | 説明 |
---|---|---|---|
--environment -e | 文字列 | はい | 環境id 。ヒント: environment show コマンドで環境IDを表示できます。 |
APIキー管理
platform
apikey show
指定された環境のすべてのAPIキーを一覧表示します。
npx prisma platform apikey show \
--environment $INSERT_ENVIRONMENT_ID \
--early-access
引数
引数 | 型 | 必須 | 説明 |
---|---|---|---|
--environment -e | 文字列 | はい | 環境id 。ヒント: environment show コマンドで環境IDを表示できます。 |
apikey create
指定されたプロジェクトに新しいAPIキーを作成します。
npx prisma platform apikey create \
--environment $INSERT_ENVIRONMENT_ID \
--name $INSERT_API_KEY_NAME \
--early-access
引数
引数 | 型 | 必須 | 説明 |
---|---|---|---|
--environment -e | 文字列 | はい | 環境id 。ヒント: environment show コマンドで環境IDを表示できます。 |
--name -n | 文字列 | いいえ | APIキーの表示名。 省略した場合、デフォルトのAPIキー名が自動生成されます。 |
apikey delete
指定されたAPIキーを削除します。
npx prisma platform apikey delete \
--apikey $INSERT_API_KEY_ID \
--early-access
引数
引数 | 型 | 必須 | 説明 |
---|---|---|---|
| 文字列 | はい | APIキーid 。ヒント: apikey show コマンドでAPIキーIDを表示できます。 |
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 | 文字列 | はい | 環境id 。ヒント: environment show コマンドで環境IDを表示できます。 |
| 文字列 | はい | データベース接続文字列。 |
| 文字列 | いいえ | Prisma Accelerateのマネージドコネクションプールがあるリージョン。 利用可能なリージョンの一覧はこちらで確認できます。 ヒント:最適なレイテンシーのために、データベースに最も近いリージョンを選択してください。 |
| ブール値 | いいえ | はいの場合、関連する環境に新しいAPIキーが生成されます。 |
accelerate disable
指定された環境でPrisma Accelerateを無効にします。
npx prisma platform accelerate disable \
--environment $INSERT_ENVIRONMENT_ID \
--early-access
引数
引数 | 型 | 必須 | 説明 |
---|---|---|---|
--environment -e | 文字列 | はい | 環境id 。ヒント: environment show コマンドで環境IDを表示できます。 |
ヘルプ
ご質問がありますか?私たちがお手伝いしますので、お知らせください。Discordでお問い合わせください。