指令

本文檔說明了 Prisma Data Platform 的整合式 Prisma CLI 指令、參數及選項。

快速入門

若要開始使用，請確保您已將 Prisma CLI 更新至 5.10.0 或更高版本。這是透過 Prisma CLI 存取平台的必要條件。

資訊

💡 使用指令時，請務必以 prisma platform 開頭，並加入 --early-access 旗標，以便在早期預覽階段使用 Prisma Data Platform。

身分驗證 (Authentication)

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 受管連線池的區域。 點擊此處查看可用區域列表。 提示：請選擇最「接近」您資料庫的區域，以獲得最佳的延遲表現。
--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。

說明

有問題嗎？讓我們知道，我們隨時準備提供協助。請透過 Discord 與我們聯繫。