Clickhouse 迁移工具 (chm) - README

概览

Clickhouse 迁移工具 (chm) 是一个命令行界面 (CLI)，旨在帮助管理 Clickhouse 的数据库迁移。它允许用户设置迁移配置、生成新的迁移以及以状态化的方式运行迁移。

安装

要安装 Clickhouse 迁移工具，您需要在您的机器上安装 Rust。如果您还没有安装，可以使用以下命令安装它：

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

然后，您可以使用 cargo 安装 trieve。

cargo install chm

安装工具后，您可以使用 chm 命令运行 CLI。

使用方法

通用结构

chm <command> [subcommand] [flags]

命令和子命令

设置

迁移工具的初始设置。此命令创建一个包含迁移的文件夹和一个包含连接详细信息的 .toml 文件。如果迁移文件夹已存在，将出错。

chm setup --url <CLICKHOUSE_URL> --user <CLICKHOUSE_USER> --password <CLICKHOUSE_PASSWORD> --database <CLICKHOUSE_DB>

• --url (可选): Clickhouse URL。如果没有提供，将查找 CLICKHOUSE_URL 环境变量。
• --user (可选): Clickhouse 用户。如果没有提供，将查找 CLICKHOUSE_USER 环境变量。
• --password (可选): Clickhouse 密码。如果没有提供，将查找 CLICKHOUSE_PASSWORD 环境变量。
• --database (可选): Clickhouse 数据库。如果没有提供，将查找 CLICKHOUSE_DB 环境变量。

迁移

处理迁移操作的命令。

生成

使用指定名称生成新的迁移文件。

chm migration generate <MIGRATION_NAME>

运行

识别并运行挂起的迁移。

chm migration run

重做

撤销最新的迁移并再次应用它。

chm migration redo

撤销

撤销最后的迁移。

chm migration revert

示例

1. 设置迁移工具

   chm setup --url https://127.0.0.1:8123 --user default --password password --database my_database
   

2. 生成新的迁移

   chm migration generate create_users_table
   

3. 运行挂起的迁移

   chm migration run
   

4. 重做最新的迁移

   chm migration redo
   

5. 撤销最后的迁移

   chm migration revert
   

贡献

欢迎贡献！请fork仓库并提交包含您更改的pull request。

许可证

本项目采用 MIT 许可证。有关详细信息，请参阅 LICENSE 文件。

联系

对于任何问题或问题，请在该GitHub仓库中打开问题或联系维护者。

本README文件提供了Clickhouse迁移工具的基本概述及其功能。有关详细使用方法和示例，请运行chm <命令> --help查看特定命令的帮助信息。