命令

本文档介绍了 Prisma 数据平台的集成 Prisma CLI 命令、参数和选项。

入门

要开始使用，请确保您已将 Prisma CLI 更新到 5.10.0 或更高版本。这对于通过 Prisma CLI 访问平台是必需的。

info

💡 使用命令时，始终以 prisma platform 开头，并包含 --early-access 标志以启用 Prisma 数据平台的使用，虽然它仍处于早期访问阶段。

身份验证

platform

auth login

打开一个浏览器窗口，允许您登录您的 Prisma 数据平台帐户或创建一个新帐户。

npx prisma platform auth login --early-access

auth logout

退出您的 Prisma 数据平台帐户。

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

参数

参数	类型	必需	描述
--apikey	字符串	是	API 密钥 id。 提示：您可以使用 apikey show 命令查看您的 API 密钥 ID。

Prisma 加速

platform

accelerate enable

为指定环境启用 Prisma 加速。

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。
--url	字符串	是	您的数据库连接字符串。
--region	字符串	否	Prisma 加速的托管连接池的区域。 查看可用区域列表 这里。 提示：选择最靠近您数据库的区域以获得最佳延迟。
--apikey	布尔	否	如果是，将为相关联的环境生成一个新的 API 密钥。

accelerate disable

为指定环境禁用 Prisma 加速。

npx prisma platform accelerate disable \
--environment $INSERT_ENVIRONMENT_ID \
--early-access

参数

参数	类型	必需	描述
--environment -e	字符串	是	环境 id。 提示：您可以使用 environment show 命令查看您的环境 ID。

Prisma 脉冲

platform

pulse enable

为指定环境启用 Prisma 脉冲。

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	字符串	是	环境 id。 提示：您可以使用 environment show 命令查看您的环境 ID。
--url	字符串	是	您的数据库连接字符串。
--region	字符串	否	Prisma 脉冲的区域。
--apikey	布尔	否	如果是，将为相关联的环境生成一个新的 API 密钥。

pulse disable

为指定环境禁用 Prisma 脉冲。

npx prisma platform pulse disable \
--environment $INSERT_ENVIRONMENT_ID \
--early-access

参数

参数	类型	必需	描述
--environment -e	字符串	是	环境 id。 提示：您可以使用 environment show 命令查看您的环境 ID。

帮助

有疑问吗？请告知我们，我们很乐意提供帮助。请通过 Discord 与我们联系。