planetscale/pscale

镜像概述

该镜像包含PlanetScale Database的官方命令行工具（CLI），提供命令行界面用于管理PlanetScale数据库服务，支持数据库实例创建、分支操作、安全连接、数据管理等核心功能，适用于开发、运维及自动化场景。

核心功能和特性

• 数据库实例管理：创建、删除、暂停、恢复数据库实例，查看实例状态及配置。
• 分支操作：管理数据库分支（如创建、合并、删除分支），支持无停机.schema变更。
• 安全连接：通过加密连接字符串或代理方式安全连接数据库分支，支持本地开发调试。
• 数据操作：执行SQL查询、导入/导出数据，管理数据库用户及权限。
• 集成能力：支持与CI/CD流程集成，通过环境变量配置实现自动化部署与数据库管理。

使用场景和适用范围

• 开发者本地开发：在本地环境通过CLI连接远程PlanetScale数据库分支，执行开发调试。
• 自动化部署流程：在CI/CD管道中集成CLI，实现数据库分支创建、 schema 变更等自动化操作。
• 多环境数据库管理：统一管理开发、测试、生产环境的数据库实例及分支，确保环境一致性。
• 数据库迁移与备份：通过CLI工具执行数据导出、导入，实现数据库迁移或定期备份。

使用方法和配置说明

基本使用

通过docker run命令直接运行CLI命令，基本格式如下：

bash
docker run --rm planetscale/cli:latest [pscale命令] [参数]

示例：获取CLI版本信息

bash
docker run --rm planetscale/cli:latest version

环境变量配置

使用环境变量配置认证信息及默认参数，避免重复输入：

示例：使用环境变量执行数据库列表查询

bash
docker run --rm \
  -e PLANETSCALE_TOKEN="pscale_pat_xxx" \
  -e PLANETSCALE_ORG="my-org" \
  planetscale/cli:latest database list

常用命令示例

1. 创建数据库实例

bash
docker run --rm \
  -e PLANETSCALE_TOKEN="pscale_pat_xxx" \
  -e PLANETSCALE_ORG="my-org" \
  planetscale/cli:latest database create my-db --region us-east

2. 连接数据库分支

bash
docker run --rm -it \
  -e PLANETSCALE_TOKEN="pscale_pat_xxx" \
  -e PLANETSCALE_ORG="my-org" \
  planetscale/cli:latest connect my-db main --port 3306

（-it参数用于交互式连接，连接后可通过本地3306端口访问数据库）

3. 导出数据库数据

bash
docker run --rm -v $(pwd):/data \
  -e PLANETSCALE_TOKEN="pscale_pat_xxx" \
  -e PLANETSCALE_ORG="my-org" \
  planetscale/cli:latest database export my-db main --output /data/export.sql

（-v参数挂载本地目录，将导出文件保存至宿主机器）

注意事项

• 持久化配置：若需保存认证状态或常用配置，可挂载主机目录至容器/root/.config/planetscale路径，避免重复输入组织、区域等信息。
• 权限控制：API令牌需具备对应操作权限（如database:create、branch:connect），建议遵循最小权限原则创建令牌。
• 交互式操作：涉及输入（如登录命令pscale auth login）或持续连接（如pscale connect）时，需添加-it参数确保交互正常。