命令
本文檔介紹了 Prisma Data Platform 的整合 Prisma CLI 命令、參數和選項。
開始使用
若要開始使用，請確保您的 Prisma CLI 已更新至 5.10.0 或更新版本。這是透過 Prisma CLI 存取平台的必要條件。
資訊
💡 使用命令時，請務必以 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
參數
| 參數 | 類型 | 必填 | 描述 |
|---|---|---|---|
--apikey | 字串 | 是 | 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。 |
--url | 字串 | 是 | 您的資料庫連線字串。 |
--region | 字串 | 否 | Prisma Accelerate 受管連線集區的區域。 在此處檢視可用區域的清單 here。 提示：選取最靠近您資料庫的區域，以獲得最佳延遲。 |
--apikey | 布林值 | 否 | 若為是，將為關聯的環境產生新的 API 金鑰。 |
accelerate disable
為指定的環境停用 Prisma Accelerate。
npx prisma platform accelerate disable \
--environment $INSERT_ENVIRONMENT_ID \
--early-access
參數
| 參數 | 類型 | 必填 | 描述 |
|---|---|---|---|
--environment -e | 字串 | 是 | 環境 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 | 字串 | 是 | 環境 id。提示： 您可以使用 environment show 命令檢視您的環境 ID。 |
--url | 字串 | 是 | 您的資料庫連線字串。 |
--region | 字串 | 否 | Prisma Pulse 的區域。 |
--apikey | 布林值 | 否 | 若為是，將為關聯的環境產生新的 API 金鑰。 |
pulse disable
為指定的環境停用 Prisma Pulse。
npx prisma platform pulse disable \
--environment $INSERT_ENVIRONMENT_ID \
--early-access
參數
| 參數 | 類型 | 必填 | 描述 |
|---|---|---|---|
--environment -e | 字串 | 是 | 環境 id。提示： 您可以使用 environment show 命令檢視您的環境 ID。 |
協助
有問題嗎？請告訴我們，我們隨時提供協助。透過 Discord 與我們聯絡。