现代平台提供了优秀的图形化界面(UI),以帮助开发者快速上手,PlanetScale 亦不例外。然而,一个强大的命令行界面(CLI)可以让开发者以更高效的方式使用平台,例如加速执行任务或利用脚本和 DevOps 工具实现自动化工作。
本文将带你快速了解如何开始使用 PlanetScale CLI,并完成一些常见任务,例如:

  • 查看数据库
  • 创建数据库
  • 执行 SQL
  • 部署模式更改

让我们开始吧!


连接到 PlanetScale

在使用 CLI 之前,请确保已按照文档门户上的指南安装 CLI。可以通过在终端中运行以下命令来验证是否成功安装:

pscale --version

此命令会显示你安装的 PlanetScale CLI 版本(本文写作时为 v0.107.0)。
pscale –version 输出示例
接下来连接到 PlanetScale 服务。在终端中运行以下命令,你会收到一个确认码,同时一个浏览器窗口会打开并显示相同的确认码:

pscale login

提示 如果你还没有 PlanetScale 账户,也可以直接通过 CLI 创建一个。
pscale login 示例,显示确认码
浏览器中显示确认码
确认两处代码匹配后,点击浏览器中的 “Confirm code” 按钮。如果操作成功,终端会显示“Successfully logged in”。


操作数据库

以下是操作数据库时常用的一些命令:

列出你的数据库

运行以下命令打印出你的数据库列表:

pscale database list

可以看到,我的账户中创建了一个数据库:
账户数据库列表

创建一个数据库

运行以下命令创建一个数据库,用 <DATABASE_NAME> 替换为你要创建的数据库名称:

pscale database create <DATABASE_NAME>

本文将创建并使用名为 cli-db 的数据库。
pscale database create 示例


MySQL Shell

现在,我们需要进入数据库中的 MySQL shell 来创建一个表。运行以下命令:

pscale shell cli-db

你的终端提示符将更改,表示你已连接到刚刚创建的数据库,并可以在其上下文中运行命令。
pscale shell 输出示例
由于这是一个新数据库,目前还没有任何表。运行以下命令创建一个表,这个表的结构与 Beam 博客平台中的 Post 模型一致:

CREATE TABLE `Post` (
  `id` int NOT NULL AUTO_INCREMENT,
  `title` varchar(255) NOT NULL,
  `content` text NOT NULL,
  `contentHtml` text NOT NULL,
  `hidden` tinyint(1) NOT NULL DEFAULT '0',
  `createdAt` datetime(3) NOT NULL DEFAULT CURRENT_TIMESTAMP(3),
  `updatedAt` datetime(3) NOT NULL,
  `authorId` varchar(191) NOT NULL,
  PRIMARY KEY (`id`),
  KEY `Post_authorId_idx` (`authorId`),
  FULLTEXT KEY `Post_title_content_idx` (`title`,`content`)
);

查看表

运行上述命令后不会有输出。可以通过以下命令检查表是否已创建:

SHOW TABLES;

Post 表创建后的输出示例


操作分支

除了管理数据库和表,你还可以使用 PlanetScale CLI 管理分支。

列出所有分支

运行以下命令,列出我们刚刚创建的数据库中的现有分支:

pscale branch list cli-db

cli-db 数据库中分支列表

晋升分支为生产环境分支

当前只有一个名为 main 的分支,但它尚未被标记为生产分支。运行以下命令将其晋升为生产分支:

pscale branch promote cli-db main

晋升主分支为生产分支的输出


创建新分支

main 分支标记为生产后,运行以下命令创建一个新分支 dev

pscale branch create cli-db dev

CLI 会显示成功创建分支的消息。
在 cli-db 中创建 dev 分支的输出
你还可以通过仪表板验证分支是否存在。
仪表板中显示 dev 分支的示例


修改分支模式并合并更改

连接到 CLI 提供的 MySQL shell 中:

pscale shell cli-db

如果有多个分支,CLI 会提示你选择进入哪个分支。选择 dev 分支然后按回车。
进入 dev 分支的 MySQL shell 示例
dev 分支模式中添加一个名为 tag 的新列:

ALTER TABLE Post ADD tag varchar(255);

使用 DESCRIBE 命令查看表结构:

DESCRIBE Post;

dev 分支中添加新列后的 Post 表结构示例


创建部署请求并合并更改

运行以下命令在 dev 分支创建一个部署请求,以将更改合并到生产 main 分支:

pscale deploy-request create cli-db dev

创建 dev 分支部署请求的输出示例
运行以下命令列出当前所有活动的部署请求:

pscale deploy-request list cli-db

cli-db 的部署请求列表示例
完成后,运行以下命令将部署请求合并到主分支(假设部署请求编号为 1):

pscale deploy-request deploy cli-db 1

成功合并部署请求的输出示例
进入 MySQL shell,选择 main 分支并验证 Post 表的更改是否已生效:

DESCRIBE Post;

合并部署请求后主分支中 Post 表的模式示例


更多资源

要了解更多关于 PlanetScale CLI 的内容,你可以访问 CLI 参考页面。此外,还可以通过终端运行以下命令查看所有可用命令和使用说明:

pscale --help


PlanetScale CLI 入门指南插图

关注公众号:程序新视界,一个让你软实力、硬技术同步提升的平台

除非注明,否则均为程序新视界原创文章,转载必须以链接形式标明本文链接

本文链接:http://www.choupangxia.com/2025/09/07/getting-start-with-planetscale-cli/