PingKai Logo下载
搜索

平凯数据库云服务 CLI 快速入门

平凯数据库云服务提供了一个命令行界面（CLI）ticloud，你可以通过在终端输入几行命令与平凯数据库云服务进行交互。例如，你可以使用 ticloud 轻松完成以下操作：

  • 创建、删除和列出你的 平凯云 Starter 或 Essential 实例。
  • 向你的 平凯云 Starter 或 Essential 实例导入数据。
  • 从你的 平凯云 Starter 或 Essential 实例导出数据。

Note

平凯数据库云服务 CLI 目前处于 beta 阶段。

开始之前

  • 拥有一个平凯数据库云服务账号。如果你还没有账号，请注册免费试用。

安装

对于 macOS 或 Linux，你可以通过以下任意一种方式安装 ticloud：

  • 通过脚本安装（推荐）

    curl https://raw.githubusercontent.com/tidbcloud/tidbcloud-cli/main/install.sh | sh

  • 通过 TiUP 安装

    tiup install cloud

  • 手动安装

    从 releases 页面下载预编译的二进制文件，并将其复制到你希望安装的位置。

  • 在 GitHub Actions 中安装

    如果需要在 GitHub Action 中设置 ticloud，请使用 setup-tidbcloud-cli。

如果你还没有安装 MySQL 命令行客户端，可以通过包管理器进行安装：

  • 基于 Debian 的发行版：

    sudo apt-get install mysql-client

  • 基于 RPM 的发行版：

    sudo yum install mysql

  • macOS：

    brew install mysql-client

快速入门

注意

如果你使用 TiUP，可以使用 tiup cloud 代替 ticloud。

平凯数据库云服务 Starter 是开始使用平凯数据库云服务的最佳方式。本节将介绍如何使用平凯数据库云服务 CLI 创建一个平凯数据库云服务 Starter 实例。

创建用户配置文件或登录平凯数据库云服务

在使用平凯数据库云服务 CLI 创建平凯数据库云服务 Starter 实例之前，你需要先创建用户配置文件或登录平凯数据库云服务。

  • 使用你的 平凯数据库云服务 API key 创建用户配置文件：

    ticloud config create

    Warning

    配置文件名 MUST NOT 包含 .。

  • 通过认证登录平凯数据库云服务：

    ticloud auth login

    登录成功后，OAuth token 会分配给当前配置文件。如果没有配置文件，token 会分配给名为 default 的配置文件。

Note

在上述两种方式中，平凯数据库云服务 API key 的优先级高于 OAuth token。如果两者都存在，将优先使用 API key。

创建 平凯云 Starter 实例

要创建一个 平凯云 Starter 实例，请输入以下命令，然后根据 CLI 提示提供所需信息：

ticloud serverless create

使用平凯数据库云服务 CLI

查看所有可用命令：

ticloud --help

验证你使用的是最新版本：

ticloud version

如果不是最新版本，请更新到最新版：

ticloud update

通过 TiUP 使用平凯数据库云服务 CLI

平凯数据库云服务 CLI 也可以通过 TiUP 使用，组件名称为 cloud。

查看所有可用命令：

tiup cloud --help

使用 tiup cloud <command> 运行命令。例如：

tiup cloud serverless create

通过 TiUP 更新到最新版：

tiup update cloud

后续操作

查阅 CLI 参考 以探索平凯数据库云服务 CLI 的更多功能。

反馈

如果你对平凯数据库云服务 CLI 有任何问题或建议，欢迎创建 issue。同时也欢迎任何贡献。