命令
本文档描述了 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 | string | 是 | 工作区 ID。 提示： 您可以使用 workspace show 命令查看您的工作区 ID。 |
project create
在指定的工作区内创建一个新项目。
npx prisma platform project create \
--workspace $INSERT_WORKSPACE_ID \
--name "INSERT_PROJECT_NAME" \
--early-access
参数
| 参数 | 类型 | 必需 | 描述 |
|---|---|---|---|
--workspace -w | string | 是 | 工作区 id。提示： 您可以使用 workspace show 命令查看您的工作区 ID。 |
--name -n | string | 否 | 项目的显示名称。 如果省略，将为您生成默认项目名称。 |
project delete
删除指定的项目。
npx prisma platform project delete \
--project $INSERT_PROJECT_ID \
--early-access
参数
| 参数 | 类型 | 必需 | 描述 |
|---|---|---|---|
--project -p | string | 是 | 项目 id。提示： 您可以使用 project show 命令查看您的项目 ID。 |
环境管理
platform
environment show
列出指定项目内的所有环境。
npx prisma platform environment show \
--project $INSERT_PROJECT_ID \
--early-access
参数
| 参数 | 类型 | 必需 | 描述 |
|---|---|---|---|
--project -p | string | 是 | 项目 id。提示： 您可以使用 project show 命令查看您的项目 ID。 |
environment create
在指定的项目内创建一个新环境。
npx prisma platform environment create \
--project $INSERT_PROJECT_ID \
--name $INSERT_ENVIRONMENT_NAME \
--early-access
参数
| 参数 | 类型 | 必需 | 描述 |
|---|---|---|---|
--project -p | string | 是 | 项目 id。提示： 您可以使用 project show 命令查看您的项目 ID。 |
--name -n | string | 否 | 环境的显示名称。 如果省略，将为您生成默认环境名称。 |
environment delete
删除指定的环境。
npx prisma platform environment delete \
--environment $INSERT_ENVIRONMENT_ID \
--early-access
参数
| 参数 | 类型 | 必需 | 描述 |
|---|---|---|---|
--environment -e | string | 是 | 环境 id。提示： 您可以使用 environment show 命令查看您的环境 ID。 |
API 密钥管理
platform
apikey show
列出指定环境的所有 API 密钥。
npx prisma platform apikey show \
--environment $INSERT_ENVIRONMENT_ID \
--early-access
参数
| 参数 | 类型 | 必需 | 描述 |
|---|---|---|---|
--environment -e | string | 是 | 环境 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 | string | 是 | 环境 id。提示： 您可以使用 environment show 命令查看您的环境 ID。 |
--name -n | string | 否 | API 密钥的显示名称。 如果省略，将为您生成默认 API 密钥名称。 |
apikey delete
删除指定的 API 密钥。
npx prisma platform apikey delete \
--apikey $INSERT_API_KEY_ID \
--early-access
参数
| 参数 | 类型 | 必需 | 描述 |
|---|---|---|---|
--apikey | string | 是 | 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 | string | 是 | 环境 id。提示： 您可以使用 environment show 命令查看您的环境 ID。 |
--url | string | 是 | 您的数据库连接字符串。 |
--region | string | 否 | Prisma Accelerate 托管连接池的区域。 在此处查看可用区域列表 here。 提示：选择最靠近您数据库的区域以获得最佳延迟。 |
--apikey | boolean | 否 | 如果为“是”，将为关联的环境生成一个新的 API 密钥。 |
accelerate disable
为指定环境禁用 Prisma Accelerate。
npx prisma platform accelerate disable \
--environment $INSERT_ENVIRONMENT_ID \
--early-access
参数
| 参数 | 类型 | 必需 | 描述 |
|---|---|---|---|
--environment -e | string | 是 | 环境 id。提示： 您可以使用 environment show 命令查看您的环境 ID。 |
Prisma Pulse
platform
pulse enable
为指定环境启用 Prisma Pulse。
npx prisma platform pulse enable \
--environment $INSERT_ENVIRONMENT_ID \
--url "postgresql://username:password@host:port/database" \
--region $INSERT_REGION \
--apikey true \
--early-access
参数
| 参数 | 类型 | 必需 | 描述 |
|---|---|---|---|
--environment -e | string | 是 | 环境 id。提示： 您可以使用 environment show 命令查看您的环境 ID。 |
--url | string | 是 | 您的数据库连接字符串。 |
--region | string | 否 | Prisma Pulse 的区域。 |
--apikey | boolean | 否 | 如果为“是”，将为关联的环境生成一个新的 API 密钥。 |
pulse disable
为指定环境禁用 Prisma Pulse。
npx prisma platform pulse disable \
--environment $INSERT_ENVIRONMENT_ID \
--early-access
参数
| 参数 | 类型 | 必需 | 描述 |
|---|---|---|---|
--environment -e | string | 是 | 环境 id。提示： 您可以使用 environment show 命令查看您的环境 ID。 |
帮助
有问题吗？请告诉我们，我们随时为您提供帮助。请在 Discord 上联系我们。